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 <linux/workqueue.h>
   8 #include <linux/blkdev.h>
   9 #include <asm/atomic.h>
  10
  11 struct request_queue;
  12 struct scsi_cmnd;
  13 struct scsi_lun;
  14 struct scsi_sense_hdr;
  15
  16 struct scsi_mode_data {
  17         __u32   length;
  18         __u16   block_descriptor_length;
  19         __u8    medium_type;
  20         __u8    device_specific;
  21         __u8    header_length;
  22         __u8    longlba:1;
  23 };
  24
  25 /*
  26  * sdev state: If you alter this, you also need to alter scsi_sysfs.c
  27  * (for the ascii descriptions) and the state model enforcer:
  28  * scsi_lib:scsi_device_set_state().
  29  */
  30 enum scsi_device_state {
  31         SDEV_CREATED = 1,       /* device created but not added to sysfs
  32                                  * Only internal commands allowed (for inq) */
  33         SDEV_RUNNING,           /* device properly configured
  34                                  * All commands allowed */
  35         SDEV_CANCEL,            /* beginning to delete device
  36                                  * Only error handler commands allowed */
  37         SDEV_DEL,               /* device deleted
  38                                  * no commands allowed */
  39         SDEV_QUIESCE,           /* Device quiescent.  No block commands
  40                                  * will be accepted, only specials (which
  41                                  * originate in the mid-layer) */
  42         SDEV_OFFLINE,           /* Device offlined (by error handling or
  43                                  * user request */
  44         SDEV_BLOCK,             /* Device blocked by scsi lld.  No scsi
  45                                  * commands from user or midlayer should be issued
  46                                  * to the scsi lld. */
  47 };
  48
  49 enum scsi_device_event {
  50         SDEV_EVT_MEDIA_CHANGE   = 1,    /* media has changed */
  51
  52         SDEV_EVT_LAST           = SDEV_EVT_MEDIA_CHANGE,
  53         SDEV_EVT_MAXBITS        = SDEV_EVT_LAST + 1
  54 };
  55
  56 struct scsi_event {
  57         enum scsi_device_event  evt_type;
  58         struct list_head        node;
  59
  60         /* put union of data structures, for non-simple event types,
  61          * here
  62          */
  63 };
  64
  65 struct scsi_device {
  66         struct Scsi_Host *host;
  67         struct request_queue *request_queue;
  68
  69         /* the next two are protected by the host->host_lock */
  70         struct list_head    siblings;   /* list of all devices on this host */
  71         struct list_head    same_target_siblings; /* just the devices sharing same target id */
  72
  73         /* this is now protected by the request_queue->queue_lock */
  74         unsigned int device_busy;       /* commands actually active on
  75                                          * low-level. protected by queue_lock. */
  76         spinlock_t list_lock;
  77         struct list_head cmd_list;      /* queue of in use SCSI Command structures */
  78         struct list_head starved_entry;
  79         struct scsi_cmnd *current_cmnd; /* currently active command */
  80         unsigned short queue_depth;     /* How deep of a queue we want */
  81         unsigned short last_queue_full_depth; /* These two are used by */
  82         unsigned short last_queue_full_count; /* scsi_track_queue_full() */
  83         unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
  84                                            jiffie count on our counter, they
  85                                            could all be from the same event. */
  86
  87         unsigned int id, lun, channel;
  88
  89         unsigned int manufacturer;      /* Manufacturer of device, for using
  90                                          * vendor-specific cmd's */
  91         unsigned sector_size;   /* size in bytes */
  92
  93         void *hostdata;         /* available to low-level driver */
  94         char type;
  95         char scsi_level;
  96         char inq_periph_qual;   /* PQ from INQUIRY data */
  97         unsigned char inquiry_len;      /* valid bytes in 'inquiry' */
  98         unsigned char * inquiry;        /* INQUIRY response data */
  99         const char * vendor;            /* [back_compat] point into 'inquiry' ... */
 100         const char * model;             /* ... after scan; point to static string */
 101         const char * rev;               /* ... "nullnullnullnull" before scan */
 102         unsigned char current_tag;      /* current tag */
 103         struct scsi_target      *sdev_target;   /* used only for single_lun */
 104
 105         unsigned int    sdev_bflags; /* black/white flags as also found in
 106                                  * scsi_devinfo.[hc]. For now used only to
 107                                  * pass settings from slave_alloc to scsi
 108                                  * core. */
 109         unsigned writeable:1;
 110         unsigned removable:1;
 111         unsigned changed:1;     /* Data invalid due to media change */
 112         unsigned busy:1;        /* Used to prevent races */
 113         unsigned lockable:1;    /* Able to prevent media removal */
 114         unsigned locked:1;      /* Media removal disabled */
 115         unsigned borken:1;      /* Tell the Seagate driver to be
 116                                  * painfully slow on this device */
 117         unsigned disconnect:1;  /* can disconnect */
 118         unsigned soft_reset:1;  /* Uses soft reset option */
 119         unsigned sdtr:1;        /* Device supports SDTR messages */
 120         unsigned wdtr:1;        /* Device supports WDTR messages */
 121         unsigned ppr:1;         /* Device supports PPR messages */
 122         unsigned tagged_supported:1;    /* Supports SCSI-II tagged queuing */
 123         unsigned simple_tags:1; /* simple queue tag messages are enabled */
 124         unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
 125         unsigned was_reset:1;   /* There was a bus reset on the bus for
 126                                  * this device */
 127         unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
 128                                      * because we did a bus reset. */
 129         unsigned use_10_for_rw:1; /* first try 10-byte read / write */
 130         unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
 131         unsigned skip_ms_page_8:1;      /* do not use MODE SENSE page 0x08 */
 132         unsigned skip_ms_page_3f:1;     /* do not use MODE SENSE page 0x3f */
 133         unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
 134         unsigned no_start_on_add:1;     /* do not issue start on add */
 135         unsigned allow_restart:1; /* issue START_UNIT in error handler */
 136         unsigned manage_start_stop:1;   /* Let HLD (sd) manage start/stop */
 137         unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
 138         unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
 139         unsigned select_no_atn:1;
 140         unsigned fix_capacity:1;        /* READ_CAPACITY is too high by 1 */
 141         unsigned guess_capacity:1;      /* READ_CAPACITY might be too high by 1 */
 142         unsigned retry_hwerror:1;       /* Retry HARDWARE_ERROR */
 143         unsigned last_sector_bug:1;     /* do not use multisector accesses on
 144                                            SD_LAST_BUGGY_SECTORS */
 145
 146         DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
 147         struct list_head event_list;    /* asserted events */
 148         struct work_struct event_work;
 149
 150         unsigned int device_blocked;    /* Device returned QUEUE_FULL. */
 151
 152         unsigned int max_device_blocked; /* what device_blocked counts down from  */
 153 #define SCSI_DEFAULT_DEVICE_BLOCKED     3
 154
 155         atomic_t iorequest_cnt;
 156         atomic_t iodone_cnt;
 157         atomic_t ioerr_cnt;
 158
 159         int timeout;
 160
 161         struct device           sdev_gendev,
 162                                 sdev_dev;
 163
 164         struct execute_work     ew; /* used to get process context on put */
 165
 166         struct scsi_dh_data     *scsi_dh_data;
 167         enum scsi_device_state sdev_state;
 168         unsigned long           sdev_data[0];
 169 } __attribute__((aligned(sizeof(unsigned long))));
 170
 171 struct scsi_dh_devlist {
 172         char *vendor;
 173         char *model;
 174 };
 175
 176 struct scsi_device_handler {
 177         /* Used by the infrastructure */
 178         struct list_head list; /* list of scsi_device_handlers */
 179
 180         /* Filled by the hardware handler */
 181         struct module *module;
 182         const char *name;
 183         const struct scsi_dh_devlist *devlist;
 184         int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
 185         int (*attach)(struct scsi_device *);
 186         void (*detach)(struct scsi_device *);
 187         int (*activate)(struct scsi_device *);
 188         int (*prep_fn)(struct scsi_device *, struct request *);
 189 };
 190
 191 struct scsi_dh_data {
 192         struct scsi_device_handler *scsi_dh;
 193         char buf[0];
 194 };
 195
 196 #define to_scsi_device(d)       \
 197         container_of(d, struct scsi_device, sdev_gendev)
 198 #define class_to_sdev(d)        \
 199         container_of(d, struct scsi_device, sdev_dev)
 200 #define transport_class_to_sdev(class_dev) \
 201         to_scsi_device(class_dev->parent)
 202
 203 #define sdev_printk(prefix, sdev, fmt, a...)    \
 204         dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
 205
 206 #define scmd_printk(prefix, scmd, fmt, a...)                            \
 207         (scmd)->request->rq_disk ?                                      \
 208         sdev_printk(prefix, (scmd)->device, "[%s] " fmt,                \
 209                     (scmd)->request->rq_disk->disk_name, ##a) :         \
 210         sdev_printk(prefix, (scmd)->device, fmt, ##a)
 211
 212 enum scsi_target_state {
 213         STARGET_CREATED = 1,
 214         STARGET_RUNNING,
 215         STARGET_DEL,
 216 };
 217
 218 /*
 219  * scsi_target: representation of a scsi target, for now, this is only
 220  * used for single_lun devices. If no one has active IO to the target,
 221  * starget_sdev_user is NULL, else it points to the active sdev.
 222  */
 223 struct scsi_target {
 224         struct scsi_device      *starget_sdev_user;
 225         struct list_head        siblings;
 226         struct list_head        devices;
 227         struct device           dev;
 228         unsigned int            reap_ref; /* protected by the host lock */
 229         unsigned int            channel;
 230         unsigned int            id; /* target id ... replace
 231                                      * scsi_device.id eventually */
 232         unsigned int            create:1; /* signal that it needs to be added */
 233         unsigned int            single_lun:1;   /* Indicates we should only
 234                                                  * allow I/O to one of the luns
 235                                                  * for the device at a time. */
 236         unsigned int            pdt_1f_for_no_lun;      /* PDT = 0x1f */
 237                                                 /* means no lun present */
 238
 239         char                    scsi_level;
 240         struct execute_work     ew;
 241         enum scsi_target_state  state;
 242         void                    *hostdata; /* available to low-level driver */
 243         unsigned long           starget_data[0]; /* for the transport */
 244         /* starget_data must be the last element!!!! */
 245 } __attribute__((aligned(sizeof(unsigned long))));
 246
 247 #define to_scsi_target(d)       container_of(d, struct scsi_target, dev)
 248 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
 249 {
 250         return to_scsi_target(sdev->sdev_gendev.parent);
 251 }
 252 #define transport_class_to_starget(class_dev) \
 253         to_scsi_target(class_dev->parent)
 254
 255 #define starget_printk(prefix, starget, fmt, a...)      \
 256         dev_printk(prefix, &(starget)->dev, fmt, ##a)
 257
 258 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
 259                 uint, uint, uint, void *hostdata);
 260 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
 261                            uint target, uint lun);
 262 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
 263 extern void scsi_remove_device(struct scsi_device *);
 264 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
 265
 266 extern int scsi_device_get(struct scsi_device *);
 267 extern void scsi_device_put(struct scsi_device *);
 268 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
 269                                               uint, uint, uint);
 270 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
 271                                                 uint, uint, uint);
 272 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
 273                                                         uint);
 274 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
 275                                                           uint);
 276 extern void starget_for_each_device(struct scsi_target *, void *,
 277                      void (*fn)(struct scsi_device *, void *));
 278 extern void __starget_for_each_device(struct scsi_target *, void *,
 279                                       void (*fn)(struct scsi_device *,
 280                                                  void *));
 281
 282 /* only exposed to implement shost_for_each_device */
 283 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
 284                                                   struct scsi_device *);
 285
 286 /**
 287  * shost_for_each_device - iterate over all devices of a host
 288  * @sdev: the &struct scsi_device to use as a cursor
 289  * @shost: the &struct scsi_host to iterate over
 290  *
 291  * Iterator that returns each device attached to @shost.  This loop
 292  * takes a reference on each device and releases it at the end.  If
 293  * you break out of the loop, you must call scsi_device_put(sdev).
 294  */
 295 #define shost_for_each_device(sdev, shost) \
 296         for ((sdev) = __scsi_iterate_devices((shost), NULL); \
 297              (sdev); \
 298              (sdev) = __scsi_iterate_devices((shost), (sdev)))
 299
 300 /**
 301  * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
 302  * @sdev: the &struct scsi_device to use as a cursor
 303  * @shost: the &struct scsi_host to iterate over
 304  *
 305  * Iterator that returns each device attached to @shost.  It does _not_
 306  * take a reference on the scsi_device, so the whole loop must be
 307  * protected by shost->host_lock.
 308  *
 309  * Note: The only reason to use this is because you need to access the
 310  * device list in interrupt context.  Otherwise you really want to use
 311  * shost_for_each_device instead.
 312  */
 313 #define __shost_for_each_device(sdev, shost) \
 314         list_for_each_entry((sdev), &((shost)->__devices), siblings)
 315
 316 extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
 317 extern int scsi_track_queue_full(struct scsi_device *, int);
 318
 319 extern int scsi_set_medium_removal(struct scsi_device *, char);
 320
 321 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
 322                            unsigned char *buffer, int len, int timeout,
 323                            int retries, struct scsi_mode_data *data,
 324                            struct scsi_sense_hdr *);
 325 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
 326                             int modepage, unsigned char *buffer, int len,
 327                             int timeout, int retries,
 328                             struct scsi_mode_data *data,
 329                             struct scsi_sense_hdr *);
 330 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
 331                                 int retries, struct scsi_sense_hdr *sshdr);
 332 extern int scsi_device_set_state(struct scsi_device *sdev,
 333                                  enum scsi_device_state state);
 334 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
 335                                           gfp_t gfpflags);
 336 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
 337 extern void sdev_evt_send_simple(struct scsi_device *sdev,
 338                           enum scsi_device_event evt_type, gfp_t gfpflags);
 339 extern int scsi_device_quiesce(struct scsi_device *sdev);
 340 extern void scsi_device_resume(struct scsi_device *sdev);
 341 extern void scsi_target_quiesce(struct scsi_target *);
 342 extern void scsi_target_resume(struct scsi_target *);
 343 extern void scsi_scan_target(struct device *parent, unsigned int channel,
 344                              unsigned int id, unsigned int lun, int rescan);
 345 extern void scsi_target_reap(struct scsi_target *);
 346 extern void scsi_target_block(struct device *);
 347 extern void scsi_target_unblock(struct device *);
 348 extern void scsi_remove_target(struct device *);
 349 extern void int_to_scsilun(unsigned int, struct scsi_lun *);
 350 extern int scsilun_to_int(struct scsi_lun *);
 351 extern const char *scsi_device_state_name(enum scsi_device_state);
 352 extern int scsi_is_sdev_device(const struct device *);
 353 extern int scsi_is_target_device(const struct device *);
 354 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
 355                         int data_direction, void *buffer, unsigned bufflen,
 356                         unsigned char *sense, int timeout, int retries,
 357                         int flag);
 358 extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
 359                             int data_direction, void *buffer, unsigned bufflen,
 360                             struct scsi_sense_hdr *, int timeout, int retries);
 361 extern int scsi_execute_async(struct scsi_device *sdev,
 362                               const unsigned char *cmd, int cmd_len, int data_direction,
 363                               void *buffer, unsigned bufflen, int use_sg,
 364                               int timeout, int retries, void *privdata,
 365                               void (*done)(void *, char *, int, int),
 366                               gfp_t gfp);
 367
 368 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
 369 {
 370         return device_reprobe(&sdev->sdev_gendev);
 371 }
 372
 373 static inline unsigned int sdev_channel(struct scsi_device *sdev)
 374 {
 375         return sdev->channel;
 376 }
 377
 378 static inline unsigned int sdev_id(struct scsi_device *sdev)
 379 {
 380         return sdev->id;
 381 }
 382
 383 #define scmd_id(scmd) sdev_id((scmd)->device)
 384 #define scmd_channel(scmd) sdev_channel((scmd)->device)
 385
 386 static inline int scsi_device_online(struct scsi_device *sdev)
 387 {
 388         return sdev->sdev_state != SDEV_OFFLINE;
 389 }
 390
 391 /* accessor functions for the SCSI parameters */
 392 static inline int scsi_device_sync(struct scsi_device *sdev)
 393 {
 394         return sdev->sdtr;
 395 }
 396 static inline int scsi_device_wide(struct scsi_device *sdev)
 397 {
 398         return sdev->wdtr;
 399 }
 400 static inline int scsi_device_dt(struct scsi_device *sdev)
 401 {
 402         return sdev->ppr;
 403 }
 404 static inline int scsi_device_dt_only(struct scsi_device *sdev)
 405 {
 406         if (sdev->inquiry_len < 57)
 407                 return 0;
 408         return (sdev->inquiry[56] & 0x0c) == 0x04;
 409 }
 410 static inline int scsi_device_ius(struct scsi_device *sdev)
 411 {
 412         if (sdev->inquiry_len < 57)
 413                 return 0;
 414         return sdev->inquiry[56] & 0x01;
 415 }
 416 static inline int scsi_device_qas(struct scsi_device *sdev)
 417 {
 418         if (sdev->inquiry_len < 57)
 419                 return 0;
 420         return sdev->inquiry[56] & 0x02;
 421 }
 422 static inline int scsi_device_enclosure(struct scsi_device *sdev)
 423 {
 424         return sdev->inquiry[6] & (1<<6);
 425 }
 426
 427 static inline int scsi_device_protection(struct scsi_device *sdev)
 428 {
 429         return sdev->inquiry[5] & (1<<0);
 430 }
 431
 432 #define MODULE_ALIAS_SCSI_DEVICE(type) \
 433         MODULE_ALIAS("scsi:t-" __stringify(type) "*")
 434 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
 435
 436 #endif /* _SCSI_SCSI_DEVICE_H */