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_COMMAND_TIMEOUT_MS       5000
  44 #define MTIP_IOCTL_COMMAND_TIMEOUT_MS     5000
  45 #define MTIP_INTERNAL_COMMAND_TIMEOUT_MS  5000
  46
  47 /* check for timeouts every 500ms */
  48 #define MTIP_TIMEOUT_CHECK_PERIOD       500
  49
  50 /* ftl rebuild */
  51 #define MTIP_FTL_REBUILD_OFFSET         142
  52 #define MTIP_FTL_REBUILD_MAGIC          0xED51
  53 #define MTIP_FTL_REBUILD_TIMEOUT_MS     2400000
  54
  55 /* unaligned IO handling */
  56 #define MTIP_MAX_UNALIGNED_SLOTS        8
  57
  58 /* Macro to extract the tag bit number from a tag value. */
  59 #define MTIP_TAG_BIT(tag)       (tag & 0x1F)
  60
  61 /*
  62  * Macro to extract the tag index from a tag value. The index
  63  * is used to access the correct s_active/Command Issue register based
  64  * on the tag value.
  65  */
  66 #define MTIP_TAG_INDEX(tag)     (tag >> 5)
  67
  68 /*
  69  * Maximum number of scatter gather entries
  70  * a single command may have.
  71  */
  72 #define MTIP_MAX_SG             128
  73
  74 /*
  75  * Maximum number of slot groups (Command Issue & s_active registers)
  76  * NOTE: This is the driver maximum; check dd->slot_groups for actual value.
  77  */
  78 #define MTIP_MAX_SLOT_GROUPS    8
  79
  80 /* Internal command tag. */
  81 #define MTIP_TAG_INTERNAL       0
  82
  83 /* Micron Vendor ID & P320x SSD Device ID */
  84 #define PCI_VENDOR_ID_MICRON    0x1344
  85 #define P320H_DEVICE_ID         0x5150
  86 #define P320M_DEVICE_ID         0x5151
  87 #define P320S_DEVICE_ID         0x5152
  88 #define P325M_DEVICE_ID         0x5153
  89 #define P420H_DEVICE_ID         0x5160
  90 #define P420M_DEVICE_ID         0x5161
  91 #define P425M_DEVICE_ID         0x5163
  92
  93 /* Driver name and version strings */
  94 #define MTIP_DRV_NAME           "mtip32xx"
  95 #define MTIP_DRV_VERSION        "1.2.6os3"
  96
  97 /* Maximum number of minor device numbers per device. */
  98 #define MTIP_MAX_MINORS         16
  99
 100 /* Maximum number of supported command slots. */
 101 #define MTIP_MAX_COMMAND_SLOTS  (MTIP_MAX_SLOT_GROUPS * 32)
 102
 103 /*
 104  * Per-tag bitfield size in longs.
 105  * Linux bit manipulation functions
 106  * (i.e. test_and_set_bit, find_next_zero_bit)
 107  * manipulate memory in longs, so we try to make the math work.
 108  * take the slot groups and find the number of longs, rounding up.
 109  * Careful! i386 and x86_64 use different size longs!
 110  */
 111 #define U32_PER_LONG    (sizeof(long) / sizeof(u32))
 112 #define SLOTBITS_IN_LONGS ((MTIP_MAX_SLOT_GROUPS + \
 113                                         (U32_PER_LONG-1))/U32_PER_LONG)
 114
 115 /* BAR number used to access the HBA registers. */
 116 #define MTIP_ABAR               5
 117
 118 #ifdef DEBUG
 119  #define dbg_printk(format, arg...)     \
 120         printk(pr_fmt(format), ##arg);
 121 #else
 122  #define dbg_printk(format, arg...)
 123 #endif
 124
 125 #define MTIP_DFS_MAX_BUF_SIZE 1024
 126
 127 #define __force_bit2int (unsigned int __force)
 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_PAUSE_IO      = ((1 << MTIP_PF_IC_ACTIVE_BIT) |
 136                                 (1 << MTIP_PF_EH_ACTIVE_BIT) |
 137                                 (1 << MTIP_PF_SE_ACTIVE_BIT) |
 138                                 (1 << MTIP_PF_DM_ACTIVE_BIT)),
 139
 140         MTIP_PF_SVC_THD_ACTIVE_BIT  = 4,
 141         MTIP_PF_ISSUE_CMDS_BIT      = 5,
 142         MTIP_PF_REBUILD_BIT         = 6,
 143         MTIP_PF_SR_CLEANUP_BIT      = 7,
 144         MTIP_PF_SVC_THD_STOP_BIT    = 8,
 145
 146         /* below are bit numbers in 'dd_flag' defined in driver_data */
 147         MTIP_DDF_SEC_LOCK_BIT       = 0,
 148         MTIP_DDF_REMOVE_PENDING_BIT = 1,
 149         MTIP_DDF_OVER_TEMP_BIT      = 2,
 150         MTIP_DDF_WRITE_PROTECT_BIT  = 3,
 151         MTIP_DDF_REMOVE_DONE_BIT    = 4,
 152         MTIP_DDF_CLEANUP_BIT        = 5,
 153         MTIP_DDF_RESUME_BIT         = 6,
 154         MTIP_DDF_INIT_DONE_BIT      = 7,
 155         MTIP_DDF_REBUILD_FAILED_BIT = 8,
 156
 157         MTIP_DDF_STOP_IO      = ((1 << MTIP_DDF_REMOVE_PENDING_BIT) |
 158                                 (1 << MTIP_DDF_SEC_LOCK_BIT) |
 159                                 (1 << MTIP_DDF_OVER_TEMP_BIT) |
 160                                 (1 << MTIP_DDF_WRITE_PROTECT_BIT) |
 161                                 (1 << MTIP_DDF_REBUILD_FAILED_BIT)),
 162
 163 };
 164
 165 struct smart_attr {
 166         u8 attr_id;
 167         u16 flags;
 168         u8 cur;
 169         u8 worst;
 170         u32 data;
 171         u8 res[3];
 172 } __packed;
 173
 174 struct mtip_work {
 175         struct work_struct work;
 176         void *port;
 177         int cpu_binding;
 178         u32 completed;
 179 } ____cacheline_aligned_in_smp;
 180
 181 #define DEFINE_HANDLER(group)                                  \
 182         void mtip_workq_sdbf##group(struct work_struct *work)       \
 183         {                                                      \
 184                 struct mtip_work *w = (struct mtip_work *) work;         \
 185                 mtip_workq_sdbfx(w->port, group, w->completed);     \
 186         }
 187
 188 #define MTIP_TRIM_TIMEOUT_MS            240000
 189 #define MTIP_MAX_TRIM_ENTRIES           8
 190 #define MTIP_MAX_TRIM_ENTRY_LEN         0xfff8
 191
 192 struct mtip_trim_entry {
 193         u32 lba;   /* starting lba of region */
 194         u16 rsvd;  /* unused */
 195         u16 range; /* # of 512b blocks to trim */
 196 } __packed;
 197
 198 struct mtip_trim {
 199         /* Array of regions to trim */
 200         struct mtip_trim_entry entry[MTIP_MAX_TRIM_ENTRIES];
 201 } __packed;
 202
 203 /* Register Frame Information Structure (FIS), host to device. */
 204 struct host_to_dev_fis {
 205         /*
 206          * FIS type.
 207          * - 27h Register FIS, host to device.
 208          * - 34h Register FIS, device to host.
 209          * - 39h DMA Activate FIS, device to host.
 210          * - 41h DMA Setup FIS, bi-directional.
 211          * - 46h Data FIS, bi-directional.
 212          * - 58h BIST Activate FIS, bi-directional.
 213          * - 5Fh PIO Setup FIS, device to host.
 214          * - A1h Set Device Bits FIS, device to host.
 215          */
 216         unsigned char type;
 217         unsigned char opts;
 218         unsigned char command;
 219         unsigned char features;
 220
 221         union {
 222                 unsigned char lba_low;
 223                 unsigned char sector;
 224         };
 225         union {
 226                 unsigned char lba_mid;
 227                 unsigned char cyl_low;
 228         };
 229         union {
 230                 unsigned char lba_hi;
 231                 unsigned char cyl_hi;
 232         };
 233         union {
 234                 unsigned char device;
 235                 unsigned char head;
 236         };
 237
 238         union {
 239                 unsigned char lba_low_ex;
 240                 unsigned char sector_ex;
 241         };
 242         union {
 243                 unsigned char lba_mid_ex;
 244                 unsigned char cyl_low_ex;
 245         };
 246         union {
 247                 unsigned char lba_hi_ex;
 248                 unsigned char cyl_hi_ex;
 249         };
 250         unsigned char features_ex;
 251
 252         unsigned char sect_count;
 253         unsigned char sect_cnt_ex;
 254         unsigned char res2;
 255         unsigned char control;
 256
 257         unsigned int res3;
 258 };
 259
 260 /* Command header structure. */
 261 struct mtip_cmd_hdr {
 262         /*
 263          * Command options.
 264          * - Bits 31:16 Number of PRD entries.
 265          * - Bits 15:8 Unused in this implementation.
 266          * - Bit 7 Prefetch bit, informs the drive to prefetch PRD entries.
 267          * - Bit 6 Write bit, should be set when writing data to the device.
 268          * - Bit 5 Unused in this implementation.
 269          * - Bits 4:0 Length of the command FIS in DWords (DWord = 4 bytes).
 270          */
 271         unsigned int opts;
 272         /* This field is unsed when using NCQ. */
 273         union {
 274                 unsigned int byte_count;
 275                 unsigned int status;
 276         };
 277         /*
 278          * Lower 32 bits of the command table address associated with this
 279          * header. The command table addresses must be 128 byte aligned.
 280          */
 281         unsigned int ctba;
 282         /*
 283          * If 64 bit addressing is used this field is the upper 32 bits
 284          * of the command table address associated with this command.
 285          */
 286         unsigned int ctbau;
 287         /* Reserved and unused. */
 288         unsigned int res[4];
 289 };
 290
 291 /* Command scatter gather structure (PRD). */
 292 struct mtip_cmd_sg {
 293         /*
 294          * Low 32 bits of the data buffer address. For P320 this
 295          * address must be 8 byte aligned signified by bits 2:0 being
 296          * set to 0.
 297          */
 298         unsigned int dba;
 299         /*
 300          * When 64 bit addressing is used this field is the upper
 301          * 32 bits of the data buffer address.
 302          */
 303         unsigned int dba_upper;
 304         /* Unused. */
 305         unsigned int reserved;
 306         /*
 307          * Bit 31: interrupt when this data block has been transferred.
 308          * Bits 30..22: reserved
 309          * Bits 21..0: byte count (minus 1).  For P320 the byte count must be
 310          * 8 byte aligned signified by bits 2:0 being set to 1.
 311          */
 312         unsigned int info;
 313 };
 314 struct mtip_port;
 315
 316 /* Structure used to describe a command. */
 317 struct mtip_cmd {
 318
 319         struct mtip_cmd_hdr *command_header; /* ptr to command header entry */
 320
 321         dma_addr_t command_header_dma; /* corresponding physical address */
 322
 323         void *command; /* ptr to command table entry */
 324
 325         dma_addr_t command_dma; /* corresponding physical address */
 326
 327         void *comp_data; /* data passed to completion function comp_func() */
 328         /*
 329          * Completion function called by the ISR upon completion of
 330          * a command.
 331          */
 332         void (*comp_func)(struct mtip_port *port,
 333                                 int tag,
 334                                 void *data,
 335                                 int status);
 336         /* Additional callback function that may be called by comp_func() */
 337         void (*async_callback)(void *data, int status);
 338
 339         void *async_data; /* Addl. data passed to async_callback() */
 340
 341         int scatter_ents; /* Number of scatter list entries used */
 342
 343         int unaligned; /* command is unaligned on 4k boundary */
 344
 345         struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */
 346
 347         int retries; /* The number of retries left for this command. */
 348
 349         int direction; /* Data transfer direction */
 350
 351         unsigned long comp_time; /* command completion time, in jiffies */
 352
 353         atomic_t active; /* declares if this command sent to the drive. */
 354 };
 355
 356 /* Structure used to describe a port. */
 357 struct mtip_port {
 358         /* Pointer back to the driver data for this port. */
 359         struct driver_data *dd;
 360         /*
 361          * Used to determine if the data pointed to by the
 362          * identify field is valid.
 363          */
 364         unsigned long identify_valid;
 365         /* Base address of the memory mapped IO for the port. */
 366         void __iomem *mmio;
 367         /* Array of pointers to the memory mapped s_active registers. */
 368         void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
 369         /* Array of pointers to the memory mapped completed registers. */
 370         void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
 371         /* Array of pointers to the memory mapped Command Issue registers. */
 372         void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
 373         /*
 374          * Pointer to the beginning of the command header memory as used
 375          * by the driver.
 376          */
 377         void *command_list;
 378         /*
 379          * Pointer to the beginning of the command header memory as used
 380          * by the DMA.
 381          */
 382         dma_addr_t command_list_dma;
 383         /*
 384          * Pointer to the beginning of the RX FIS memory as used
 385          * by the driver.
 386          */
 387         void *rxfis;
 388         /*
 389          * Pointer to the beginning of the RX FIS memory as used
 390          * by the DMA.
 391          */
 392         dma_addr_t rxfis_dma;
 393         /*
 394          * Pointer to the beginning of the command table memory as used
 395          * by the driver.
 396          */
 397         void *command_table;
 398         /*
 399          * Pointer to the beginning of the command table memory as used
 400          * by the DMA.
 401          */
 402         dma_addr_t command_tbl_dma;
 403         /*
 404          * Pointer to the beginning of the identify data memory as used
 405          * by the driver.
 406          */
 407         u16 *identify;
 408         /*
 409          * Pointer to the beginning of the identify data memory as used
 410          * by the DMA.
 411          */
 412         dma_addr_t identify_dma;
 413         /*
 414          * Pointer to the beginning of a sector buffer that is used
 415          * by the driver when issuing internal commands.
 416          */
 417         u16 *sector_buffer;
 418         /*
 419          * Pointer to the beginning of a sector buffer that is used
 420          * by the DMA when the driver issues internal commands.
 421          */
 422         dma_addr_t sector_buffer_dma;
 423         /*
 424          * Bit significant, used to determine if a command slot has
 425          * been allocated. i.e. the slot is in use.  Bits are cleared
 426          * when the command slot and all associated data structures
 427          * are no longer needed.
 428          */
 429         u16 *log_buf;
 430         dma_addr_t log_buf_dma;
 431
 432         u8 *smart_buf;
 433         dma_addr_t smart_buf_dma;
 434
 435         unsigned long allocated[SLOTBITS_IN_LONGS];
 436         /*
 437          * used to queue commands when an internal command is in progress
 438          * or error handling is active
 439          */
 440         unsigned long cmds_to_issue[SLOTBITS_IN_LONGS];
 441         /*
 442          * Array of command slots. Structure includes pointers to the
 443          * command header and command table, and completion function and data
 444          * pointers.
 445          */
 446         struct mtip_cmd commands[MTIP_MAX_COMMAND_SLOTS];
 447         /* Used by mtip_service_thread to wait for an event */
 448         wait_queue_head_t svc_wait;
 449         /*
 450          * indicates the state of the port. Also, helps the service thread
 451          * to determine its action on wake up.
 452          */
 453         unsigned long flags;
 454         /*
 455          * Timer used to complete commands that have been active for too long.
 456          */
 457         struct timer_list cmd_timer;
 458         unsigned long ic_pause_timer;
 459         /*
 460          * Semaphore used to block threads if there are no
 461          * command slots available.
 462          */
 463         struct semaphore cmd_slot;
 464
 465         /* Semaphore to control queue depth of unaligned IOs */
 466         struct semaphore cmd_slot_unal;
 467
 468         /* Spinlock for working around command-issue bug. */
 469         spinlock_t cmd_issue_lock[MTIP_MAX_SLOT_GROUPS];
 470 };
 471
 472 /*
 473  * Driver private data structure.
 474  *
 475  * One structure is allocated per probed device.
 476  */
 477 struct driver_data {
 478         void __iomem *mmio; /* Base address of the HBA registers. */
 479
 480         int major; /* Major device number. */
 481
 482         int instance; /* Instance number. First device probed is 0, ... */
 483
 484         struct gendisk *disk; /* Pointer to our gendisk structure. */
 485
 486         struct pci_dev *pdev; /* Pointer to the PCI device structure. */
 487
 488         struct request_queue *queue; /* Our request queue. */
 489
 490         struct mtip_port *port; /* Pointer to the port data structure. */
 491
 492         unsigned product_type; /* magic value declaring the product type */
 493
 494         unsigned slot_groups; /* number of slot groups the product supports */
 495
 496         unsigned long index; /* Index to determine the disk name */
 497
 498         unsigned long dd_flag; /* NOTE: use atomic bit operations on this */
 499
 500         struct task_struct *mtip_svc_handler; /* task_struct of svc thd */
 501
 502         struct dentry *dfs_node;
 503
 504         bool trim_supp; /* flag indicating trim support */
 505
 506         bool sr;
 507
 508         int numa_node; /* NUMA support */
 509
 510         char workq_name[32];
 511
 512         struct workqueue_struct *isr_workq;
 513
 514         struct mtip_work work[MTIP_MAX_SLOT_GROUPS];
 515
 516         atomic_t irq_workers_active;
 517
 518         int isr_binding;
 519
 520         struct block_device *bdev;
 521
 522         int unal_qdepth; /* qdepth of unaligned IO queue */
 523
 524         struct list_head online_list; /* linkage for online list */
 525
 526         struct list_head remove_list; /* linkage for removing list */
 527 };
 528
 529 #endif