drivers/scsi/sd.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _SCSI_DISK_H
   3 #define _SCSI_DISK_H
   4
   5 /*
   6  * More than enough for everybody ;)  The huge number of majors
   7  * is a leftover from 16bit dev_t days, we don't really need that
   8  * much numberspace.
   9  */
  10 #define SD_MAJORS       16
  11
  12 /*
  13  * Time out in seconds for disks and Magneto-opticals (which are slower).
  14  */
  15 #define SD_TIMEOUT              (30 * HZ)
  16 #define SD_MOD_TIMEOUT          (75 * HZ)
  17 /*
  18  * Flush timeout is a multiplier over the standard device timeout which is
  19  * user modifiable via sysfs but initially set to SD_TIMEOUT
  20  */
  21 #define SD_FLUSH_TIMEOUT_MULTIPLIER     2
  22 #define SD_WRITE_SAME_TIMEOUT   (120 * HZ)
  23
  24 /*
  25  * Number of allowed retries
  26  */
  27 #define SD_MAX_RETRIES          5
  28 #define SD_PASSTHROUGH_RETRIES  1
  29 #define SD_MAX_MEDIUM_TIMEOUTS  2
  30
  31 /*
  32  * Size of the initial data buffer for mode and read capacity data
  33  */
  34 #define SD_BUF_SIZE             512
  35
  36 /*
  37  * Number of sectors at the end of the device to avoid multi-sector
  38  * accesses to in the case of last_sector_bug
  39  */
  40 #define SD_LAST_BUGGY_SECTORS   8
  41
  42 enum {
  43         SD_EXT_CDB_SIZE = 32,   /* Extended CDB size */
  44         SD_MEMPOOL_SIZE = 2,    /* CDB pool size */
  45 };
  46
  47 enum {
  48         SD_DEF_XFER_BLOCKS = 0xffff,
  49         SD_MAX_XFER_BLOCKS = 0xffffffff,
  50         SD_MAX_WS10_BLOCKS = 0xffff,
  51         SD_MAX_WS16_BLOCKS = 0x7fffff,
  52 };
  53
  54 enum {
  55         SD_LBP_FULL = 0,        /* Full logical block provisioning */
  56         SD_LBP_UNMAP,           /* Use UNMAP command */
  57         SD_LBP_WS16,            /* Use WRITE SAME(16) with UNMAP bit */
  58         SD_LBP_WS10,            /* Use WRITE SAME(10) with UNMAP bit */
  59         SD_LBP_ZERO,            /* Use WRITE SAME(10) with zero payload */
  60         SD_LBP_DISABLE,         /* Discard disabled due to failed cmd */
  61 };
  62
  63 enum {
  64         SD_ZERO_WRITE = 0,      /* Use WRITE(10/16) command */
  65         SD_ZERO_WS,             /* Use WRITE SAME(10/16) command */
  66         SD_ZERO_WS16_UNMAP,     /* Use WRITE SAME(16) with UNMAP */
  67         SD_ZERO_WS10_UNMAP,     /* Use WRITE SAME(10) with UNMAP */
  68 };
  69
  70 struct scsi_disk {
  71         struct scsi_driver *driver;     /* always &sd_template */
  72         struct scsi_device *device;
  73         struct device   dev;
  74         struct gendisk  *disk;
  75         struct opal_dev *opal_dev;
  76 #ifdef CONFIG_BLK_DEV_ZONED
  77         unsigned int    nr_zones;
  78         unsigned int    zone_blocks;
  79         unsigned int    zone_shift;
  80         unsigned long   *zones_wlock;
  81         unsigned int    zones_optimal_open;
  82         unsigned int    zones_optimal_nonseq;
  83         unsigned int    zones_max_open;
  84 #endif
  85         atomic_t        openers;
  86         sector_t        capacity;       /* size in logical blocks */
  87         u32             max_xfer_blocks;
  88         u32             opt_xfer_blocks;
  89         u32             max_ws_blocks;
  90         u32             max_unmap_blocks;
  91         u32             unmap_granularity;
  92         u32             unmap_alignment;
  93         u32             index;
  94         unsigned int    physical_block_size;
  95         unsigned int    max_medium_access_timeouts;
  96         unsigned int    medium_access_timed_out;
  97         u8              media_present;
  98         u8              write_prot;
  99         u8              protection_type;/* Data Integrity Field */
 100         u8              provisioning_mode;
 101         u8              zeroing_mode;
 102         unsigned        ATO : 1;        /* state of disk ATO bit */
 103         unsigned        cache_override : 1; /* temp override of WCE,RCD */
 104         unsigned        WCE : 1;        /* state of disk WCE bit */
 105         unsigned        RCD : 1;        /* state of disk RCD bit, unused */
 106         unsigned        DPOFUA : 1;     /* state of disk DPOFUA bit */
 107         unsigned        first_scan : 1;
 108         unsigned        lbpme : 1;
 109         unsigned        lbprz : 1;
 110         unsigned        lbpu : 1;
 111         unsigned        lbpws : 1;
 112         unsigned        lbpws10 : 1;
 113         unsigned        lbpvpd : 1;
 114         unsigned        ws10 : 1;
 115         unsigned        ws16 : 1;
 116         unsigned        rc_basis: 2;
 117         unsigned        zoned: 2;
 118         unsigned        urswrz : 1;
 119         unsigned        security : 1;
 120         unsigned        ignore_medium_access_errors : 1;
 121 };
 122 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
 123
 124 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
 125 {
 126         return container_of(disk->private_data, struct scsi_disk, driver);
 127 }
 128
 129 #define sd_printk(prefix, sdsk, fmt, a...)                              \
 130         (sdsk)->disk ?                                                  \
 131               sdev_prefix_printk(prefix, (sdsk)->device,                \
 132                                  (sdsk)->disk->disk_name, fmt, ##a) :   \
 133               sdev_printk(prefix, (sdsk)->device, fmt, ##a)
 134
 135 #define sd_first_printk(prefix, sdsk, fmt, a...)                        \
 136         do {                                                            \
 137                 if ((sdkp)->first_scan)                                 \
 138                         sd_printk(prefix, sdsk, fmt, ##a);              \
 139         } while (0)
 140
 141 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
 142 {
 143         switch (scmd->cmnd[0]) {
 144         case READ_6:
 145         case READ_10:
 146         case READ_12:
 147         case READ_16:
 148         case SYNCHRONIZE_CACHE:
 149         case VERIFY:
 150         case VERIFY_12:
 151         case VERIFY_16:
 152         case WRITE_6:
 153         case WRITE_10:
 154         case WRITE_12:
 155         case WRITE_16:
 156         case WRITE_SAME:
 157         case WRITE_SAME_16:
 158         case UNMAP:
 159                 return 1;
 160         case VARIABLE_LENGTH_CMD:
 161                 switch (scmd->cmnd[9]) {
 162                 case READ_32:
 163                 case VERIFY_32:
 164                 case WRITE_32:
 165                 case WRITE_SAME_32:
 166                         return 1;
 167                 }
 168         }
 169
 170         return 0;
 171 }
 172
 173 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
 174 {
 175         return blocks << (ilog2(sdev->sector_size) - 9);
 176 }
 177
 178 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
 179 {
 180         return blocks * sdev->sector_size;
 181 }
 182
 183 static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
 184 {
 185         return bytes >> ilog2(sdev->sector_size);
 186 }
 187
 188 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
 189 {
 190         return sector >> (ilog2(sdev->sector_size) - 9);
 191 }
 192
 193 /*
 194  * Look up the DIX operation based on whether the command is read or
 195  * write and whether dix and dif are enabled.
 196  */
 197 static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
 198 {
 199         /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
 200         const unsigned int ops[] = {    /* wrt dix dif */
 201                 SCSI_PROT_NORMAL,       /*  0   0   0  */
 202                 SCSI_PROT_READ_STRIP,   /*  0   0   1  */
 203                 SCSI_PROT_READ_INSERT,  /*  0   1   0  */
 204                 SCSI_PROT_READ_PASS,    /*  0   1   1  */
 205                 SCSI_PROT_NORMAL,       /*  1   0   0  */
 206                 SCSI_PROT_WRITE_INSERT, /*  1   0   1  */
 207                 SCSI_PROT_WRITE_STRIP,  /*  1   1   0  */
 208                 SCSI_PROT_WRITE_PASS,   /*  1   1   1  */
 209         };
 210
 211         return ops[write << 2 | dix << 1 | dif];
 212 }
 213
 214 /*
 215  * Returns a mask of the protection flags that are valid for a given DIX
 216  * operation.
 217  */
 218 static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
 219 {
 220         const unsigned int flag_mask[] = {
 221                 [SCSI_PROT_NORMAL]              = 0,
 222
 223                 [SCSI_PROT_READ_STRIP]          = SCSI_PROT_TRANSFER_PI |
 224                                                   SCSI_PROT_GUARD_CHECK |
 225                                                   SCSI_PROT_REF_CHECK |
 226                                                   SCSI_PROT_REF_INCREMENT,
 227
 228                 [SCSI_PROT_READ_INSERT]         = SCSI_PROT_REF_INCREMENT |
 229                                                   SCSI_PROT_IP_CHECKSUM,
 230
 231                 [SCSI_PROT_READ_PASS]           = SCSI_PROT_TRANSFER_PI |
 232                                                   SCSI_PROT_GUARD_CHECK |
 233                                                   SCSI_PROT_REF_CHECK |
 234                                                   SCSI_PROT_REF_INCREMENT |
 235                                                   SCSI_PROT_IP_CHECKSUM,
 236
 237                 [SCSI_PROT_WRITE_INSERT]        = SCSI_PROT_TRANSFER_PI |
 238                                                   SCSI_PROT_REF_INCREMENT,
 239
 240                 [SCSI_PROT_WRITE_STRIP]         = SCSI_PROT_GUARD_CHECK |
 241                                                   SCSI_PROT_REF_CHECK |
 242                                                   SCSI_PROT_REF_INCREMENT |
 243                                                   SCSI_PROT_IP_CHECKSUM,
 244
 245                 [SCSI_PROT_WRITE_PASS]          = SCSI_PROT_TRANSFER_PI |
 246                                                   SCSI_PROT_GUARD_CHECK |
 247                                                   SCSI_PROT_REF_CHECK |
 248                                                   SCSI_PROT_REF_INCREMENT |
 249                                                   SCSI_PROT_IP_CHECKSUM,
 250         };
 251
 252         return flag_mask[prot_op];
 253 }
 254
 255 #ifdef CONFIG_BLK_DEV_INTEGRITY
 256
 257 extern void sd_dif_config_host(struct scsi_disk *);
 258 extern void sd_dif_prepare(struct scsi_cmnd *scmd);
 259 extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
 260
 261 #else /* CONFIG_BLK_DEV_INTEGRITY */
 262
 263 static inline void sd_dif_config_host(struct scsi_disk *disk)
 264 {
 265 }
 266 static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
 267 {
 268         return 0;
 269 }
 270 static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
 271 {
 272 }
 273
 274 #endif /* CONFIG_BLK_DEV_INTEGRITY */
 275
 276 static inline int sd_is_zoned(struct scsi_disk *sdkp)
 277 {
 278         return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
 279 }
 280
 281 #ifdef CONFIG_BLK_DEV_ZONED
 282
 283 extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
 284 extern void sd_zbc_remove(struct scsi_disk *sdkp);
 285 extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
 286 extern int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd);
 287 extern void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd);
 288 extern int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd);
 289 extern int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd);
 290 extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
 291                             struct scsi_sense_hdr *sshdr);
 292
 293 #else /* CONFIG_BLK_DEV_ZONED */
 294
 295 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
 296                                     unsigned char *buf)
 297 {
 298         return 0;
 299 }
 300
 301 static inline void sd_zbc_remove(struct scsi_disk *sdkp) {}
 302
 303 static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {}
 304
 305 static inline int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd)
 306 {
 307         /* Let the drive fail requests */
 308         return BLKPREP_OK;
 309 }
 310
 311 static inline void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd) {}
 312
 313 static inline int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd)
 314 {
 315         return BLKPREP_INVALID;
 316 }
 317
 318 static inline int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd)
 319 {
 320         return BLKPREP_INVALID;
 321 }
 322
 323 static inline void sd_zbc_complete(struct scsi_cmnd *cmd,
 324                                    unsigned int good_bytes,
 325                                    struct scsi_sense_hdr *sshdr) {}
 326
 327 #endif /* CONFIG_BLK_DEV_ZONED */
 328
 329 #endif /* _SCSI_DISK_H */