1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Copyright IBM Corp. 2002, 2009
4 *
5 * Author(s): Arnd Bergmann <arndb@de.ibm.com>
6 *
7 * Interface for CCW device drivers
8 */
9 #ifndef _S390_CCWDEV_H_
10 #define _S390_CCWDEV_H_
11
12 #include <linux/device.h>
13 #include <linux/mod_devicetable.h>
14 #include <asm/chsc.h>
15 #include <asm/fcx.h>
16 #include <asm/irq.h>
17 #include <asm/schid.h>
18
19 /* structs from asm/cio.h */
20 struct irb;
21 struct ccw1;
22 struct ccw_dev_id;
23
24 /* simplified initializers for struct ccw_device:
25 * CCW_DEVICE and CCW_DEVICE_DEVTYPE initialize one
26 * entry in your MODULE_DEVICE_TABLE and set the match_flag correctly */
27 #define CCW_DEVICE(cu, cum) \
28 .cu_type=(cu), .cu_model=(cum), \
29 .match_flags=(CCW_DEVICE_ID_MATCH_CU_TYPE \
30 | (cum ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0))
31
32 #define CCW_DEVICE_DEVTYPE(cu, cum, dev, devm) \
33 .cu_type=(cu), .cu_model=(cum), .dev_type=(dev), .dev_model=(devm),\
34 .match_flags=CCW_DEVICE_ID_MATCH_CU_TYPE \
35 | ((cum) ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0) \
36 | CCW_DEVICE_ID_MATCH_DEVICE_TYPE \
37 | ((devm) ? CCW_DEVICE_ID_MATCH_DEVICE_MODEL : 0)
38
39 /* scan through an array of device ids and return the first
40 * entry that matches the device.
41 *
42 * the array must end with an entry containing zero match_flags
43 */
44 static inline const struct ccw_device_id *
ccw_device_id_match(const struct ccw_device_id * array,const struct ccw_device_id * match)45 ccw_device_id_match(const struct ccw_device_id *array,
46 const struct ccw_device_id *match)
47 {
48 const struct ccw_device_id *id = array;
49
50 for (id = array; id->match_flags; id++) {
51 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_TYPE)
52 && (id->cu_type != match->cu_type))
53 continue;
54
55 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_MODEL)
56 && (id->cu_model != match->cu_model))
57 continue;
58
59 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_TYPE)
60 && (id->dev_type != match->dev_type))
61 continue;
62
63 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_MODEL)
64 && (id->dev_model != match->dev_model))
65 continue;
66
67 return id;
68 }
69
70 return NULL;
71 }
72
73 /**
74 * struct ccw_device - channel attached device
75 * @ccwlock: pointer to device lock
76 * @id: id of this device
77 * @drv: ccw driver for this device
78 * @dev: embedded device structure
79 * @online: online status of device
80 * @handler: interrupt handler
81 *
82 * @handler is a member of the device rather than the driver since a driver
83 * can have different interrupt handlers for different ccw devices
84 * (multi-subchannel drivers).
85 */
86 struct ccw_device {
87 spinlock_t *ccwlock;
88 /* private: */
89 struct ccw_device_private *private; /* cio private information */
90 /* public: */
91 struct ccw_device_id id;
92 struct ccw_driver *drv;
93 struct device dev;
94 int online;
95 void (*handler) (struct ccw_device *, unsigned long, struct irb *);
96 };
97
98 /*
99 * Possible events used by the path_event notifier.
100 */
101 #define PE_NONE 0x0
102 #define PE_PATH_GONE 0x1 /* A path is no longer available. */
103 #define PE_PATH_AVAILABLE 0x2 /* A path has become available and
104 was successfully verified. */
105 #define PE_PATHGROUP_ESTABLISHED 0x4 /* A pathgroup was reset and had
106 to be established again. */
107
108 /*
109 * Possible CIO actions triggered by the unit check handler.
110 */
111 enum uc_todo {
112 UC_TODO_RETRY,
113 UC_TODO_RETRY_ON_NEW_PATH,
114 UC_TODO_STOP
115 };
116
117 /**
118 * struct ccw driver - device driver for channel attached devices
119 * @ids: ids supported by this driver
120 * @probe: function called on probe
121 * @remove: function called on remove
122 * @set_online: called when setting device online
123 * @set_offline: called when setting device offline
124 * @notify: notify driver of device state changes
125 * @path_event: notify driver of channel path events
126 * @shutdown: called at device shutdown
127 * @prepare: prepare for pm state transition
128 * @complete: undo work done in @prepare
129 * @freeze: callback for freezing during hibernation snapshotting
130 * @thaw: undo work done in @freeze
131 * @restore: callback for restoring after hibernation
132 * @uc_handler: callback for unit check handler
133 * @driver: embedded device driver structure
134 * @int_class: interruption class to use for accounting interrupts
135 */
136 struct ccw_driver {
137 struct ccw_device_id *ids;
138 int (*probe) (struct ccw_device *);
139 void (*remove) (struct ccw_device *);
140 int (*set_online) (struct ccw_device *);
141 int (*set_offline) (struct ccw_device *);
142 int (*notify) (struct ccw_device *, int);
143 void (*path_event) (struct ccw_device *, int *);
144 void (*shutdown) (struct ccw_device *);
145 int (*prepare) (struct ccw_device *);
146 void (*complete) (struct ccw_device *);
147 int (*freeze)(struct ccw_device *);
148 int (*thaw) (struct ccw_device *);
149 int (*restore)(struct ccw_device *);
150 enum uc_todo (*uc_handler) (struct ccw_device *, struct irb *);
151 struct device_driver driver;
152 enum interruption_class int_class;
153 };
154
155 extern struct ccw_device *get_ccwdev_by_busid(struct ccw_driver *cdrv,
156 const char *bus_id);
157
158 /* devices drivers call these during module load and unload.
159 * When a driver is registered, its probe method is called
160 * when new devices for its type pop up */
161 extern int ccw_driver_register (struct ccw_driver *driver);
162 extern void ccw_driver_unregister (struct ccw_driver *driver);
163
164 struct ccw1;
165
166 extern int ccw_device_set_options_mask(struct ccw_device *, unsigned long);
167 extern int ccw_device_set_options(struct ccw_device *, unsigned long);
168 extern void ccw_device_clear_options(struct ccw_device *, unsigned long);
169 int ccw_device_is_pathgroup(struct ccw_device *cdev);
170 int ccw_device_is_multipath(struct ccw_device *cdev);
171
172 /* Allow for i/o completion notification after primary interrupt status. */
173 #define CCWDEV_EARLY_NOTIFICATION 0x0001
174 /* Report all interrupt conditions. */
175 #define CCWDEV_REPORT_ALL 0x0002
176 /* Try to perform path grouping. */
177 #define CCWDEV_DO_PATHGROUP 0x0004
178 /* Allow forced onlining of boxed devices. */
179 #define CCWDEV_ALLOW_FORCE 0x0008
180 /* Try to use multipath mode. */
181 #define CCWDEV_DO_MULTIPATH 0x0010
182
183 extern int ccw_device_start(struct ccw_device *, struct ccw1 *,
184 unsigned long, __u8, unsigned long);
185 extern int ccw_device_start_timeout(struct ccw_device *, struct ccw1 *,
186 unsigned long, __u8, unsigned long, int);
187 extern int ccw_device_start_key(struct ccw_device *, struct ccw1 *,
188 unsigned long, __u8, __u8, unsigned long);
189 extern int ccw_device_start_timeout_key(struct ccw_device *, struct ccw1 *,
190 unsigned long, __u8, __u8,
191 unsigned long, int);
192
193
194 extern int ccw_device_resume(struct ccw_device *);
195 extern int ccw_device_halt(struct ccw_device *, unsigned long);
196 extern int ccw_device_clear(struct ccw_device *, unsigned long);
197 int ccw_device_tm_start_key(struct ccw_device *cdev, struct tcw *tcw,
198 unsigned long intparm, u8 lpm, u8 key);
199 int ccw_device_tm_start_key(struct ccw_device *, struct tcw *,
200 unsigned long, u8, u8);
201 int ccw_device_tm_start_timeout_key(struct ccw_device *, struct tcw *,
202 unsigned long, u8, u8, int);
203 int ccw_device_tm_start(struct ccw_device *, struct tcw *,
204 unsigned long, u8);
205 int ccw_device_tm_start_timeout(struct ccw_device *, struct tcw *,
206 unsigned long, u8, int);
207 int ccw_device_tm_intrg(struct ccw_device *cdev);
208
209 int ccw_device_get_mdc(struct ccw_device *cdev, u8 mask);
210
211 extern int ccw_device_set_online(struct ccw_device *cdev);
212 extern int ccw_device_set_offline(struct ccw_device *cdev);
213
214
215 extern struct ciw *ccw_device_get_ciw(struct ccw_device *, __u32 cmd);
216 extern __u8 ccw_device_get_path_mask(struct ccw_device *);
217 extern void ccw_device_get_id(struct ccw_device *, struct ccw_dev_id *);
218
219 #define get_ccwdev_lock(x) (x)->ccwlock
220
221 #define to_ccwdev(n) container_of(n, struct ccw_device, dev)
222 #define to_ccwdrv(n) container_of(n, struct ccw_driver, driver)
223
224 extern struct ccw_device *ccw_device_create_console(struct ccw_driver *);
225 extern void ccw_device_destroy_console(struct ccw_device *);
226 extern int ccw_device_enable_console(struct ccw_device *);
227 extern void ccw_device_wait_idle(struct ccw_device *);
228 extern int ccw_device_force_console(struct ccw_device *);
229
230 extern void *ccw_device_dma_zalloc(struct ccw_device *cdev, size_t size);
231 extern void ccw_device_dma_free(struct ccw_device *cdev,
232 void *cpu_addr, size_t size);
233
234 int ccw_device_siosl(struct ccw_device *);
235
236 extern void ccw_device_get_schid(struct ccw_device *, struct subchannel_id *);
237
238 struct channel_path_desc_fmt0 *ccw_device_get_chp_desc(struct ccw_device *, int);
239 u8 *ccw_device_get_util_str(struct ccw_device *cdev, int chp_idx);
240 int ccw_device_pnso(struct ccw_device *cdev,
241 struct chsc_pnso_area *pnso_area, u8 oc,
242 struct chsc_pnso_resume_token resume_token, int cnc);
243 int ccw_device_get_cssid(struct ccw_device *cdev, u8 *cssid);
244 int ccw_device_get_iid(struct ccw_device *cdev, u8 *iid);
245 int ccw_device_get_chpid(struct ccw_device *cdev, int chp_idx, u8 *chpid);
246 int ccw_device_get_chid(struct ccw_device *cdev, int chp_idx, u16 *chid);
247 #endif /* _S390_CCWDEV_H_ */
248
