2 * mtip32xx.h - Header file for the P320 SSD Block Driver
3 * Copyright (C) 2011 Micron Technology, Inc.
5 * Portions of this code were derived from works subjected to the
7 * Copyright (C) 2009 Integrated Device Technology, Inc.
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.
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.
21 #ifndef __MTIP32XX_H__
22 #define __MTIP32XX_H__
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>
30 /* Offset of Subsystem Device ID in pci confoguration space */
31 #define PCI_SUBSYSTEM_DEVICEID 0x2E
33 /* offset of Device Control register in PCIe extended capabilites space */
34 #define PCIE_CONFIG_EXT_DEVICE_CONTROL_OFFSET 0x48
36 /* check for erase mode support during secure erase */
37 #define MTIP_SEC_ERASE_MODE 0x2
39 /* # of times to retry timed out/failed IOs */
40 #define MTIP_MAX_RETRIES 2
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
47 /* check for timeouts every 500ms */
48 #define MTIP_TIMEOUT_CHECK_PERIOD 500
51 #define MTIP_FTL_REBUILD_OFFSET 142
52 #define MTIP_FTL_REBUILD_MAGIC 0xED51
53 #define MTIP_FTL_REBUILD_TIMEOUT_MS 2400000
55 /* Macro to extract the tag bit number from a tag value. */
56 #define MTIP_TAG_BIT(tag) (tag & 0x1F)
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
63 #define MTIP_TAG_INDEX(tag) (tag >> 5)
66 * Maximum number of scatter gather entries
67 * a single command may have.
69 #define MTIP_MAX_SG 128
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.
75 #define MTIP_MAX_SLOT_GROUPS 8
77 /* Internal command tag. */
78 #define MTIP_TAG_INTERNAL 0
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
90 /* Driver name and version strings */
91 #define MTIP_DRV_NAME "mtip32xx"
92 #define MTIP_DRV_VERSION "1.2.6os3"
94 /* Maximum number of minor device numbers per device. */
95 #define MTIP_MAX_MINORS 16
97 /* Maximum number of supported command slots. */
98 #define MTIP_MAX_COMMAND_SLOTS (MTIP_MAX_SLOT_GROUPS * 32)
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!
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)
112 /* BAR number used to access the HBA registers. */
116 #define dbg_printk(format, arg...) \
117 printk(pr_fmt(format), ##arg);
119 #define dbg_printk(format, arg...)
122 #define MTIP_DFS_MAX_BUF_SIZE 1024
124 #define __force_bit2int (unsigned int __force)
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)),
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,
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)),
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,
158 __packed struct smart_attr{
167 /* Register Frame Information Structure (FIS), host to device. */
168 struct host_to_dev_fis {
171 * - 27h Register FIS, host to device.
172 * - 34h Register FIS, device to host.
173 * - 39h DMA Activate FIS, device to host.
174 * - 41h DMA Setup FIS, bi-directional.
175 * - 46h Data FIS, bi-directional.
176 * - 58h BIST Activate FIS, bi-directional.
177 * - 5Fh PIO Setup FIS, device to host.
178 * - A1h Set Device Bits FIS, device to host.
182 unsigned char command;
183 unsigned char features;
186 unsigned char lba_low;
187 unsigned char sector;
190 unsigned char lba_mid;
191 unsigned char cyl_low;
194 unsigned char lba_hi;
195 unsigned char cyl_hi;
198 unsigned char device;
203 unsigned char lba_low_ex;
204 unsigned char sector_ex;
207 unsigned char lba_mid_ex;
208 unsigned char cyl_low_ex;
211 unsigned char lba_hi_ex;
212 unsigned char cyl_hi_ex;
214 unsigned char features_ex;
216 unsigned char sect_count;
217 unsigned char sect_cnt_ex;
219 unsigned char control;
224 /* Command header structure. */
225 struct mtip_cmd_hdr {
228 * - Bits 31:16 Number of PRD entries.
229 * - Bits 15:8 Unused in this implementation.
230 * - Bit 7 Prefetch bit, informs the drive to prefetch PRD entries.
231 * - Bit 6 Write bit, should be set when writing data to the device.
232 * - Bit 5 Unused in this implementation.
233 * - Bits 4:0 Length of the command FIS in DWords (DWord = 4 bytes).
236 /* This field is unsed when using NCQ. */
238 unsigned int byte_count;
242 * Lower 32 bits of the command table address associated with this
243 * header. The command table addresses must be 128 byte aligned.
247 * If 64 bit addressing is used this field is the upper 32 bits
248 * of the command table address associated with this command.
251 /* Reserved and unused. */
255 /* Command scatter gather structure (PRD). */
258 * Low 32 bits of the data buffer address. For P320 this
259 * address must be 8 byte aligned signified by bits 2:0 being
264 * When 64 bit addressing is used this field is the upper
265 * 32 bits of the data buffer address.
267 unsigned int dba_upper;
269 unsigned int reserved;
271 * Bit 31: interrupt when this data block has been transferred.
272 * Bits 30..22: reserved
273 * Bits 21..0: byte count (minus 1). For P320 the byte count must be
274 * 8 byte aligned signified by bits 2:0 being set to 1.
280 /* Structure used to describe a command. */
283 struct mtip_cmd_hdr *command_header; /* ptr to command header entry */
285 dma_addr_t command_header_dma; /* corresponding physical address */
287 void *command; /* ptr to command table entry */
289 dma_addr_t command_dma; /* corresponding physical address */
291 void *comp_data; /* data passed to completion function comp_func() */
293 * Completion function called by the ISR upon completion of
296 void (*comp_func)(struct mtip_port *port,
300 /* Additional callback function that may be called by comp_func() */
301 void (*async_callback)(void *data, int status);
303 void *async_data; /* Addl. data passed to async_callback() */
305 int scatter_ents; /* Number of scatter list entries used */
307 struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */
309 int retries; /* The number of retries left for this command. */
311 int direction; /* Data transfer direction */
313 unsigned long comp_time; /* command completion time, in jiffies */
315 atomic_t active; /* declares if this command sent to the drive. */
318 /* Structure used to describe a port. */
320 /* Pointer back to the driver data for this port. */
321 struct driver_data *dd;
323 * Used to determine if the data pointed to by the
324 * identify field is valid.
326 unsigned long identify_valid;
327 /* Base address of the memory mapped IO for the port. */
329 /* Array of pointers to the memory mapped s_active registers. */
330 void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
331 /* Array of pointers to the memory mapped completed registers. */
332 void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
333 /* Array of pointers to the memory mapped Command Issue registers. */
334 void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
336 * Pointer to the beginning of the command header memory as used
341 * Pointer to the beginning of the command header memory as used
344 dma_addr_t command_list_dma;
346 * Pointer to the beginning of the RX FIS memory as used
351 * Pointer to the beginning of the RX FIS memory as used
354 dma_addr_t rxfis_dma;
356 * Pointer to the beginning of the command table memory as used
361 * Pointer to the beginning of the command table memory as used
364 dma_addr_t command_tbl_dma;
366 * Pointer to the beginning of the identify data memory as used
371 * Pointer to the beginning of the identify data memory as used
374 dma_addr_t identify_dma;
376 * Pointer to the beginning of a sector buffer that is used
377 * by the driver when issuing internal commands.
381 * Pointer to the beginning of a sector buffer that is used
382 * by the DMA when the driver issues internal commands.
384 dma_addr_t sector_buffer_dma;
386 * Bit significant, used to determine if a command slot has
387 * been allocated. i.e. the slot is in use. Bits are cleared
388 * when the command slot and all associated data structures
389 * are no longer needed.
392 dma_addr_t log_buf_dma;
395 dma_addr_t smart_buf_dma;
397 unsigned long allocated[SLOTBITS_IN_LONGS];
399 * used to queue commands when an internal command is in progress
400 * or error handling is active
402 unsigned long cmds_to_issue[SLOTBITS_IN_LONGS];
404 * Array of command slots. Structure includes pointers to the
405 * command header and command table, and completion function and data
408 struct mtip_cmd commands[MTIP_MAX_COMMAND_SLOTS];
409 /* Used by mtip_service_thread to wait for an event */
410 wait_queue_head_t svc_wait;
412 * indicates the state of the port. Also, helps the service thread
413 * to determine its action on wake up.
417 * Timer used to complete commands that have been active for too long.
419 struct timer_list cmd_timer;
420 unsigned long ic_pause_timer;
422 * Semaphore used to block threads if there are no
423 * command slots available.
425 struct semaphore cmd_slot;
426 /* Spinlock for working around command-issue bug. */
427 spinlock_t cmd_issue_lock;
431 * Driver private data structure.
433 * One structure is allocated per probed device.
436 void __iomem *mmio; /* Base address of the HBA registers. */
438 int major; /* Major device number. */
440 int instance; /* Instance number. First device probed is 0, ... */
442 struct gendisk *disk; /* Pointer to our gendisk structure. */
444 struct pci_dev *pdev; /* Pointer to the PCI device structure. */
446 struct request_queue *queue; /* Our request queue. */
448 struct mtip_port *port; /* Pointer to the port data structure. */
450 /* Tasklet used to process the bottom half of the ISR. */
451 struct tasklet_struct tasklet;
453 unsigned product_type; /* magic value declaring the product type */
455 unsigned slot_groups; /* number of slot groups the product supports */
457 unsigned long index; /* Index to determine the disk name */
459 unsigned long dd_flag; /* NOTE: use atomic bit operations on this */
461 struct task_struct *mtip_svc_handler; /* task_struct of svc thd */
463 struct dentry *dfs_node;