xref: /openbmc/linux/drivers/s390/cio/css.h (revision 545e4006)
1 #ifndef _CSS_H
2 #define _CSS_H
3 
4 #include <linux/mutex.h>
5 #include <linux/wait.h>
6 #include <linux/workqueue.h>
7 #include <linux/device.h>
8 #include <linux/types.h>
9 
10 #include <asm/cio.h>
11 #include <asm/chpid.h>
12 #include <asm/schid.h>
13 
14 /*
15  * path grouping stuff
16  */
17 #define SPID_FUNC_SINGLE_PATH	   0x00
18 #define SPID_FUNC_MULTI_PATH	   0x80
19 #define SPID_FUNC_ESTABLISH	   0x00
20 #define SPID_FUNC_RESIGN	   0x40
21 #define SPID_FUNC_DISBAND	   0x20
22 
23 #define SNID_STATE1_RESET	   0
24 #define SNID_STATE1_UNGROUPED	   2
25 #define SNID_STATE1_GROUPED	   3
26 
27 #define SNID_STATE2_NOT_RESVD	   0
28 #define SNID_STATE2_RESVD_ELSE	   2
29 #define SNID_STATE2_RESVD_SELF	   3
30 
31 #define SNID_STATE3_MULTI_PATH	   1
32 #define SNID_STATE3_SINGLE_PATH	   0
33 
34 struct path_state {
35 	__u8  state1 : 2;	/* path state value 1 */
36 	__u8  state2 : 2;	/* path state value 2 */
37 	__u8  state3 : 1;	/* path state value 3 */
38 	__u8  resvd  : 3;	/* reserved */
39 } __attribute__ ((packed));
40 
41 struct extended_cssid {
42 	u8 version;
43 	u8 cssid;
44 } __attribute__ ((packed));
45 
46 struct pgid {
47 	union {
48 		__u8 fc;   	/* SPID function code */
49 		struct path_state ps;	/* SNID path state */
50 	} __attribute__ ((packed)) inf;
51 	union {
52 		__u32 cpu_addr	: 16;	/* CPU address */
53 		struct extended_cssid ext_cssid;
54 	} __attribute__ ((packed)) pgid_high;
55 	__u32 cpu_id	: 24;	/* CPU identification */
56 	__u32 cpu_model : 16;	/* CPU model */
57 	__u32 tod_high;		/* high word TOD clock */
58 } __attribute__ ((packed));
59 
60 struct subchannel;
61 struct chp_link;
62 /**
63  * struct css_driver - device driver for subchannels
64  * @owner: owning module
65  * @subchannel_type: subchannel type supported by this driver
66  * @drv: embedded device driver structure
67  * @irq: called on interrupts
68  * @chp_event: called for events affecting a channel path
69  * @sch_event: called for events affecting the subchannel
70  * @probe: function called on probe
71  * @remove: function called on remove
72  * @shutdown: called at device shutdown
73  * @name: name of the device driver
74  */
75 struct css_driver {
76 	struct module *owner;
77 	struct css_device_id *subchannel_type;
78 	struct device_driver drv;
79 	void (*irq)(struct subchannel *);
80 	int (*chp_event)(struct subchannel *, struct chp_link *, int);
81 	int (*sch_event)(struct subchannel *, int);
82 	int (*probe)(struct subchannel *);
83 	int (*remove)(struct subchannel *);
84 	void (*shutdown)(struct subchannel *);
85 	const char *name;
86 };
87 
88 #define to_cssdriver(n) container_of(n, struct css_driver, drv)
89 
90 /*
91  * all css_drivers have the css_bus_type
92  */
93 extern struct bus_type css_bus_type;
94 
95 extern int css_driver_register(struct css_driver *);
96 extern void css_driver_unregister(struct css_driver *);
97 
98 extern void css_sch_device_unregister(struct subchannel *);
99 extern int css_probe_device(struct subchannel_id);
100 extern struct subchannel *get_subchannel_by_schid(struct subchannel_id);
101 extern int css_init_done;
102 int for_each_subchannel_staged(int (*fn_known)(struct subchannel *, void *),
103 			       int (*fn_unknown)(struct subchannel_id,
104 			       void *), void *data);
105 extern int for_each_subchannel(int(*fn)(struct subchannel_id, void *), void *);
106 extern void css_reiterate_subchannels(void);
107 void css_update_ssd_info(struct subchannel *sch);
108 
109 #define __MAX_SUBCHANNEL 65535
110 #define __MAX_SSID 3
111 
112 struct channel_subsystem {
113 	u8 cssid;
114 	int valid;
115 	struct channel_path *chps[__MAX_CHPID + 1];
116 	struct device device;
117 	struct pgid global_pgid;
118 	struct mutex mutex;
119 	/* channel measurement related */
120 	int cm_enabled;
121 	void *cub_addr1;
122 	void *cub_addr2;
123 	/* for orphaned ccw devices */
124 	struct subchannel *pseudo_subchannel;
125 };
126 #define to_css(dev) container_of(dev, struct channel_subsystem, device)
127 
128 extern struct bus_type css_bus_type;
129 extern struct channel_subsystem *channel_subsystems[];
130 
131 /* Helper functions to build lists for the slow path. */
132 void css_schedule_eval(struct subchannel_id schid);
133 void css_schedule_eval_all(void);
134 
135 int sch_is_pseudo_sch(struct subchannel *);
136 struct schib;
137 int css_sch_is_valid(struct schib *);
138 
139 extern struct workqueue_struct *slow_path_wq;
140 void css_wait_for_slow_path(void);
141 #endif
142