include/scsi/scsi_device.h

   1 #ifndef _SCSI_SCSI_DEVICE_H
   2 #define _SCSI_SCSI_DEVICE_H
   3
   4 #include <linux/device.h>
   5 #include <linux/list.h>
   6 #include <linux/spinlock.h>
   7 #include <asm/atomic.h>
   8
   9 struct request_queue;
  10 struct scsi_cmnd;
  11 struct scsi_lun;
  12 struct scsi_sense_hdr;
  13
  14 struct scsi_mode_data {
  15         __u32   length;
  16         __u16   block_descriptor_length;
  17         __u8    medium_type;
  18         __u8    device_specific;
  19         __u8    header_length;
  20         __u8    longlba:1;
  21 };
  22
  23 /*
  24  * sdev state: If you alter this, you also need to alter scsi_sysfs.c
  25  * (for the ascii descriptions) and the state model enforcer:
  26  * scsi_lib:scsi_device_set_state().
  27  */
  28 enum scsi_device_state {
  29         SDEV_CREATED = 1,       /* device created but not added to sysfs
  30                                  * Only internal commands allowed (for inq) */
  31         SDEV_RUNNING,           /* device properly configured
  32                                  * All commands allowed */
  33         SDEV_CANCEL,            /* beginning to delete device
  34                                  * Only error handler commands allowed */
  35         SDEV_DEL,               /* device deleted
  36                                  * no commands allowed */
  37         SDEV_QUIESCE,           /* Device quiescent.  No block commands
  38                                  * will be accepted, only specials (which
  39                                  * originate in the mid-layer) */
  40         SDEV_OFFLINE,           /* Device offlined (by error handling or
  41                                  * user request */
  42         SDEV_BLOCK,             /* Device blocked by scsi lld.  No scsi
  43                                  * commands from user or midlayer should be issued
  44                                  * to the scsi lld. */
  45 };
  46
  47 struct scsi_device {
  48         struct Scsi_Host *host;
  49         struct request_queue *request_queue;
  50
  51         /* the next two are protected by the host->host_lock */
  52         struct list_head    siblings;   /* list of all devices on this host */
  53         struct list_head    same_target_siblings; /* just the devices sharing same target id */
  54
  55         /* this is now protected by the request_queue->queue_lock */
  56         unsigned int device_busy;       /* commands actually active on
  57                                          * low-level. protected by queue_lock. */
  58         spinlock_t list_lock;
  59         struct list_head cmd_list;      /* queue of in use SCSI Command structures */
  60         struct list_head starved_entry;
  61         struct scsi_cmnd *current_cmnd; /* currently active command */
  62         unsigned short queue_depth;     /* How deep of a queue we want */
  63         unsigned short last_queue_full_depth; /* These two are used by */
  64         unsigned short last_queue_full_count; /* scsi_track_queue_full() */
  65         unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
  66                                            jiffie count on our counter, they
  67                                            could all be from the same event. */
  68
  69         unsigned int id, lun, channel;
  70
  71         unsigned int manufacturer;      /* Manufacturer of device, for using
  72                                          * vendor-specific cmd's */
  73         unsigned sector_size;   /* size in bytes */
  74
  75         void *hostdata;         /* available to low-level driver */
  76         char devfs_name[256];   /* devfs junk */
  77         char type;
  78         char scsi_level;
  79         char inq_periph_qual;   /* PQ from INQUIRY data */
  80         unsigned char inquiry_len;      /* valid bytes in 'inquiry' */
  81         unsigned char * inquiry;        /* INQUIRY response data */
  82         const char * vendor;            /* [back_compat] point into 'inquiry' ... */
  83         const char * model;             /* ... after scan; point to static string */
  84         const char * rev;               /* ... "nullnullnullnull" before scan */
  85         unsigned char current_tag;      /* current tag */
  86         struct scsi_target      *sdev_target;   /* used only for single_lun */
  87
  88         unsigned int    sdev_bflags; /* black/white flags as also found in
  89                                  * scsi_devinfo.[hc]. For now used only to
  90                                  * pass settings from slave_alloc to scsi
  91                                  * core. */
  92         unsigned writeable:1;
  93         unsigned removable:1;
  94         unsigned changed:1;     /* Data invalid due to media change */
  95         unsigned busy:1;        /* Used to prevent races */
  96         unsigned lockable:1;    /* Able to prevent media removal */
  97         unsigned locked:1;      /* Media removal disabled */
  98         unsigned borken:1;      /* Tell the Seagate driver to be
  99                                  * painfully slow on this device */
 100         unsigned disconnect:1;  /* can disconnect */
 101         unsigned soft_reset:1;  /* Uses soft reset option */
 102         unsigned sdtr:1;        /* Device supports SDTR messages */
 103         unsigned wdtr:1;        /* Device supports WDTR messages */
 104         unsigned ppr:1;         /* Device supports PPR messages */
 105         unsigned tagged_supported:1;    /* Supports SCSI-II tagged queuing */
 106         unsigned simple_tags:1; /* simple queue tag messages are enabled */
 107         unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
 108         unsigned single_lun:1;  /* Indicates we should only allow I/O to
 109                                  * one of the luns for the device at a
 110                                  * time. */
 111         unsigned was_reset:1;   /* There was a bus reset on the bus for
 112                                  * this device */
 113         unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
 114                                      * because we did a bus reset. */
 115         unsigned use_10_for_rw:1; /* first try 10-byte read / write */
 116         unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
 117         unsigned skip_ms_page_8:1;      /* do not use MODE SENSE page 0x08 */
 118         unsigned skip_ms_page_3f:1;     /* do not use MODE SENSE page 0x3f */
 119         unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
 120         unsigned no_start_on_add:1;     /* do not issue start on add */
 121         unsigned allow_restart:1; /* issue START_UNIT in error handler */
 122         unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
 123         unsigned select_no_atn:1;
 124         unsigned fix_capacity:1;        /* READ_CAPACITY is too high by 1 */
 125         unsigned retry_hwerror:1;       /* Retry HARDWARE_ERROR */
 126
 127         unsigned int device_blocked;    /* Device returned QUEUE_FULL. */
 128
 129         unsigned int max_device_blocked; /* what device_blocked counts down from  */
 130 #define SCSI_DEFAULT_DEVICE_BLOCKED     3
 131
 132         atomic_t iorequest_cnt;
 133         atomic_t iodone_cnt;
 134         atomic_t ioerr_cnt;
 135
 136         int timeout;
 137
 138         struct device           sdev_gendev;
 139         struct class_device     sdev_classdev;
 140
 141         enum scsi_device_state sdev_state;
 142         unsigned long           sdev_data[0];
 143 } __attribute__((aligned(sizeof(unsigned long))));
 144 #define to_scsi_device(d)       \
 145         container_of(d, struct scsi_device, sdev_gendev)
 146 #define class_to_sdev(d)        \
 147         container_of(d, struct scsi_device, sdev_classdev)
 148 #define transport_class_to_sdev(class_dev) \
 149         to_scsi_device(class_dev->dev)
 150
 151 #define sdev_printk(prefix, sdev, fmt, a...)    \
 152         dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
 153
 154 #define scmd_printk(prefix, scmd, fmt, a...)    \
 155         dev_printk(prefix, &(scmd)->device->sdev_gendev, fmt, ##a)
 156
 157 /*
 158  * scsi_target: representation of a scsi target, for now, this is only
 159  * used for single_lun devices. If no one has active IO to the target,
 160  * starget_sdev_user is NULL, else it points to the active sdev.
 161  */
 162 struct scsi_target {
 163         struct scsi_device      *starget_sdev_user;
 164         struct list_head        siblings;
 165         struct list_head        devices;
 166         struct device           dev;
 167         unsigned int            reap_ref; /* protected by the host lock */
 168         unsigned int            channel;
 169         unsigned int            id; /* target id ... replace
 170                                      * scsi_device.id eventually */
 171         unsigned long           create:1; /* signal that it needs to be added */
 172         char                    scsi_level;
 173         void                    *hostdata; /* available to low-level driver */
 174         unsigned long           starget_data[0]; /* for the transport */
 175         /* starget_data must be the last element!!!! */
 176 } __attribute__((aligned(sizeof(unsigned long))));
 177
 178 #define to_scsi_target(d)       container_of(d, struct scsi_target, dev)
 179 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
 180 {
 181         return to_scsi_target(sdev->sdev_gendev.parent);
 182 }
 183 #define transport_class_to_starget(class_dev) \
 184         to_scsi_target(class_dev->dev)
 185
 186 #define starget_printk(prefix, starget, fmt, a...)      \
 187         dev_printk(prefix, &(starget)->dev, fmt, ##a)
 188
 189 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
 190                 uint, uint, uint, void *hostdata);
 191 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
 192                            uint target, uint lun);
 193 extern void scsi_remove_device(struct scsi_device *);
 194 extern int scsi_device_cancel(struct scsi_device *, int);
 195
 196 extern int scsi_device_get(struct scsi_device *);
 197 extern void scsi_device_put(struct scsi_device *);
 198 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
 199                                               uint, uint, uint);
 200 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
 201                                                 uint, uint, uint);
 202 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
 203                                                         uint);
 204 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
 205                                                           uint);
 206 extern void starget_for_each_device(struct scsi_target *, void *,
 207                      void (*fn)(struct scsi_device *, void *));
 208
 209 /* only exposed to implement shost_for_each_device */
 210 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
 211                                                   struct scsi_device *);
 212
 213 /**
 214  * shost_for_each_device  -  iterate over all devices of a host
 215  * @sdev:       iterator
 216  * @host:       host whiches devices we want to iterate over
 217  *
 218  * This traverses over each devices of @shost.  The devices have
 219  * a reference that must be released by scsi_host_put when breaking
 220  * out of the loop.
 221  */
 222 #define shost_for_each_device(sdev, shost) \
 223         for ((sdev) = __scsi_iterate_devices((shost), NULL); \
 224              (sdev); \
 225              (sdev) = __scsi_iterate_devices((shost), (sdev)))
 226
 227 /**
 228  * __shost_for_each_device  -  iterate over all devices of a host (UNLOCKED)
 229  * @sdev:       iterator
 230  * @host:       host whiches devices we want to iterate over
 231  *
 232  * This traverses over each devices of @shost.  It does _not_ take a
 233  * reference on the scsi_device, thus it the whole loop must be protected
 234  * by shost->host_lock.
 235  *
 236  * Note:  The only reason why drivers would want to use this is because
 237  * they're need to access the device list in irq context.  Otherwise you
 238  * really want to use shost_for_each_device instead.
 239  */
 240 #define __shost_for_each_device(sdev, shost) \
 241         list_for_each_entry((sdev), &((shost)->__devices), siblings)
 242
 243 extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
 244 extern int scsi_track_queue_full(struct scsi_device *, int);
 245
 246 extern int scsi_set_medium_removal(struct scsi_device *, char);
 247
 248 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
 249                            unsigned char *buffer, int len, int timeout,
 250                            int retries, struct scsi_mode_data *data,
 251                            struct scsi_sense_hdr *);
 252 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
 253                                 int retries);
 254 extern int scsi_device_set_state(struct scsi_device *sdev,
 255                                  enum scsi_device_state state);
 256 extern int scsi_device_quiesce(struct scsi_device *sdev);
 257 extern void scsi_device_resume(struct scsi_device *sdev);
 258 extern void scsi_target_quiesce(struct scsi_target *);
 259 extern void scsi_target_resume(struct scsi_target *);
 260 extern void scsi_scan_target(struct device *parent, unsigned int channel,
 261                              unsigned int id, unsigned int lun, int rescan);
 262 extern void scsi_target_reap(struct scsi_target *);
 263 extern void scsi_target_block(struct device *);
 264 extern void scsi_target_unblock(struct device *);
 265 extern void scsi_remove_target(struct device *);
 266 extern void int_to_scsilun(unsigned int, struct scsi_lun *);
 267 extern const char *scsi_device_state_name(enum scsi_device_state);
 268 extern int scsi_is_sdev_device(const struct device *);
 269 extern int scsi_is_target_device(const struct device *);
 270 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
 271                         int data_direction, void *buffer, unsigned bufflen,
 272                         unsigned char *sense, int timeout, int retries,
 273                         int flag);
 274 extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
 275                             int data_direction, void *buffer, unsigned bufflen,
 276                             struct scsi_sense_hdr *, int timeout, int retries);
 277 extern int scsi_execute_async(struct scsi_device *sdev,
 278                               const unsigned char *cmd, int cmd_len, int data_direction,
 279                               void *buffer, unsigned bufflen, int use_sg,
 280                               int timeout, int retries, void *privdata,
 281                               void (*done)(void *, char *, int, int),
 282                               gfp_t gfp);
 283
 284 static inline unsigned int sdev_channel(struct scsi_device *sdev)
 285 {
 286         return sdev->channel;
 287 }
 288
 289 static inline unsigned int sdev_id(struct scsi_device *sdev)
 290 {
 291         return sdev->id;
 292 }
 293
 294 #define scmd_id(scmd) sdev_id((scmd)->device)
 295 #define scmd_channel(scmd) sdev_channel((scmd)->device)
 296
 297 static inline int scsi_device_online(struct scsi_device *sdev)
 298 {
 299         return sdev->sdev_state != SDEV_OFFLINE;
 300 }
 301
 302 /* accessor functions for the SCSI parameters */
 303 static inline int scsi_device_sync(struct scsi_device *sdev)
 304 {
 305         return sdev->sdtr;
 306 }
 307 static inline int scsi_device_wide(struct scsi_device *sdev)
 308 {
 309         return sdev->wdtr;
 310 }
 311 static inline int scsi_device_dt(struct scsi_device *sdev)
 312 {
 313         return sdev->ppr;
 314 }
 315 static inline int scsi_device_dt_only(struct scsi_device *sdev)
 316 {
 317         if (sdev->inquiry_len < 57)
 318                 return 0;
 319         return (sdev->inquiry[56] & 0x0c) == 0x04;
 320 }
 321 static inline int scsi_device_ius(struct scsi_device *sdev)
 322 {
 323         if (sdev->inquiry_len < 57)
 324                 return 0;
 325         return sdev->inquiry[56] & 0x01;
 326 }
 327 static inline int scsi_device_qas(struct scsi_device *sdev)
 328 {
 329         if (sdev->inquiry_len < 57)
 330                 return 0;
 331         return sdev->inquiry[56] & 0x02;
 332 }
 333 #endif /* _SCSI_SCSI_DEVICE_H */