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