drivers/s390/cio/io_sch.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef S390_IO_SCH_H
   3 #define S390_IO_SCH_H
   4
   5 #include <linux/types.h>
   6 #include <asm/schid.h>
   7 #include <asm/ccwdev.h>
   8 #include <asm/irq.h>
   9 #include "css.h"
  10 #include "orb.h"
  11
  12 struct io_subchannel_private {
  13         union orb orb;          /* operation request block */
  14         struct ccw1 sense_ccw;  /* static ccw for sense command */
  15         struct ccw_device *cdev;/* pointer to the child ccw device */
  16         struct {
  17                 unsigned int suspend:1; /* allow suspend */
  18                 unsigned int prefetch:1;/* deny prefetch */
  19                 unsigned int inter:1;   /* suppress intermediate interrupts */
  20         } __packed options;
  21 } __aligned(8);
  22
  23 #define to_io_private(n) ((struct io_subchannel_private *) \
  24                           dev_get_drvdata(&(n)->dev))
  25 #define set_io_private(n, p) (dev_set_drvdata(&(n)->dev, p))
  26
  27 static inline struct ccw_device *sch_get_cdev(struct subchannel *sch)
  28 {
  29         struct io_subchannel_private *priv = to_io_private(sch);
  30         return priv ? priv->cdev : NULL;
  31 }
  32
  33 static inline void sch_set_cdev(struct subchannel *sch,
  34                                 struct ccw_device *cdev)
  35 {
  36         struct io_subchannel_private *priv = to_io_private(sch);
  37         if (priv)
  38                 priv->cdev = cdev;
  39 }
  40
  41 #define MAX_CIWS 8
  42
  43 /*
  44  * Possible status values for a CCW request's I/O.
  45  */
  46 enum io_status {
  47         IO_DONE,
  48         IO_RUNNING,
  49         IO_STATUS_ERROR,
  50         IO_PATH_ERROR,
  51         IO_REJECTED,
  52         IO_KILLED
  53 };
  54
  55 /**
  56  * ccw_request - Internal CCW request.
  57  * @cp: channel program to start
  58  * @timeout: maximum allowable time in jiffies between start I/O and interrupt
  59  * @maxretries: number of retries per I/O operation and path
  60  * @lpm: mask of paths to use
  61  * @check: optional callback that determines if results are final
  62  * @filter: optional callback to adjust request status based on IRB data
  63  * @callback: final callback
  64  * @data: user-defined pointer passed to all callbacks
  65  * @singlepath: if set, use only one path from @lpm per start I/O
  66  * @cancel: non-zero if request was cancelled
  67  * @done: non-zero if request was finished
  68  * @mask: current path mask
  69  * @retries: current number of retries
  70  * @drc: delayed return code
  71  */
  72 struct ccw_request {
  73         struct ccw1 *cp;
  74         unsigned long timeout;
  75         u16 maxretries;
  76         u8 lpm;
  77         int (*check)(struct ccw_device *, void *);
  78         enum io_status (*filter)(struct ccw_device *, void *, struct irb *,
  79                                  enum io_status);
  80         void (*callback)(struct ccw_device *, void *, int);
  81         void *data;
  82         unsigned int singlepath:1;
  83         /* These fields are used internally. */
  84         unsigned int cancel:1;
  85         unsigned int done:1;
  86         u16 mask;
  87         u16 retries;
  88         int drc;
  89 } __attribute__((packed));
  90
  91 /*
  92  * sense-id response buffer layout
  93  */
  94 struct senseid {
  95         /* common part */
  96         u8  reserved;   /* always 0x'FF' */
  97         u16 cu_type;    /* control unit type */
  98         u8  cu_model;   /* control unit model */
  99         u16 dev_type;   /* device type */
 100         u8  dev_model;  /* device model */
 101         u8  unused;     /* padding byte */
 102         /* extended part */
 103         struct ciw ciw[MAX_CIWS];       /* variable # of CIWs */
 104 }  __attribute__ ((packed, aligned(4)));
 105
 106 enum cdev_todo {
 107         CDEV_TODO_NOTHING,
 108         CDEV_TODO_ENABLE_CMF,
 109         CDEV_TODO_REBIND,
 110         CDEV_TODO_REGISTER,
 111         CDEV_TODO_UNREG,
 112         CDEV_TODO_UNREG_EVAL,
 113 };
 114
 115 #define FAKE_CMD_IRB    1
 116 #define FAKE_TM_IRB     2
 117
 118 struct ccw_device_private {
 119         struct ccw_device *cdev;
 120         struct subchannel *sch;
 121         int state;              /* device state */
 122         atomic_t onoff;
 123         struct ccw_dev_id dev_id;       /* device id */
 124         struct ccw_request req;         /* internal I/O request */
 125         int iretry;
 126         u8 pgid_valid_mask;     /* mask of valid PGIDs */
 127         u8 pgid_todo_mask;      /* mask of PGIDs to be adjusted */
 128         u8 pgid_reset_mask;     /* mask of PGIDs which were reset */
 129         u8 path_noirq_mask;     /* mask of paths for which no irq was
 130                                    received */
 131         u8 path_notoper_mask;   /* mask of paths which were found
 132                                    not operable */
 133         u8 path_gone_mask;      /* mask of paths, that became unavailable */
 134         u8 path_new_mask;       /* mask of paths, that became available */
 135         u8 path_broken_mask;    /* mask of paths, which were found to be
 136                                    unusable */
 137         struct {
 138                 unsigned int fast:1;    /* post with "channel end" */
 139                 unsigned int repall:1;  /* report every interrupt status */
 140                 unsigned int pgroup:1;  /* do path grouping */
 141                 unsigned int force:1;   /* allow forced online */
 142                 unsigned int mpath:1;   /* do multipathing */
 143         } __attribute__ ((packed)) options;
 144         struct {
 145                 unsigned int esid:1;        /* Ext. SenseID supported by HW */
 146                 unsigned int dosense:1;     /* delayed SENSE required */
 147                 unsigned int doverify:1;    /* delayed path verification */
 148                 unsigned int donotify:1;    /* call notify function */
 149                 unsigned int recog_done:1;  /* dev. recog. complete */
 150                 unsigned int fake_irb:2;    /* deliver faked irb */
 151                 unsigned int resuming:1;    /* recognition while resume */
 152                 unsigned int pgroup:1;      /* pathgroup is set up */
 153                 unsigned int mpath:1;       /* multipathing is set up */
 154                 unsigned int pgid_unknown:1;/* unknown pgid state */
 155                 unsigned int initialized:1; /* set if initial reference held */
 156         } __attribute__((packed)) flags;
 157         unsigned long intparm;  /* user interruption parameter */
 158         struct qdio_irq *qdio_data;
 159         struct irb irb;         /* device status */
 160         int async_kill_io_rc;
 161         struct senseid senseid; /* SenseID info */
 162         struct pgid pgid[8];    /* path group IDs per chpid*/
 163         struct ccw1 iccws[2];   /* ccws for SNID/SID/SPGID commands */
 164         struct work_struct todo_work;
 165         enum cdev_todo todo;
 166         wait_queue_head_t wait_q;
 167         struct timer_list timer;
 168         void *cmb;                      /* measurement information */
 169         struct list_head cmb_list;      /* list of measured devices */
 170         u64 cmb_start_time;             /* clock value of cmb reset */
 171         void *cmb_wait;                 /* deferred cmb enable/disable */
 172         enum interruption_class int_class;
 173 };
 174
 175 #endif