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