LCOV - code coverage report
Current view: top level - include/scsi - scsi_device.h (source / functions) Hit Total Coverage
Test: landlock.info Lines: 0 23 0.0 %
Date: 2021-04-22 12:43:58 Functions: 0 2 0.0 %

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

Generated by: LCOV version 1.14