drivers/block/mtip32xx/mtip32xx.h

   1 /*
   2  * mtip32xx.h - Header file for the P320 SSD Block Driver
   3  *   Copyright (C) 2011 Micron Technology, Inc.
   4  *
   5  * Portions of this code were derived from works subjected to the
   6  * following copyright:
   7  *    Copyright (C) 2009 Integrated Device Technology, Inc.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  */
  20
  21 #ifndef __MTIP32XX_H__
  22 #define __MTIP32XX_H__
  23
  24 #include <linux/spinlock.h>
  25 #include <linux/rwsem.h>
  26 #include <linux/ata.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/genhd.h>
  29
  30 /* Offset of Subsystem Device ID in pci confoguration space */
  31 #define PCI_SUBSYSTEM_DEVICEID  0x2E
  32
  33 /* offset of Device Control register in PCIe extended capabilites space */
  34 #define PCIE_CONFIG_EXT_DEVICE_CONTROL_OFFSET   0x48
  35
  36 /* check for erase mode support during secure erase */
  37 #define MTIP_SEC_ERASE_MODE     0x2
  38
  39 /* # of times to retry timed out/failed IOs */
  40 #define MTIP_MAX_RETRIES        2
  41
  42 /* Various timeout values in ms */
  43 #define MTIP_NCQ_CMD_TIMEOUT_MS      15000
  44 #define MTIP_IOCTL_CMD_TIMEOUT_MS    5000
  45 #define MTIP_INT_CMD_TIMEOUT_MS      5000
  46 #define MTIP_QUIESCE_IO_TIMEOUT_MS   (MTIP_NCQ_CMD_TIMEOUT_MS * \
  47                                      (MTIP_MAX_RETRIES + 1))
  48
  49 /* check for timeouts every 500ms */
  50 #define MTIP_TIMEOUT_CHECK_PERIOD       500
  51
  52 /* ftl rebuild */
  53 #define MTIP_FTL_REBUILD_OFFSET         142
  54 #define MTIP_FTL_REBUILD_MAGIC          0xED51
  55 #define MTIP_FTL_REBUILD_TIMEOUT_MS     2400000
  56
  57 /* unaligned IO handling */
  58 #define MTIP_MAX_UNALIGNED_SLOTS        2
  59
  60 /* Macro to extract the tag bit number from a tag value. */
  61 #define MTIP_TAG_BIT(tag)       (tag & 0x1F)
  62
  63 /*
  64  * Macro to extract the tag index from a tag value. The index
  65  * is used to access the correct s_active/Command Issue register based
  66  * on the tag value.
  67  */
  68 #define MTIP_TAG_INDEX(tag)     (tag >> 5)
  69
  70 /*
  71  * Maximum number of scatter gather entries
  72  * a single command may have.
  73  */
  74 #define MTIP_MAX_SG             504
  75
  76 /*
  77  * Maximum number of slot groups (Command Issue & s_active registers)
  78  * NOTE: This is the driver maximum; check dd->slot_groups for actual value.
  79  */
  80 #define MTIP_MAX_SLOT_GROUPS    8
  81
  82 /* Internal command tag. */
  83 #define MTIP_TAG_INTERNAL       0
  84
  85 /* Micron Vendor ID & P320x SSD Device ID */
  86 #define PCI_VENDOR_ID_MICRON    0x1344
  87 #define P320H_DEVICE_ID         0x5150
  88 #define P320M_DEVICE_ID         0x5151
  89 #define P320S_DEVICE_ID         0x5152
  90 #define P325M_DEVICE_ID         0x5153
  91 #define P420H_DEVICE_ID         0x5160
  92 #define P420M_DEVICE_ID         0x5161
  93 #define P425M_DEVICE_ID         0x5163
  94
  95 /* Driver name and version strings */
  96 #define MTIP_DRV_NAME           "mtip32xx"
  97 #define MTIP_DRV_VERSION        "1.3.1"
  98
  99 /* Maximum number of minor device numbers per device. */
 100 #define MTIP_MAX_MINORS         16
 101
 102 /* Maximum number of supported command slots. */
 103 #define MTIP_MAX_COMMAND_SLOTS  (MTIP_MAX_SLOT_GROUPS * 32)
 104
 105 /*
 106  * Per-tag bitfield size in longs.
 107  * Linux bit manipulation functions
 108  * (i.e. test_and_set_bit, find_next_zero_bit)
 109  * manipulate memory in longs, so we try to make the math work.
 110  * take the slot groups and find the number of longs, rounding up.
 111  * Careful! i386 and x86_64 use different size longs!
 112  */
 113 #define U32_PER_LONG    (sizeof(long) / sizeof(u32))
 114 #define SLOTBITS_IN_LONGS ((MTIP_MAX_SLOT_GROUPS + \
 115                                         (U32_PER_LONG-1))/U32_PER_LONG)
 116
 117 /* BAR number used to access the HBA registers. */
 118 #define MTIP_ABAR               5
 119
 120 #ifdef DEBUG
 121  #define dbg_printk(format, arg...)     \
 122         printk(pr_fmt(format), ##arg);
 123 #else
 124  #define dbg_printk(format, arg...)
 125 #endif
 126
 127 #define MTIP_DFS_MAX_BUF_SIZE 1024
 128
 129 enum {
 130         /* below are bit numbers in 'flags' defined in mtip_port */
 131         MTIP_PF_IC_ACTIVE_BIT       = 0, /* pio/ioctl */
 132         MTIP_PF_EH_ACTIVE_BIT       = 1, /* error handling */
 133         MTIP_PF_SE_ACTIVE_BIT       = 2, /* secure erase */
 134         MTIP_PF_DM_ACTIVE_BIT       = 3, /* download microcde */
 135         MTIP_PF_TO_ACTIVE_BIT       = 9, /* timeout handling */
 136         MTIP_PF_PAUSE_IO      = ((1 << MTIP_PF_IC_ACTIVE_BIT) |
 137                                 (1 << MTIP_PF_EH_ACTIVE_BIT) |
 138                                 (1 << MTIP_PF_SE_ACTIVE_BIT) |
 139                                 (1 << MTIP_PF_DM_ACTIVE_BIT) |
 140                                 (1 << MTIP_PF_TO_ACTIVE_BIT)),
 141         MTIP_PF_HOST_CAP_64         = 10, /* cache HOST_CAP_64 */
 142
 143         MTIP_PF_SVC_THD_ACTIVE_BIT  = 4,
 144         MTIP_PF_ISSUE_CMDS_BIT      = 5,
 145         MTIP_PF_REBUILD_BIT         = 6,
 146         MTIP_PF_SVC_THD_STOP_BIT    = 8,
 147
 148         MTIP_PF_SVC_THD_WORK    = ((1 << MTIP_PF_EH_ACTIVE_BIT) |
 149                                   (1 << MTIP_PF_ISSUE_CMDS_BIT) |
 150                                   (1 << MTIP_PF_REBUILD_BIT) |
 151                                   (1 << MTIP_PF_SVC_THD_STOP_BIT) |
 152                                   (1 << MTIP_PF_TO_ACTIVE_BIT)),
 153
 154         /* below are bit numbers in 'dd_flag' defined in driver_data */
 155         MTIP_DDF_SEC_LOCK_BIT       = 0,
 156         MTIP_DDF_REMOVE_PENDING_BIT = 1,
 157         MTIP_DDF_OVER_TEMP_BIT      = 2,
 158         MTIP_DDF_WRITE_PROTECT_BIT  = 3,
 159         MTIP_DDF_CLEANUP_BIT        = 5,
 160         MTIP_DDF_RESUME_BIT         = 6,
 161         MTIP_DDF_INIT_DONE_BIT      = 7,
 162         MTIP_DDF_REBUILD_FAILED_BIT = 8,
 163         MTIP_DDF_REMOVAL_BIT        = 9,
 164
 165         MTIP_DDF_STOP_IO      = ((1 << MTIP_DDF_REMOVE_PENDING_BIT) |
 166                                 (1 << MTIP_DDF_SEC_LOCK_BIT) |
 167                                 (1 << MTIP_DDF_OVER_TEMP_BIT) |
 168                                 (1 << MTIP_DDF_WRITE_PROTECT_BIT) |
 169                                 (1 << MTIP_DDF_REBUILD_FAILED_BIT)),
 170
 171 };
 172
 173 struct smart_attr {
 174         u8 attr_id;
 175         __le16 flags;
 176         u8 cur;
 177         u8 worst;
 178         __le32 data;
 179         u8 res[3];
 180 } __packed;
 181
 182 struct mtip_work {
 183         struct work_struct work;
 184         void *port;
 185         int cpu_binding;
 186         u32 completed;
 187 } ____cacheline_aligned_in_smp;
 188
 189 #define DEFINE_HANDLER(group)                                  \
 190         void mtip_workq_sdbf##group(struct work_struct *work)       \
 191         {                                                      \
 192                 struct mtip_work *w = (struct mtip_work *) work;         \
 193                 mtip_workq_sdbfx(w->port, group, w->completed);     \
 194         }
 195
 196 /* Register Frame Information Structure (FIS), host to device. */
 197 struct host_to_dev_fis {
 198         /*
 199          * FIS type.
 200          * - 27h Register FIS, host to device.
 201          * - 34h Register FIS, device to host.
 202          * - 39h DMA Activate FIS, device to host.
 203          * - 41h DMA Setup FIS, bi-directional.
 204          * - 46h Data FIS, bi-directional.
 205          * - 58h BIST Activate FIS, bi-directional.
 206          * - 5Fh PIO Setup FIS, device to host.
 207          * - A1h Set Device Bits FIS, device to host.
 208          */
 209         unsigned char type;
 210         unsigned char opts;
 211         unsigned char command;
 212         unsigned char features;
 213
 214         union {
 215                 unsigned char lba_low;
 216                 unsigned char sector;
 217         };
 218         union {
 219                 unsigned char lba_mid;
 220                 unsigned char cyl_low;
 221         };
 222         union {
 223                 unsigned char lba_hi;
 224                 unsigned char cyl_hi;
 225         };
 226         union {
 227                 unsigned char device;
 228                 unsigned char head;
 229         };
 230
 231         union {
 232                 unsigned char lba_low_ex;
 233                 unsigned char sector_ex;
 234         };
 235         union {
 236                 unsigned char lba_mid_ex;
 237                 unsigned char cyl_low_ex;
 238         };
 239         union {
 240                 unsigned char lba_hi_ex;
 241                 unsigned char cyl_hi_ex;
 242         };
 243         unsigned char features_ex;
 244
 245         unsigned char sect_count;
 246         unsigned char sect_cnt_ex;
 247         unsigned char res2;
 248         unsigned char control;
 249
 250         unsigned int res3;
 251 };
 252
 253 /* Command header structure. */
 254 struct mtip_cmd_hdr {
 255         /*
 256          * Command options.
 257          * - Bits 31:16 Number of PRD entries.
 258          * - Bits 15:8 Unused in this implementation.
 259          * - Bit 7 Prefetch bit, informs the drive to prefetch PRD entries.
 260          * - Bit 6 Write bit, should be set when writing data to the device.
 261          * - Bit 5 Unused in this implementation.
 262          * - Bits 4:0 Length of the command FIS in DWords (DWord = 4 bytes).
 263          */
 264         __le32 opts;
 265         /* This field is unsed when using NCQ. */
 266         union {
 267                 __le32 byte_count;
 268                 __le32 status;
 269         };
 270         /*
 271          * Lower 32 bits of the command table address associated with this
 272          * header. The command table addresses must be 128 byte aligned.
 273          */
 274         __le32 ctba;
 275         /*
 276          * If 64 bit addressing is used this field is the upper 32 bits
 277          * of the command table address associated with this command.
 278          */
 279         __le32 ctbau;
 280         /* Reserved and unused. */
 281         u32 res[4];
 282 };
 283
 284 /* Command scatter gather structure (PRD). */
 285 struct mtip_cmd_sg {
 286         /*
 287          * Low 32 bits of the data buffer address. For P320 this
 288          * address must be 8 byte aligned signified by bits 2:0 being
 289          * set to 0.
 290          */
 291         __le32 dba;
 292         /*
 293          * When 64 bit addressing is used this field is the upper
 294          * 32 bits of the data buffer address.
 295          */
 296         __le32 dba_upper;
 297         /* Unused. */
 298         __le32 reserved;
 299         /*
 300          * Bit 31: interrupt when this data block has been transferred.
 301          * Bits 30..22: reserved
 302          * Bits 21..0: byte count (minus 1).  For P320 the byte count must be
 303          * 8 byte aligned signified by bits 2:0 being set to 1.
 304          */
 305         __le32 info;
 306 };
 307 struct mtip_port;
 308
 309 struct mtip_int_cmd;
 310
 311 /* Structure used to describe a command. */
 312 struct mtip_cmd {
 313         void *command; /* ptr to command table entry */
 314
 315         dma_addr_t command_dma; /* corresponding physical address */
 316
 317         int scatter_ents; /* Number of scatter list entries used */
 318
 319         int unaligned; /* command is unaligned on 4k boundary */
 320
 321         union {
 322                 struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */
 323                 struct mtip_int_cmd *icmd;
 324         };
 325
 326         int retries; /* The number of retries left for this command. */
 327
 328         int direction; /* Data transfer direction */
 329         blk_status_t status;
 330 };
 331
 332 /* Structure used to describe a port. */
 333 struct mtip_port {
 334         /* Pointer back to the driver data for this port. */
 335         struct driver_data *dd;
 336         /*
 337          * Used to determine if the data pointed to by the
 338          * identify field is valid.
 339          */
 340         unsigned long identify_valid;
 341         /* Base address of the memory mapped IO for the port. */
 342         void __iomem *mmio;
 343         /* Array of pointers to the memory mapped s_active registers. */
 344         void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
 345         /* Array of pointers to the memory mapped completed registers. */
 346         void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
 347         /* Array of pointers to the memory mapped Command Issue registers. */
 348         void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
 349         /*
 350          * Pointer to the beginning of the command header memory as used
 351          * by the driver.
 352          */
 353         void *command_list;
 354         /*
 355          * Pointer to the beginning of the command header memory as used
 356          * by the DMA.
 357          */
 358         dma_addr_t command_list_dma;
 359         /*
 360          * Pointer to the beginning of the RX FIS memory as used
 361          * by the driver.
 362          */
 363         void *rxfis;
 364         /*
 365          * Pointer to the beginning of the RX FIS memory as used
 366          * by the DMA.
 367          */
 368         dma_addr_t rxfis_dma;
 369         /*
 370          * Pointer to the DMA region for RX Fis, Identify, RLE10, and SMART
 371          */
 372         void *block1;
 373         /*
 374          * DMA address of region for RX Fis, Identify, RLE10, and SMART
 375          */
 376         dma_addr_t block1_dma;
 377         /*
 378          * Pointer to the beginning of the identify data memory as used
 379          * by the driver.
 380          */
 381         u16 *identify;
 382         /*
 383          * Pointer to the beginning of the identify data memory as used
 384          * by the DMA.
 385          */
 386         dma_addr_t identify_dma;
 387         /*
 388          * Pointer to the beginning of a sector buffer that is used
 389          * by the driver when issuing internal commands.
 390          */
 391         u16 *sector_buffer;
 392         /*
 393          * Pointer to the beginning of a sector buffer that is used
 394          * by the DMA when the driver issues internal commands.
 395          */
 396         dma_addr_t sector_buffer_dma;
 397
 398         u16 *log_buf;
 399         dma_addr_t log_buf_dma;
 400
 401         u8 *smart_buf;
 402         dma_addr_t smart_buf_dma;
 403
 404         /*
 405          * used to queue commands when an internal command is in progress
 406          * or error handling is active
 407          */
 408         unsigned long cmds_to_issue[SLOTBITS_IN_LONGS];
 409         /* Used by mtip_service_thread to wait for an event */
 410         wait_queue_head_t svc_wait;
 411         /*
 412          * indicates the state of the port. Also, helps the service thread
 413          * to determine its action on wake up.
 414          */
 415         unsigned long flags;
 416         /*
 417          * Timer used to complete commands that have been active for too long.
 418          */
 419         unsigned long ic_pause_timer;
 420
 421         /* Counter to control queue depth of unaligned IOs */
 422         atomic_t cmd_slot_unal;
 423
 424         /* Spinlock for working around command-issue bug. */
 425         spinlock_t cmd_issue_lock[MTIP_MAX_SLOT_GROUPS];
 426 };
 427
 428 /*
 429  * Driver private data structure.
 430  *
 431  * One structure is allocated per probed device.
 432  */
 433 struct driver_data {
 434         void __iomem *mmio; /* Base address of the HBA registers. */
 435
 436         int major; /* Major device number. */
 437
 438         int instance; /* Instance number. First device probed is 0, ... */
 439
 440         struct gendisk *disk; /* Pointer to our gendisk structure. */
 441
 442         struct pci_dev *pdev; /* Pointer to the PCI device structure. */
 443
 444         struct request_queue *queue; /* Our request queue. */
 445
 446         struct blk_mq_tag_set tags; /* blk_mq tags */
 447
 448         struct mtip_port *port; /* Pointer to the port data structure. */
 449
 450         unsigned product_type; /* magic value declaring the product type */
 451
 452         unsigned slot_groups; /* number of slot groups the product supports */
 453
 454         unsigned long index; /* Index to determine the disk name */
 455
 456         unsigned long dd_flag; /* NOTE: use atomic bit operations on this */
 457
 458         struct task_struct *mtip_svc_handler; /* task_struct of svc thd */
 459
 460         struct dentry *dfs_node;
 461
 462         bool sr;
 463
 464         int numa_node; /* NUMA support */
 465
 466         char workq_name[32];
 467
 468         struct workqueue_struct *isr_workq;
 469
 470         atomic_t irq_workers_active;
 471
 472         struct mtip_work work[MTIP_MAX_SLOT_GROUPS];
 473
 474         int isr_binding;
 475
 476         struct block_device *bdev;
 477
 478         struct list_head online_list; /* linkage for online list */
 479
 480         struct list_head remove_list; /* linkage for removing list */
 481
 482         int unal_qdepth; /* qdepth of unaligned IO queue */
 483 };
 484
 485 #endif