LXR linux/drivers/scsi/sd.h

   1#ifndef _SCSI_DISK_H
   2#define _SCSI_DISK_H
   3
   4#include <linux/rh_kabi.h>
   5
   6/*
   7 * More than enough for everybody ;)  The huge number of majors
   8 * is a leftover from 16bit dev_t days, we don't really need that
   9 * much numberspace.
  10 */
  11#define SD_MAJORS       16
  12
  13/*
  14 * Time out in seconds for disks and Magneto-opticals (which are slower).
  15 */
  16#define SD_TIMEOUT              (30 * HZ)
  17#define SD_MOD_TIMEOUT          (75 * HZ)
  18/*
  19 * Flush timeout is a multiplier over the standard device timeout which is
  20 * user modifiable via sysfs but initially set to SD_TIMEOUT
  21 */
  22#define SD_FLUSH_TIMEOUT_MULTIPLIER     2
  23#define SD_WRITE_SAME_TIMEOUT   (120 * HZ)
  24
  25/*
  26 * Number of allowed retries
  27 */
  28#define SD_MAX_RETRIES          5
  29#define SD_PASSTHROUGH_RETRIES  1
  30#define SD_MAX_MEDIUM_TIMEOUTS  2
  31
  32/*
  33 * Size of the initial data buffer for mode and read capacity data
  34 */
  35#define SD_BUF_SIZE             512
  36
  37/*
  38 * Number of sectors at the end of the device to avoid multi-sector
  39 * accesses to in the case of last_sector_bug
  40 */
  41#define SD_LAST_BUGGY_SECTORS   8
  42
  43enum {
  44        SD_EXT_CDB_SIZE = 32,   /* Extended CDB size */
  45        SD_MEMPOOL_SIZE = 2,    /* CDB pool size */
  46};
  47
  48enum {
  49        SD_DEF_XFER_BLOCKS = 0xffff,
  50        SD_MAX_XFER_BLOCKS = 0xffffffff,
  51        SD_MAX_WS10_BLOCKS = 0xffff,
  52        SD_MAX_WS16_BLOCKS = 0x7fffff,
  53};
  54
  55enum {
  56        SD_LBP_FULL = 0,        /* Full logical block provisioning */
  57        SD_LBP_UNMAP,           /* Use UNMAP command */
  58        SD_LBP_WS16,            /* Use WRITE SAME(16) with UNMAP bit */
  59        SD_LBP_WS10,            /* Use WRITE SAME(10) with UNMAP bit */
  60        SD_LBP_ZERO,            /* Use WRITE SAME(10) with zero payload */
  61        SD_LBP_DISABLE,         /* Discard disabled due to failed cmd */
  62};
  63
  64struct scsi_disk {
  65        struct scsi_driver *driver;     /* always &sd_template */
  66        struct scsi_device *device;
  67        struct device   dev;
  68        struct gendisk  *disk;
  69        atomic_t        openers;
  70        sector_t        capacity;       /* size in logical blocks */
  71        u32             max_ws_blocks;
  72        u32             max_unmap_blocks;
  73        u32             unmap_granularity;
  74        u32             unmap_alignment;
  75        u32             index;
  76        unsigned int    physical_block_size;
  77        unsigned int    max_medium_access_timeouts;
  78        unsigned int    medium_access_timed_out;
  79        u8              media_present;
  80        u8              write_prot;
  81        u8              protection_type;/* Data Integrity Field */
  82        u8              provisioning_mode;
  83        unsigned        ATO : 1;        /* state of disk ATO bit */
  84        unsigned        cache_override : 1; /* temp override of WCE,RCD */
  85        unsigned        WCE : 1;        /* state of disk WCE bit */
  86        unsigned        RCD : 1;        /* state of disk RCD bit, unused */
  87        unsigned        DPOFUA : 1;     /* state of disk DPOFUA bit */
  88        unsigned        first_scan : 1;
  89        unsigned        lbpme : 1;
  90        unsigned        lbprz : 1;
  91        unsigned        lbpu : 1;
  92        unsigned        lbpws : 1;
  93        unsigned        lbpws10 : 1;
  94        unsigned        lbpvpd : 1;
  95        unsigned        ws10 : 1;
  96        unsigned        ws16 : 1;
  97
  98        /* FOR RH USE ONLY
  99         *
 100         * The following padding has been inserted before ABI freeze to
 101         * allow extending the structure while preserving ABI.
 102         */
 103        u32             xcopy_reserved;
 104
 105        RH_KABI_USE(1, u32 max_xfer_blocks)
 106        RH_KABI_USE(2, u32 opt_xfer_blocks)
 107};
 108#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
 109
 110static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
 111{
 112        return container_of(disk->private_data, struct scsi_disk, driver);
 113}
 114
 115#define sd_printk(prefix, sdsk, fmt, a...)                              \
 116        (sdsk)->disk ?                                                  \
 117              sdev_prefix_printk(prefix, (sdsk)->device,                \
 118                                 (sdsk)->disk->disk_name, fmt, ##a) :   \
 119              sdev_printk(prefix, (sdsk)->device, fmt, ##a)
 120
 121#define sd_first_printk(prefix, sdsk, fmt, a...)                        \
 122        do {                                                            \
 123                if ((sdsk)->first_scan)                                 \
 124                        sd_printk(prefix, sdsk, fmt, ##a);              \
 125        } while (0)
 126
 127static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
 128{
 129        switch (scmd->cmnd[0]) {
 130        case READ_6:
 131        case READ_10:
 132        case READ_12:
 133        case READ_16:
 134        case SYNCHRONIZE_CACHE:
 135        case VERIFY:
 136        case VERIFY_12:
 137        case VERIFY_16:
 138        case WRITE_6:
 139        case WRITE_10:
 140        case WRITE_12:
 141        case WRITE_16:
 142        case WRITE_SAME:
 143        case WRITE_SAME_16:
 144        case UNMAP:
 145                return 1;
 146        case VARIABLE_LENGTH_CMD:
 147                switch (scmd->cmnd[9]) {
 148                case READ_32:
 149                case VERIFY_32:
 150                case WRITE_32:
 151                case WRITE_SAME_32:
 152                        return 1;
 153                }
 154        }
 155
 156        return 0;
 157}
 158
 159static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
 160{
 161        return blocks << (ilog2(sdev->sector_size) - 9);
 162}
 163
 164static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
 165{
 166        return blocks * sdev->sector_size;
 167}
 168
 169/*
 170 * A DIF-capable target device can be formatted with different
 171 * protection schemes.  Currently 0 through 3 are defined:
 172 *
 173 * Type 0 is regular (unprotected) I/O
 174 *
 175 * Type 1 defines the contents of the guard and reference tags
 176 *
 177 * Type 2 defines the contents of the guard and reference tags and
 178 * uses 32-byte commands to seed the latter
 179 *
 180 * Type 3 defines the contents of the guard tag only
 181 */
 182
 183enum sd_dif_target_protection_types {
 184        SD_DIF_TYPE0_PROTECTION = 0x0,
 185        SD_DIF_TYPE1_PROTECTION = 0x1,
 186        SD_DIF_TYPE2_PROTECTION = 0x2,
 187        SD_DIF_TYPE3_PROTECTION = 0x3,
 188};
 189
 190/*
 191 * Data Integrity Field tuple.
 192 */
 193struct sd_dif_tuple {
 194       __be16 guard_tag;        /* Checksum */
 195       __be16 app_tag;          /* Opaque storage */
 196       __be32 ref_tag;          /* Target LBA or indirect LBA */
 197};
 198
 199#ifdef CONFIG_BLK_DEV_INTEGRITY
 200
 201extern void sd_dif_config_host(struct scsi_disk *);
 202extern void sd_dif_prepare(struct request *rq, sector_t, unsigned int);
 203extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
 204
 205#else /* CONFIG_BLK_DEV_INTEGRITY */
 206
 207static inline void sd_dif_config_host(struct scsi_disk *disk)
 208{
 209}
 210static inline int sd_dif_prepare(struct request *rq, sector_t s, unsigned int a)
 211{
 212        return 0;
 213}
 214static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
 215{
 216}
 217
 218#endif /* CONFIG_BLK_DEV_INTEGRITY */
 219
 220#endif /* _SCSI_DISK_H */
 221