2 * Copyright IBM Corp. 2002, 2009
4 * Author(s): Arnd Bergmann <arndb@de.ibm.com>
6 * Interface for CCW device drivers
8 #ifndef _S390_CCWDEV_H_
9 #define _S390_CCWDEV_H_
11 #include <linux/device.h>
12 #include <linux/mod_devicetable.h>
15 /* structs from asm/cio.h */
20 /* simplified initializers for struct ccw_device:
21 * CCW_DEVICE and CCW_DEVICE_DEVTYPE initialize one
22 * entry in your MODULE_DEVICE_TABLE and set the match_flag correctly */
23 #define CCW_DEVICE(cu, cum) \
24 .cu_type=(cu), .cu_model=(cum), \
25 .match_flags=(CCW_DEVICE_ID_MATCH_CU_TYPE \
26 | (cum ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0))
28 #define CCW_DEVICE_DEVTYPE(cu, cum, dev, devm) \
29 .cu_type=(cu), .cu_model=(cum), .dev_type=(dev), .dev_model=(devm),\
30 .match_flags=CCW_DEVICE_ID_MATCH_CU_TYPE \
31 | ((cum) ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0) \
32 | CCW_DEVICE_ID_MATCH_DEVICE_TYPE \
33 | ((devm) ? CCW_DEVICE_ID_MATCH_DEVICE_MODEL : 0)
35 /* scan through an array of device ids and return the first
36 * entry that matches the device.
38 * the array must end with an entry containing zero match_flags
40 static inline const struct ccw_device_id *
41 ccw_device_id_match(const struct ccw_device_id *array,
42 const struct ccw_device_id *match)
44 const struct ccw_device_id *id = array;
46 for (id = array; id->match_flags; id++) {
47 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_TYPE)
48 && (id->cu_type != match->cu_type))
51 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_MODEL)
52 && (id->cu_model != match->cu_model))
55 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_TYPE)
56 && (id->dev_type != match->dev_type))
59 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_MODEL)
60 && (id->dev_model != match->dev_model))
70 * struct ccw_device - channel attached device
71 * @ccwlock: pointer to device lock
72 * @id: id of this device
73 * @drv: ccw driver for this device
74 * @dev: embedded device structure
75 * @online: online status of device
76 * @handler: interrupt handler
78 * @handler is a member of the device rather than the driver since a driver
79 * can have different interrupt handlers for different ccw devices
80 * (multi-subchannel drivers).
85 struct ccw_device_private *private; /* cio private information */
87 struct ccw_device_id id;
88 struct ccw_driver *drv;
91 void (*handler) (struct ccw_device *, unsigned long, struct irb *);
95 * Possible CIO actions triggered by the unit check handler.
99 UC_TODO_RETRY_ON_NEW_PATH,
104 * struct ccw driver - device driver for channel attached devices
105 * @owner: owning module
106 * @ids: ids supported by this driver
107 * @probe: function called on probe
108 * @remove: function called on remove
109 * @set_online: called when setting device online
110 * @set_offline: called when setting device offline
111 * @notify: notify driver of device state changes
112 * @shutdown: called at device shutdown
113 * @prepare: prepare for pm state transition
114 * @complete: undo work done in @prepare
115 * @freeze: callback for freezing during hibernation snapshotting
116 * @thaw: undo work done in @freeze
117 * @restore: callback for restoring after hibernation
118 * @uc_handler: callback for unit check handler
119 * @driver: embedded device driver structure
120 * @name: device driver name
123 struct module *owner;
124 struct ccw_device_id *ids;
125 int (*probe) (struct ccw_device *);
126 void (*remove) (struct ccw_device *);
127 int (*set_online) (struct ccw_device *);
128 int (*set_offline) (struct ccw_device *);
129 int (*notify) (struct ccw_device *, int);
130 void (*shutdown) (struct ccw_device *);
131 int (*prepare) (struct ccw_device *);
132 void (*complete) (struct ccw_device *);
133 int (*freeze)(struct ccw_device *);
134 int (*thaw) (struct ccw_device *);
135 int (*restore)(struct ccw_device *);
136 enum uc_todo (*uc_handler) (struct ccw_device *, struct irb *);
137 struct device_driver driver;
141 extern struct ccw_device *get_ccwdev_by_busid(struct ccw_driver *cdrv,
144 /* devices drivers call these during module load and unload.
145 * When a driver is registered, its probe method is called
146 * when new devices for its type pop up */
147 extern int ccw_driver_register (struct ccw_driver *driver);
148 extern void ccw_driver_unregister (struct ccw_driver *driver);
152 extern int ccw_device_set_options_mask(struct ccw_device *, unsigned long);
153 extern int ccw_device_set_options(struct ccw_device *, unsigned long);
154 extern void ccw_device_clear_options(struct ccw_device *, unsigned long);
155 int ccw_device_is_pathgroup(struct ccw_device *cdev);
156 int ccw_device_is_multipath(struct ccw_device *cdev);
158 /* Allow for i/o completion notification after primary interrupt status. */
159 #define CCWDEV_EARLY_NOTIFICATION 0x0001
160 /* Report all interrupt conditions. */
161 #define CCWDEV_REPORT_ALL 0x0002
162 /* Try to perform path grouping. */
163 #define CCWDEV_DO_PATHGROUP 0x0004
164 /* Allow forced onlining of boxed devices. */
165 #define CCWDEV_ALLOW_FORCE 0x0008
166 /* Try to use multipath mode. */
167 #define CCWDEV_DO_MULTIPATH 0x0010
169 extern int ccw_device_start(struct ccw_device *, struct ccw1 *,
170 unsigned long, __u8, unsigned long);
171 extern int ccw_device_start_timeout(struct ccw_device *, struct ccw1 *,
172 unsigned long, __u8, unsigned long, int);
173 extern int ccw_device_start_key(struct ccw_device *, struct ccw1 *,
174 unsigned long, __u8, __u8, unsigned long);
175 extern int ccw_device_start_timeout_key(struct ccw_device *, struct ccw1 *,
176 unsigned long, __u8, __u8,
180 extern int ccw_device_resume(struct ccw_device *);
181 extern int ccw_device_halt(struct ccw_device *, unsigned long);
182 extern int ccw_device_clear(struct ccw_device *, unsigned long);
183 int ccw_device_tm_start_key(struct ccw_device *cdev, struct tcw *tcw,
184 unsigned long intparm, u8 lpm, u8 key);
185 int ccw_device_tm_start_key(struct ccw_device *, struct tcw *,
186 unsigned long, u8, u8);
187 int ccw_device_tm_start_timeout_key(struct ccw_device *, struct tcw *,
188 unsigned long, u8, u8, int);
189 int ccw_device_tm_start(struct ccw_device *, struct tcw *,
191 int ccw_device_tm_start_timeout(struct ccw_device *, struct tcw *,
192 unsigned long, u8, int);
193 int ccw_device_tm_intrg(struct ccw_device *cdev);
195 extern int ccw_device_set_online(struct ccw_device *cdev);
196 extern int ccw_device_set_offline(struct ccw_device *cdev);
199 extern struct ciw *ccw_device_get_ciw(struct ccw_device *, __u32 cmd);
200 extern __u8 ccw_device_get_path_mask(struct ccw_device *);
201 extern void ccw_device_get_id(struct ccw_device *, struct ccw_dev_id *);
203 #define get_ccwdev_lock(x) (x)->ccwlock
205 #define to_ccwdev(n) container_of(n, struct ccw_device, dev)
206 #define to_ccwdrv(n) container_of(n, struct ccw_driver, driver)
208 extern struct ccw_device *ccw_device_probe_console(void);
209 extern int ccw_device_force_console(void);
211 // FIXME: these have to go
212 extern int _ccw_device_get_subchannel_number(struct ccw_device *);
214 extern void *ccw_device_get_chp_desc(struct ccw_device *, int);
215 #endif /* _S390_CCWDEV_H_ */