arch/s390/include/asm/ccwdev.h

   1 /*
   2  * Copyright  IBM Corp. 2002, 2009
   3  *
   4  * Author(s): Arnd Bergmann <arndb@de.ibm.com>
   5  *
   6  * Interface for CCW device drivers
   7  */
   8 #ifndef _S390_CCWDEV_H_
   9 #define _S390_CCWDEV_H_
  10
  11 #include <linux/device.h>
  12 #include <linux/mod_devicetable.h>
  13 #include <asm/fcx.h>
  14 #include <asm/irq.h>
  15
  16 /* structs from asm/cio.h */
  17 struct irb;
  18 struct ccw1;
  19 struct ccw_dev_id;
  20
  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))
  28
  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)
  35
  36 /* scan through an array of device ids and return the first
  37  * entry that matches the device.
  38  *
  39  * the array must end with an entry containing zero match_flags
  40  */
  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)
  44 {
  45         const struct ccw_device_id *id = array;
  46
  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))
  50                         continue;
  51
  52                 if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_MODEL)
  53                     && (id->cu_model != match->cu_model))
  54                         continue;
  55
  56                 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_TYPE)
  57                     && (id->dev_type != match->dev_type))
  58                         continue;
  59
  60                 if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_MODEL)
  61                     && (id->dev_model != match->dev_model))
  62                         continue;
  63
  64                 return id;
  65         }
  66
  67         return NULL;
  68 }
  69
  70 /**
  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
  78  *
  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).
  82  */
  83 struct ccw_device {
  84         spinlock_t *ccwlock;
  85 /* private: */
  86         struct ccw_device_private *private;     /* cio private information */
  87 /* public: */
  88         struct ccw_device_id id;
  89         struct ccw_driver *drv;
  90         struct device dev;
  91         int online;
  92         void (*handler) (struct ccw_device *, unsigned long, struct irb *);
  93 };
  94
  95 /*
  96  * Possible events used by the path_event notifier.
  97  */
  98 #define PE_NONE                         0x0
  99 #define PE_PATH_GONE                    0x1 /* A path is no longer available. */
 100 #define PE_PATH_AVAILABLE               0x2 /* A path has become available and
 101                                                was successfully verified. */
 102 #define PE_PATHGROUP_ESTABLISHED        0x4 /* A pathgroup was reset and had
 103                                                to be established again. */
 104
 105 /*
 106  * Possible CIO actions triggered by the unit check handler.
 107  */
 108 enum uc_todo {
 109         UC_TODO_RETRY,
 110         UC_TODO_RETRY_ON_NEW_PATH,
 111         UC_TODO_STOP
 112 };
 113
 114 /**
 115  * struct ccw driver - device driver for channel attached devices
 116  * @ids: ids supported by this driver
 117  * @probe: function called on probe
 118  * @remove: function called on remove
 119  * @set_online: called when setting device online
 120  * @set_offline: called when setting device offline
 121  * @notify: notify driver of device state changes
 122  * @path_event: notify driver of channel path events
 123  * @shutdown: called at device shutdown
 124  * @prepare: prepare for pm state transition
 125  * @complete: undo work done in @prepare
 126  * @freeze: callback for freezing during hibernation snapshotting
 127  * @thaw: undo work done in @freeze
 128  * @restore: callback for restoring after hibernation
 129  * @uc_handler: callback for unit check handler
 130  * @driver: embedded device driver structure
 131  * @int_class: interruption class to use for accounting interrupts
 132  */
 133 struct ccw_driver {
 134         struct ccw_device_id *ids;
 135         int (*probe) (struct ccw_device *);
 136         void (*remove) (struct ccw_device *);
 137         int (*set_online) (struct ccw_device *);
 138         int (*set_offline) (struct ccw_device *);
 139         int (*notify) (struct ccw_device *, int);
 140         void (*path_event) (struct ccw_device *, int *);
 141         void (*shutdown) (struct ccw_device *);
 142         int (*prepare) (struct ccw_device *);
 143         void (*complete) (struct ccw_device *);
 144         int (*freeze)(struct ccw_device *);
 145         int (*thaw) (struct ccw_device *);
 146         int (*restore)(struct ccw_device *);
 147         enum uc_todo (*uc_handler) (struct ccw_device *, struct irb *);
 148         struct device_driver driver;
 149         enum interruption_class int_class;
 150 };
 151
 152 extern struct ccw_device *get_ccwdev_by_busid(struct ccw_driver *cdrv,
 153                                               const char *bus_id);
 154
 155 /* devices drivers call these during module load and unload.
 156  * When a driver is registered, its probe method is called
 157  * when new devices for its type pop up */
 158 extern int  ccw_driver_register   (struct ccw_driver *driver);
 159 extern void ccw_driver_unregister (struct ccw_driver *driver);
 160
 161 struct ccw1;
 162
 163 extern int ccw_device_set_options_mask(struct ccw_device *, unsigned long);
 164 extern int ccw_device_set_options(struct ccw_device *, unsigned long);
 165 extern void ccw_device_clear_options(struct ccw_device *, unsigned long);
 166 int ccw_device_is_pathgroup(struct ccw_device *cdev);
 167 int ccw_device_is_multipath(struct ccw_device *cdev);
 168
 169 /* Allow for i/o completion notification after primary interrupt status. */
 170 #define CCWDEV_EARLY_NOTIFICATION       0x0001
 171 /* Report all interrupt conditions. */
 172 #define CCWDEV_REPORT_ALL               0x0002
 173 /* Try to perform path grouping. */
 174 #define CCWDEV_DO_PATHGROUP             0x0004
 175 /* Allow forced onlining of boxed devices. */
 176 #define CCWDEV_ALLOW_FORCE              0x0008
 177 /* Try to use multipath mode. */
 178 #define CCWDEV_DO_MULTIPATH             0x0010
 179
 180 extern int ccw_device_start(struct ccw_device *, struct ccw1 *,
 181                             unsigned long, __u8, unsigned long);
 182 extern int ccw_device_start_timeout(struct ccw_device *, struct ccw1 *,
 183                                     unsigned long, __u8, unsigned long, int);
 184 extern int ccw_device_start_key(struct ccw_device *, struct ccw1 *,
 185                                 unsigned long, __u8, __u8, unsigned long);
 186 extern int ccw_device_start_timeout_key(struct ccw_device *, struct ccw1 *,
 187                                         unsigned long, __u8, __u8,
 188                                         unsigned long, int);
 189
 190
 191 extern int ccw_device_resume(struct ccw_device *);
 192 extern int ccw_device_halt(struct ccw_device *, unsigned long);
 193 extern int ccw_device_clear(struct ccw_device *, unsigned long);
 194 int ccw_device_tm_start_key(struct ccw_device *cdev, struct tcw *tcw,
 195                             unsigned long intparm, u8 lpm, u8 key);
 196 int ccw_device_tm_start_key(struct ccw_device *, struct tcw *,
 197                             unsigned long, u8, u8);
 198 int ccw_device_tm_start_timeout_key(struct ccw_device *, struct tcw *,
 199                             unsigned long, u8, u8, int);
 200 int ccw_device_tm_start(struct ccw_device *, struct tcw *,
 201                             unsigned long, u8);
 202 int ccw_device_tm_start_timeout(struct ccw_device *, struct tcw *,
 203                             unsigned long, u8, int);
 204 int ccw_device_tm_intrg(struct ccw_device *cdev);
 205
 206 int ccw_device_get_mdc(struct ccw_device *cdev, u8 mask);
 207
 208 extern int ccw_device_set_online(struct ccw_device *cdev);
 209 extern int ccw_device_set_offline(struct ccw_device *cdev);
 210
 211
 212 extern struct ciw *ccw_device_get_ciw(struct ccw_device *, __u32 cmd);
 213 extern __u8 ccw_device_get_path_mask(struct ccw_device *);
 214 extern void ccw_device_get_id(struct ccw_device *, struct ccw_dev_id *);
 215
 216 #define get_ccwdev_lock(x) (x)->ccwlock
 217
 218 #define to_ccwdev(n) container_of(n, struct ccw_device, dev)
 219 #define to_ccwdrv(n) container_of(n, struct ccw_driver, driver)
 220
 221 extern struct ccw_device *ccw_device_probe_console(void);
 222 extern int ccw_device_force_console(void);
 223
 224 int ccw_device_siosl(struct ccw_device *);
 225
 226 // FIXME: these have to go
 227 extern int _ccw_device_get_subchannel_number(struct ccw_device *);
 228
 229 extern void *ccw_device_get_chp_desc(struct ccw_device *, int);
 230 #endif /* _S390_CCWDEV_H_ */