LXR linux/include/scsi/scsi

   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
  11struct device;
  12struct request_queue;
  13struct scsi_cmnd;
  14struct scsi_lun;
  15struct scsi_sense_hdr;
  16
  17struct 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 */
  31enum 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
  53enum 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
  60struct 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
  69struct 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 skip_ms_page_8:1;      /* do not use MODE SENSE page 0x08 */
 139        unsigned skip_ms_page_3f:1;     /* do not use MODE SENSE page 0x3f */
 140        unsigned skip_vpd_pages:1;      /* do not read VPD pages */
 141        unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
 142        unsigned no_start_on_add:1;     /* do not issue start on add */
 143        unsigned allow_restart:1; /* issue START_UNIT in error handler */
 144        unsigned manage_start_stop:1;   /* Let HLD (sd) manage start/stop */
 145        unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
 146        unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
 147        unsigned select_no_atn:1;
 148        unsigned fix_capacity:1;        /* READ_CAPACITY is too high by 1 */
 149        unsigned guess_capacity:1;      /* READ_CAPACITY might be too high by 1 */
 150        unsigned retry_hwerror:1;       /* Retry HARDWARE_ERROR */
 151        unsigned last_sector_bug:1;     /* do not use multisector accesses on
 152                                           SD_LAST_BUGGY_SECTORS */
 153        unsigned no_read_disc_info:1;   /* Avoid READ_DISC_INFO cmds */
 154        unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
 155        unsigned try_rc_10_first:1;     /* Try READ_CAPACACITY_10 first */
 156        unsigned is_visible:1;  /* is the device visible in sysfs */
 157        unsigned can_power_off:1; /* Device supports runtime power off */
 158        unsigned wce_default_on:1;      /* Cache is ON by default */
 159
 160        DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
 161        struct list_head event_list;    /* asserted events */
 162        struct work_struct event_work;
 163
 164        unsigned int device_blocked;    /* Device returned QUEUE_FULL. */
 165
 166        unsigned int max_device_blocked; /* what device_blocked counts down from  */
 167#define SCSI_DEFAULT_DEVICE_BLOCKED     3
 168
 169        atomic_t iorequest_cnt;
 170        atomic_t iodone_cnt;
 171        atomic_t ioerr_cnt;
 172
 173        struct device           sdev_gendev,
 174                                sdev_dev;
 175
 176        struct execute_work     ew; /* used to get process context on put */
 177        struct work_struct      requeue_work;
 178
 179        struct scsi_dh_data     *scsi_dh_data;
 180        enum scsi_device_state sdev_state;
 181        unsigned long           sdev_data[0];
 182} __attribute__((aligned(sizeof(unsigned long))));
 183
 184struct scsi_dh_devlist {
 185        char *vendor;
 186        char *model;
 187};
 188
 189typedef void (*activate_complete)(void *, int);
 190struct scsi_device_handler {
 191        /* Used by the infrastructure */
 192        struct list_head list; /* list of scsi_device_handlers */
 193
 194        /* Filled by the hardware handler */
 195        struct module *module;
 196        const char *name;
 197        const struct scsi_dh_devlist *devlist;
 198        int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
 199        int (*attach)(struct scsi_device *);
 200        void (*detach)(struct scsi_device *);
 201        int (*activate)(struct scsi_device *, activate_complete, void *);
 202        int (*prep_fn)(struct scsi_device *, struct request *);
 203        int (*set_params)(struct scsi_device *, const char *);
 204        bool (*match)(struct scsi_device *);
 205};
 206
 207struct scsi_dh_data {
 208        struct scsi_device_handler *scsi_dh;
 209        struct scsi_device *sdev;
 210        struct kref kref;
 211        char buf[0];
 212};
 213
 214#define to_scsi_device(d)       \
 215        container_of(d, struct scsi_device, sdev_gendev)
 216#define class_to_sdev(d)        \
 217        container_of(d, struct scsi_device, sdev_dev)
 218#define transport_class_to_sdev(class_dev) \
 219        to_scsi_device(class_dev->parent)
 220
 221#define sdev_printk(prefix, sdev, fmt, a...)    \
 222        dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
 223
 224#define scmd_printk(prefix, scmd, fmt, a...)                            \
 225        (scmd)->request->rq_disk ?                                      \
 226        sdev_printk(prefix, (scmd)->device, "[%s] " fmt,                \
 227                    (scmd)->request->rq_disk->disk_name, ##a) :         \
 228        sdev_printk(prefix, (scmd)->device, fmt, ##a)
 229
 230enum scsi_target_state {
 231        STARGET_CREATED = 1,
 232        STARGET_RUNNING,
 233        STARGET_DEL,
 234};
 235
 236/*
 237 * scsi_target: representation of a scsi target, for now, this is only
 238 * used for single_lun devices. If no one has active IO to the target,
 239 * starget_sdev_user is NULL, else it points to the active sdev.
 240 */
 241struct scsi_target {
 242        struct scsi_device      *starget_sdev_user;
 243        struct list_head        siblings;
 244        struct list_head        devices;
 245        struct device           dev;
 246        unsigned int            reap_ref; /* protected by the host lock */
 247        unsigned int            channel;
 248        unsigned int            id; /* target id ... replace
 249                                     * scsi_device.id eventually */
 250        unsigned int            create:1; /* signal that it needs to be added */
 251        unsigned int            single_lun:1;   /* Indicates we should only
 252                                                 * allow I/O to one of the luns
 253                                                 * for the device at a time. */
 254        unsigned int            pdt_1f_for_no_lun:1;    /* PDT = 0x1f
 255                                                 * means no lun present. */
 256        unsigned int            no_report_luns:1;       /* Don't use
 257                                                 * REPORT LUNS for scanning. */
 258        /* commands actually active on LLD. protected by host lock. */
 259        unsigned int            target_busy;
 260        /*
 261         * LLDs should set this in the slave_alloc host template callout.
 262         * If set to zero then there is not limit.
 263         */
 264        unsigned int            can_queue;
 265        unsigned int            target_blocked;
 266        unsigned int            max_target_blocked;
 267#define SCSI_DEFAULT_TARGET_BLOCKED     3
 268
 269        char                    scsi_level;
 270        struct execute_work     ew;
 271        enum scsi_target_state  state;
 272        void                    *hostdata; /* available to low-level driver */
 273        unsigned long           starget_data[0]; /* for the transport */
 274        /* starget_data must be the last element!!!! */
 275} __attribute__((aligned(sizeof(unsigned long))));
 276
 277#define to_scsi_target(d)       container_of(d, struct scsi_target, dev)
 278static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
 279{
 280        return to_scsi_target(sdev->sdev_gendev.parent);
 281}
 282#define transport_class_to_starget(class_dev) \
 283        to_scsi_target(class_dev->parent)
 284
 285#define starget_printk(prefix, starget, fmt, a...)      \
 286        dev_printk(prefix, &(starget)->dev, fmt, ##a)
 287
 288extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
 289                uint, uint, uint, void *hostdata);
 290extern int scsi_add_device(struct Scsi_Host *host, uint channel,
 291                           uint target, uint lun);
 292extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
 293extern void scsi_remove_device(struct scsi_device *);
 294extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
 295
 296extern int scsi_device_get(struct scsi_device *);
 297extern void scsi_device_put(struct scsi_device *);
 298extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
 299                                              uint, uint, uint);
 300extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
 301                                                uint, uint, uint);
 302extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
 303                                                        uint);
 304extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
 305                                                          uint);
 306extern void starget_for_each_device(struct scsi_target *, void *,
 307                     void (*fn)(struct scsi_device *, void *));
 308extern void __starget_for_each_device(struct scsi_target *, void *,
 309                                      void (*fn)(struct scsi_device *,
 310                                                 void *));
 311
 312/* only exposed to implement shost_for_each_device */
 313extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
 314                                                  struct scsi_device *);
 315
 316/**
 317 * shost_for_each_device - iterate over all devices of a host
 318 * @sdev: the &struct scsi_device to use as a cursor
 319 * @shost: the &struct scsi_host to iterate over
 320 *
 321 * Iterator that returns each device attached to @shost.  This loop
 322 * takes a reference on each device and releases it at the end.  If
 323 * you break out of the loop, you must call scsi_device_put(sdev).
 324 */
 325#define shost_for_each_device(sdev, shost) \
 326        for ((sdev) = __scsi_iterate_devices((shost), NULL); \
 327             (sdev); \
 328             (sdev) = __scsi_iterate_devices((shost), (sdev)))
 329
 330/**
 331 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
 332 * @sdev: the &struct scsi_device to use as a cursor
 333 * @shost: the &struct scsi_host to iterate over
 334 *
 335 * Iterator that returns each device attached to @shost.  It does _not_
 336 * take a reference on the scsi_device, so the whole loop must be
 337 * protected by shost->host_lock.
 338 *
 339 * Note: The only reason to use this is because you need to access the
 340 * device list in interrupt context.  Otherwise you really want to use
 341 * shost_for_each_device instead.
 342 */
 343#define __shost_for_each_device(sdev, shost) \
 344        list_for_each_entry((sdev), &((shost)->__devices), siblings)
 345
 346extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
 347extern int scsi_track_queue_full(struct scsi_device *, int);
 348
 349extern int scsi_set_medium_removal(struct scsi_device *, char);
 350
 351extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
 352                           unsigned char *buffer, int len, int timeout,
 353                           int retries, struct scsi_mode_data *data,
 354                           struct scsi_sense_hdr *);
 355extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
 356                            int modepage, unsigned char *buffer, int len,
 357                            int timeout, int retries,
 358                            struct scsi_mode_data *data,
 359                            struct scsi_sense_hdr *);
 360extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
 361                                int retries, struct scsi_sense_hdr *sshdr);
 362extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
 363                             int buf_len);
 364extern int scsi_device_set_state(struct scsi_device *sdev,
 365                                 enum scsi_device_state state);
 366extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
 367                                          gfp_t gfpflags);
 368extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
 369extern void sdev_evt_send_simple(struct scsi_device *sdev,
 370                          enum scsi_device_event evt_type, gfp_t gfpflags);
 371extern int scsi_device_quiesce(struct scsi_device *sdev);
 372extern void scsi_device_resume(struct scsi_device *sdev);
 373extern void scsi_target_quiesce(struct scsi_target *);
 374extern void scsi_target_resume(struct scsi_target *);
 375extern void scsi_scan_target(struct device *parent, unsigned int channel,
 376                             unsigned int id, unsigned int lun, int rescan);
 377extern void scsi_target_reap(struct scsi_target *);
 378extern void scsi_target_block(struct device *);
 379extern void scsi_target_unblock(struct device *, enum scsi_device_state);
 380extern void scsi_remove_target(struct device *);
 381extern void int_to_scsilun(unsigned int, struct scsi_lun *);
 382extern int scsilun_to_int(struct scsi_lun *);
 383extern const char *scsi_device_state_name(enum scsi_device_state);
 384extern int scsi_is_sdev_device(const struct device *);
 385extern int scsi_is_target_device(const struct device *);
 386extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
 387                        int data_direction, void *buffer, unsigned bufflen,
 388                        unsigned char *sense, int timeout, int retries,
 389                        int flag, int *resid);
 390extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
 391                            int data_direction, void *buffer, unsigned bufflen,
 392                            struct scsi_sense_hdr *, int timeout, int retries,
 393                            int *resid);
 394
 395#ifdef CONFIG_PM_RUNTIME
 396extern int scsi_autopm_get_device(struct scsi_device *);
 397extern void scsi_autopm_put_device(struct scsi_device *);
 398#else
 399static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
 400static inline void scsi_autopm_put_device(struct scsi_device *d) {}
 401#endif /* CONFIG_PM_RUNTIME */
 402
 403static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
 404{
 405        return device_reprobe(&sdev->sdev_gendev);
 406}
 407
 408static inline unsigned int sdev_channel(struct scsi_device *sdev)
 409{
 410        return sdev->channel;
 411}
 412
 413static inline unsigned int sdev_id(struct scsi_device *sdev)
 414{
 415        return sdev->id;
 416}
 417
 418#define scmd_id(scmd) sdev_id((scmd)->device)
 419#define scmd_channel(scmd) sdev_channel((scmd)->device)
 420
 421/*
 422 * checks for positions of the SCSI state machine
 423 */
 424static inline int scsi_device_online(struct scsi_device *sdev)
 425{
 426        return (sdev->sdev_state != SDEV_OFFLINE &&
 427                sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
 428                sdev->sdev_state != SDEV_DEL);
 429}
 430static inline int scsi_device_blocked(struct scsi_device *sdev)
 431{
 432        return sdev->sdev_state == SDEV_BLOCK ||
 433                sdev->sdev_state == SDEV_CREATED_BLOCK;
 434}
 435static inline int scsi_device_created(struct scsi_device *sdev)
 436{
 437        return sdev->sdev_state == SDEV_CREATED ||
 438                sdev->sdev_state == SDEV_CREATED_BLOCK;
 439}
 440
 441/* accessor functions for the SCSI parameters */
 442static inline int scsi_device_sync(struct scsi_device *sdev)
 443{
 444        return sdev->sdtr;
 445}
 446static inline int scsi_device_wide(struct scsi_device *sdev)
 447{
 448        return sdev->wdtr;
 449}
 450static inline int scsi_device_dt(struct scsi_device *sdev)
 451{
 452        return sdev->ppr;
 453}
 454static inline int scsi_device_dt_only(struct scsi_device *sdev)
 455{
 456        if (sdev->inquiry_len < 57)
 457                return 0;
 458        return (sdev->inquiry[56] & 0x0c) == 0x04;
 459}
 460static inline int scsi_device_ius(struct scsi_device *sdev)
 461{
 462        if (sdev->inquiry_len < 57)
 463                return 0;
 464        return sdev->inquiry[56] & 0x01;
 465}
 466static inline int scsi_device_qas(struct scsi_device *sdev)
 467{
 468        if (sdev->inquiry_len < 57)
 469                return 0;
 470        return sdev->inquiry[56] & 0x02;
 471}
 472static inline int scsi_device_enclosure(struct scsi_device *sdev)
 473{
 474        return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
 475}
 476
 477static inline int scsi_device_protection(struct scsi_device *sdev)
 478{
 479        return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
 480}
 481
 482static inline int scsi_device_tpgs(struct scsi_device *sdev)
 483{
 484        return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
 485}
 486
 487#define MODULE_ALIAS_SCSI_DEVICE(type) \
 488        MODULE_ALIAS("scsi:t-" __stringify(type) "*")
 489#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
 490
 491#endif /* _SCSI_SCSI_DEVICE_H */
 492