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