2 * include/asm-s390/ccwdev.h
3 * include/asm-s390x/ccwdev.h
5 * Copyright (C) 2002 IBM Deutschland Entwicklung GmbH, IBM Corporation
6 * Author(s): Arnd Bergmann <arndb@de.ibm.com>
8 * Interface for CCW device drivers
10 #ifndef _S390_CCWDEV_H_
11 #define _S390_CCWDEV_H_
13 #include <linux/device.h>
14 #include <linux/mod_devicetable.h>
16 /* structs from asm/cio.h */
21 /* simplified initializers for struct ccw_device:
22 * CCW_DEVICE and CCW_DEVICE_DEVTYPE initialize one
23 * entry in your MODULE_DEVICE_TABLE and set the match_flag correctly */
24 #define CCW_DEVICE(cu, cum) \
25 .cu_type=(cu), .cu_model=(cum), \
26 .match_flags=(CCW_DEVICE_ID_MATCH_CU_TYPE \
27 | (cum ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0))
29 #define CCW_DEVICE_DEVTYPE(cu, cum, dev, devm) \
30 .cu_type=(cu), .cu_model=(cum), .dev_type=(dev), .dev_model=(devm),\
31 .match_flags=CCW_DEVICE_ID_MATCH_CU_TYPE \
32 | ((cum) ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0) \
33 | CCW_DEVICE_ID_MATCH_DEVICE_TYPE \
34 | ((devm) ? CCW_DEVICE_ID_MATCH_DEVICE_MODEL : 0)
36 /* scan through an array of device ids and return the first
37 * entry that matches the device.
39 * the array must end with an entry containing zero match_flags
41 static inline const struct ccw_device_id *
42 ccw_device_id_match(const struct ccw_device_id *array,
43 const struct ccw_device_id *match)
45 const struct ccw_device_id *id = array;
47 for (id = array; id->match_flags; id++) {
48 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_TYPE)
49 && (id->cu_type != match->cu_type))
52 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_MODEL)
53 && (id->cu_model != match->cu_model))
56 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_TYPE)
57 && (id->dev_type != match->dev_type))
60 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_MODEL)
61 && (id->dev_model != match->dev_model))
71 * struct ccw_device - channel attached device
72 * @ccwlock: pointer to device lock
73 * @id: id of this device
74 * @drv: ccw driver for this device
75 * @dev: embedded device structure
76 * @online: online status of device
77 * @handler: interrupt handler
79 * @handler is a member of the device rather than the driver since a driver
80 * can have different interrupt handlers for different ccw devices
81 * (multi-subchannel drivers).
86 struct ccw_device_private *private; /* cio private information */
88 struct ccw_device_id id;
89 struct ccw_driver *drv;
92 void (*handler) (struct ccw_device *, unsigned long, struct irb *);
97 * struct ccw driver - device driver for channel attached devices
98 * @owner: owning module
99 * @ids: ids supported by this driver
100 * @probe: function called on probe
101 * @remove: function called on remove
102 * @set_online: called when setting device online
103 * @set_offline: called when setting device offline
104 * @notify: notify driver of device state changes
105 * @driver: embedded device driver structure
106 * @name: device driver name
109 struct module *owner;
110 struct ccw_device_id *ids;
111 int (*probe) (struct ccw_device *);
112 void (*remove) (struct ccw_device *);
113 int (*set_online) (struct ccw_device *);
114 int (*set_offline) (struct ccw_device *);
115 int (*notify) (struct ccw_device *, int);
116 struct device_driver driver;
120 extern struct ccw_device *get_ccwdev_by_busid(struct ccw_driver *cdrv,
123 /* devices drivers call these during module load and unload.
124 * When a driver is registered, its probe method is called
125 * when new devices for its type pop up */
126 extern int ccw_driver_register (struct ccw_driver *driver);
127 extern void ccw_driver_unregister (struct ccw_driver *driver);
131 extern int ccw_device_set_options_mask(struct ccw_device *, unsigned long);
132 extern int ccw_device_set_options(struct ccw_device *, unsigned long);
133 extern void ccw_device_clear_options(struct ccw_device *, unsigned long);
135 /* Allow for i/o completion notification after primary interrupt status. */
136 #define CCWDEV_EARLY_NOTIFICATION 0x0001
137 /* Report all interrupt conditions. */
138 #define CCWDEV_REPORT_ALL 0x0002
139 /* Try to perform path grouping. */
140 #define CCWDEV_DO_PATHGROUP 0x0004
141 /* Allow forced onlining of boxed devices. */
142 #define CCWDEV_ALLOW_FORCE 0x0008
144 extern int ccw_device_start(struct ccw_device *, struct ccw1 *,
145 unsigned long, __u8, unsigned long);
146 extern int ccw_device_start_timeout(struct ccw_device *, struct ccw1 *,
147 unsigned long, __u8, unsigned long, int);
148 extern int ccw_device_start_key(struct ccw_device *, struct ccw1 *,
149 unsigned long, __u8, __u8, unsigned long);
150 extern int ccw_device_start_timeout_key(struct ccw_device *, struct ccw1 *,
151 unsigned long, __u8, __u8,
155 extern int ccw_device_resume(struct ccw_device *);
156 extern int ccw_device_halt(struct ccw_device *, unsigned long);
157 extern int ccw_device_clear(struct ccw_device *, unsigned long);
159 extern int ccw_device_set_online(struct ccw_device *cdev);
160 extern int ccw_device_set_offline(struct ccw_device *cdev);
163 extern struct ciw *ccw_device_get_ciw(struct ccw_device *, __u32 cmd);
164 extern __u8 ccw_device_get_path_mask(struct ccw_device *);
165 extern void ccw_device_get_id(struct ccw_device *, struct ccw_dev_id *);
167 #define get_ccwdev_lock(x) (x)->ccwlock
169 #define to_ccwdev(n) container_of(n, struct ccw_device, dev)
170 #define to_ccwdrv(n) container_of(n, struct ccw_driver, driver)
172 extern struct ccw_device *ccw_device_probe_console(void);
174 // FIXME: these have to go
175 extern int _ccw_device_get_subchannel_number(struct ccw_device *);
177 extern void *ccw_device_get_chp_desc(struct ccw_device *, int);
178 #endif /* _S390_CCWDEV_H_ */