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 /* Macro to extract the tag bit number from a tag value. */
  56 #define MTIP_TAG_BIT(tag)       (tag & 0x1F)
  57
  58 /*
  59  * Macro to extract the tag index from a tag value. The index
  60  * is used to access the correct s_active/Command Issue register based
  61  * on the tag value.
  62  */
  63 #define MTIP_TAG_INDEX(tag)     (tag >> 5)
  64
  65 /*
  66  * Maximum number of scatter gather entries
  67  * a single command may have.
  68  */
  69 #define MTIP_MAX_SG             128
  70
  71 /*
  72  * Maximum number of slot groups (Command Issue & s_active registers)
  73  * NOTE: This is the driver maximum; check dd->slot_groups for actual value.
  74  */
  75 #define MTIP_MAX_SLOT_GROUPS    8
  76
  77 /* Internal command tag. */
  78 #define MTIP_TAG_INTERNAL       0
  79
  80 /* Micron Vendor ID & P320x SSD Device ID */
  81 #define PCI_VENDOR_ID_MICRON    0x1344
  82 #define P320H_DEVICE_ID         0x5150
  83 #define P320M_DEVICE_ID         0x5151
  84 #define P320S_DEVICE_ID         0x5152
  85 #define P325M_DEVICE_ID         0x5153
  86 #define P420H_DEVICE_ID         0x5160
  87 #define P420M_DEVICE_ID         0x5161
  88 #define P425M_DEVICE_ID         0x5163
  89
  90 /* Driver name and version strings */
  91 #define MTIP_DRV_NAME           "mtip32xx"
  92 #define MTIP_DRV_VERSION        "1.2.6os3"
  93
  94 /* Maximum number of minor device numbers per device. */
  95 #define MTIP_MAX_MINORS         16
  96
  97 /* Maximum number of supported command slots. */
  98 #define MTIP_MAX_COMMAND_SLOTS  (MTIP_MAX_SLOT_GROUPS * 32)
  99
 100 /*
 101  * Per-tag bitfield size in longs.
 102  * Linux bit manipulation functions
 103  * (i.e. test_and_set_bit, find_next_zero_bit)
 104  * manipulate memory in longs, so we try to make the math work.
 105  * take the slot groups and find the number of longs, rounding up.
 106  * Careful! i386 and x86_64 use different size longs!
 107  */
 108 #define U32_PER_LONG    (sizeof(long) / sizeof(u32))
 109 #define SLOTBITS_IN_LONGS ((MTIP_MAX_SLOT_GROUPS + \
 110                                         (U32_PER_LONG-1))/U32_PER_LONG)
 111
 112 /* BAR number used to access the HBA registers. */
 113 #define MTIP_ABAR               5
 114
 115 #ifdef DEBUG
 116  #define dbg_printk(format, arg...)     \
 117         printk(pr_fmt(format), ##arg);
 118 #else
 119  #define dbg_printk(format, arg...)
 120 #endif
 121
 122 #define MTIP_DFS_MAX_BUF_SIZE 1024
 123
 124 #define __force_bit2int (unsigned int __force)
 125
 126 enum {
 127         /* below are bit numbers in 'flags' defined in mtip_port */
 128         MTIP_PF_IC_ACTIVE_BIT       = 0, /* pio/ioctl */
 129         MTIP_PF_EH_ACTIVE_BIT       = 1, /* error handling */
 130         MTIP_PF_SE_ACTIVE_BIT       = 2, /* secure erase */
 131         MTIP_PF_DM_ACTIVE_BIT       = 3, /* download microcde */
 132         MTIP_PF_PAUSE_IO      = ((1 << MTIP_PF_IC_ACTIVE_BIT) | \
 133                                 (1 << MTIP_PF_EH_ACTIVE_BIT) | \
 134                                 (1 << MTIP_PF_SE_ACTIVE_BIT) | \
 135                                 (1 << MTIP_PF_DM_ACTIVE_BIT)),
 136
 137         MTIP_PF_SVC_THD_ACTIVE_BIT  = 4,
 138         MTIP_PF_ISSUE_CMDS_BIT      = 5,
 139         MTIP_PF_REBUILD_BIT         = 6,
 140         MTIP_PF_SVC_THD_STOP_BIT    = 8,
 141
 142         /* below are bit numbers in 'dd_flag' defined in driver_data */
 143         MTIP_DDF_SEC_LOCK_BIT       = 0,
 144         MTIP_DDF_REMOVE_PENDING_BIT = 1,
 145         MTIP_DDF_OVER_TEMP_BIT      = 2,
 146         MTIP_DDF_WRITE_PROTECT_BIT  = 3,
 147         MTIP_DDF_STOP_IO      = ((1 << MTIP_DDF_REMOVE_PENDING_BIT) | \
 148                                 (1 << MTIP_DDF_SEC_LOCK_BIT) | \
 149                                 (1 << MTIP_DDF_OVER_TEMP_BIT) | \
 150                                 (1 << MTIP_DDF_WRITE_PROTECT_BIT)),
 151
 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
 158 struct smart_attr {
 159         u8 attr_id;
 160         u16 flags;
 161         u8 cur;
 162         u8 worst;
 163         u32 data;
 164         u8 res[3];
 165 } __packed;
 166
 167 struct mtip_work {
 168         struct work_struct work;
 169         void *port;
 170         int cpu_binding;
 171         u32 completed;
 172 } ____cacheline_aligned_in_smp;
 173
 174 #define DEFINE_HANDLER(group)                                  \
 175         void mtip_workq_sdbf##group(struct work_struct *work)       \
 176         {                                                      \
 177                 struct mtip_work *w = (struct mtip_work *) work;         \
 178                 mtip_workq_sdbfx(w->port, group, w->completed);     \
 179         }
 180
 181 #define MTIP_TRIM_TIMEOUT_MS            240000
 182 #define MTIP_MAX_TRIM_ENTRIES           8
 183 #define MTIP_MAX_TRIM_ENTRY_LEN         0xfff8
 184
 185 struct mtip_trim_entry {
 186         u32 lba;   /* starting lba of region */
 187         u16 rsvd;  /* unused */
 188         u16 range; /* # of 512b blocks to trim */
 189 } __packed;
 190
 191 struct mtip_trim {
 192         /* Array of regions to trim */
 193         struct mtip_trim_entry entry[MTIP_MAX_TRIM_ENTRIES];
 194 } __packed;
 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         unsigned int opts;
 265         /* This field is unsed when using NCQ. */
 266         union {
 267                 unsigned int byte_count;
 268                 unsigned int 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         unsigned int 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         unsigned int ctbau;
 280         /* Reserved and unused. */
 281         unsigned int 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         unsigned int dba;
 292         /*
 293          * When 64 bit addressing is used this field is the upper
 294          * 32 bits of the data buffer address.
 295          */
 296         unsigned int dba_upper;
 297         /* Unused. */
 298         unsigned int 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         unsigned int info;
 306 };
 307 struct mtip_port;
 308
 309 /* Structure used to describe a command. */
 310 struct mtip_cmd {
 311
 312         struct mtip_cmd_hdr *command_header; /* ptr to command header entry */
 313
 314         dma_addr_t command_header_dma; /* corresponding physical address */
 315
 316         void *command; /* ptr to command table entry */
 317
 318         dma_addr_t command_dma; /* corresponding physical address */
 319
 320         void *comp_data; /* data passed to completion function comp_func() */
 321         /*
 322          * Completion function called by the ISR upon completion of
 323          * a command.
 324          */
 325         void (*comp_func)(struct mtip_port *port,
 326                                 int tag,
 327                                 void *data,
 328                                 int status);
 329         /* Additional callback function that may be called by comp_func() */
 330         void (*async_callback)(void *data, int status);
 331
 332         void *async_data; /* Addl. data passed to async_callback() */
 333
 334         int scatter_ents; /* Number of scatter list entries used */
 335
 336         struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */
 337
 338         int retries; /* The number of retries left for this command. */
 339
 340         int direction; /* Data transfer direction */
 341
 342         unsigned long comp_time; /* command completion time, in jiffies */
 343
 344         atomic_t active; /* declares if this command sent to the drive. */
 345 };
 346
 347 /* Structure used to describe a port. */
 348 struct mtip_port {
 349         /* Pointer back to the driver data for this port. */
 350         struct driver_data *dd;
 351         /*
 352          * Used to determine if the data pointed to by the
 353          * identify field is valid.
 354          */
 355         unsigned long identify_valid;
 356         /* Base address of the memory mapped IO for the port. */
 357         void __iomem *mmio;
 358         /* Array of pointers to the memory mapped s_active registers. */
 359         void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
 360         /* Array of pointers to the memory mapped completed registers. */
 361         void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
 362         /* Array of pointers to the memory mapped Command Issue registers. */
 363         void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
 364         /*
 365          * Pointer to the beginning of the command header memory as used
 366          * by the driver.
 367          */
 368         void *command_list;
 369         /*
 370          * Pointer to the beginning of the command header memory as used
 371          * by the DMA.
 372          */
 373         dma_addr_t command_list_dma;
 374         /*
 375          * Pointer to the beginning of the RX FIS memory as used
 376          * by the driver.
 377          */
 378         void *rxfis;
 379         /*
 380          * Pointer to the beginning of the RX FIS memory as used
 381          * by the DMA.
 382          */
 383         dma_addr_t rxfis_dma;
 384         /*
 385          * Pointer to the beginning of the command table memory as used
 386          * by the driver.
 387          */
 388         void *command_table;
 389         /*
 390          * Pointer to the beginning of the command table memory as used
 391          * by the DMA.
 392          */
 393         dma_addr_t command_tbl_dma;
 394         /*
 395          * Pointer to the beginning of the identify data memory as used
 396          * by the driver.
 397          */
 398         u16 *identify;
 399         /*
 400          * Pointer to the beginning of the identify data memory as used
 401          * by the DMA.
 402          */
 403         dma_addr_t identify_dma;
 404         /*
 405          * Pointer to the beginning of a sector buffer that is used
 406          * by the driver when issuing internal commands.
 407          */
 408         u16 *sector_buffer;
 409         /*
 410          * Pointer to the beginning of a sector buffer that is used
 411          * by the DMA when the driver issues internal commands.
 412          */
 413         dma_addr_t sector_buffer_dma;
 414         /*
 415          * Bit significant, used to determine if a command slot has
 416          * been allocated. i.e. the slot is in use.  Bits are cleared
 417          * when the command slot and all associated data structures
 418          * are no longer needed.
 419          */
 420         u16 *log_buf;
 421         dma_addr_t log_buf_dma;
 422
 423         u8 *smart_buf;
 424         dma_addr_t smart_buf_dma;
 425
 426         unsigned long allocated[SLOTBITS_IN_LONGS];
 427         /*
 428          * used to queue commands when an internal command is in progress
 429          * or error handling is active
 430          */
 431         unsigned long cmds_to_issue[SLOTBITS_IN_LONGS];
 432         /*
 433          * Array of command slots. Structure includes pointers to the
 434          * command header and command table, and completion function and data
 435          * pointers.
 436          */
 437         struct mtip_cmd commands[MTIP_MAX_COMMAND_SLOTS];
 438         /* Used by mtip_service_thread to wait for an event */
 439         wait_queue_head_t svc_wait;
 440         /*
 441          * indicates the state of the port. Also, helps the service thread
 442          * to determine its action on wake up.
 443          */
 444         unsigned long flags;
 445         /*
 446          * Timer used to complete commands that have been active for too long.
 447          */
 448         struct timer_list cmd_timer;
 449         unsigned long ic_pause_timer;
 450         /*
 451          * Semaphore used to block threads if there are no
 452          * command slots available.
 453          */
 454         struct semaphore cmd_slot;
 455         /* Spinlock for working around command-issue bug. */
 456         spinlock_t cmd_issue_lock[MTIP_MAX_SLOT_GROUPS];
 457 };
 458
 459 /*
 460  * Driver private data structure.
 461  *
 462  * One structure is allocated per probed device.
 463  */
 464 struct driver_data {
 465         void __iomem *mmio; /* Base address of the HBA registers. */
 466
 467         int major; /* Major device number. */
 468
 469         int instance; /* Instance number. First device probed is 0, ... */
 470
 471         struct gendisk *disk; /* Pointer to our gendisk structure. */
 472
 473         struct pci_dev *pdev; /* Pointer to the PCI device structure. */
 474
 475         struct request_queue *queue; /* Our request queue. */
 476
 477         struct mtip_port *port; /* Pointer to the port data structure. */
 478
 479         unsigned product_type; /* magic value declaring the product type */
 480
 481         unsigned slot_groups; /* number of slot groups the product supports */
 482
 483         unsigned long index; /* Index to determine the disk name */
 484
 485         unsigned long dd_flag; /* NOTE: use atomic bit operations on this */
 486
 487         struct task_struct *mtip_svc_handler; /* task_struct of svc thd */
 488
 489         struct dentry *dfs_node;
 490
 491         bool trim_supp; /* flag indicating trim support */
 492
 493         int numa_node; /* NUMA support */
 494
 495         char workq_name[32];
 496
 497         struct workqueue_struct *isr_workq;
 498
 499         struct mtip_work work[MTIP_MAX_SLOT_GROUPS];
 500
 501         atomic_t irq_workers_active;
 502
 503         int isr_binding;
 504 };
 505
 506 #endif