include/scsi/scsi_device.h

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