Add linux-next specific files for 20110831
[linux-2.6/next.git] / drivers / block / mtip32xx / mtip32xx.h
blob3423d18e7c8619802c31047ffea54c4f224a9248
1 /*
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
6 * following copyright:
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>
29 #include <linux/version.h>
31 /* Offset of Subsystem Device ID in pci confoguration space */
32 #define PCI_SUBSYSTEM_DEVICEID 0x2E
34 /* offset of Device Control register in PCIe extended capabilites space */
35 #define PCIE_CONFIG_EXT_DEVICE_CONTROL_OFFSET 0x48
37 /* # of times to retry timed out IOs */
38 #define MTIP_MAX_RETRIES 5
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
45 /* check for timeouts every 500ms */
46 #define MTIP_TIMEOUT_CHECK_PERIOD 500
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
53 /* Macro to extract the tag bit number from a tag value. */
54 #define MTIP_TAG_BIT(tag) (tag & 0x1f)
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.
61 #define MTIP_TAG_INDEX(tag) (tag >> 5)
64 * Maximum number of scatter gather entries
65 * a single command may have.
67 #define MTIP_MAX_SG 128
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.
73 #define MTIP_MAX_SLOT_GROUPS 8
75 /* Internal command tag. */
76 #define MTIP_TAG_INTERNAL 0
78 /* Micron Vendor ID & P320x SSD Device ID */
79 #define PCI_VENDOR_ID_MICRON 0x1344
80 #define P320_DEVICE_ID 0x5150
82 /* Driver name and version strings */
83 #define MTIP_DRV_NAME "mtip32xx"
84 #define MTIP_DRV_VERSION "1.2.6os2"
86 /* Maximum number of minor device numbers per device. */
87 #define MTIP_MAX_MINORS 16
89 /* Maximum number of supported command slots. */
90 #define MTIP_MAX_COMMAND_SLOTS (MTIP_MAX_SLOT_GROUPS * 32)
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!
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)
104 /* BAR number used to access the HBA registers. */
105 #define MTIP_ABAR 5
107 /* Forced Unit Access Bit */
108 #define FUA_BIT 0x80
110 #ifdef DEBUG
111 #define dbg_printk(format, arg...) \
112 printk(pr_fmt(format), ##arg);
113 #else
114 #define dbg_printk(format, arg...)
115 #endif
117 /* Register Frame Information Structure (FIS), host to device. */
118 struct host_to_dev_fis {
120 * FIS type.
121 * - 27h Register FIS, host to device.
122 * - 34h Register FIS, device to host.
123 * - 39h DMA Activate FIS, device to host.
124 * - 41h DMA Setup FIS, bi-directional.
125 * - 46h Data FIS, bi-directional.
126 * - 58h BIST Activate FIS, bi-directional.
127 * - 5Fh PIO Setup FIS, device to host.
128 * - A1h Set Device Bits FIS, device to host.
130 unsigned char type;
131 unsigned char opts;
132 unsigned char command;
133 unsigned char features;
135 union {
136 unsigned char lba_low;
137 unsigned char sector;
139 union {
140 unsigned char lba_mid;
141 unsigned char cyl_low;
143 union {
144 unsigned char lba_hi;
145 unsigned char cyl_hi;
147 union {
148 unsigned char device;
149 unsigned char head;
152 union {
153 unsigned char lba_low_ex;
154 unsigned char sector_ex;
156 union {
157 unsigned char lba_mid_ex;
158 unsigned char cyl_low_ex;
160 union {
161 unsigned char lba_hi_ex;
162 unsigned char cyl_hi_ex;
164 unsigned char features_ex;
166 unsigned char sect_count;
167 unsigned char sect_cnt_ex;
168 unsigned char res2;
169 unsigned char control;
171 unsigned int res3;
174 /* Command header structure. */
175 struct mtip_cmd_hdr {
177 * Command options.
178 * - Bits 31:16 Number of PRD entries.
179 * - Bits 15:8 Unused in this implementation.
180 * - Bit 7 Prefetch bit, informs the drive to prefetch PRD entries.
181 * - Bit 6 Write bit, should be set when writing data to the device.
182 * - Bit 5 Unused in this implementation.
183 * - Bits 4:0 Length of the command FIS in DWords (DWord = 4 bytes).
185 unsigned int opts;
186 /* This field is unsed when using NCQ. */
187 union {
188 unsigned int byte_count;
189 unsigned int status;
192 * Lower 32 bits of the command table address associated with this
193 * header. The command table addresses must be 128 byte aligned.
195 unsigned int ctba;
197 * If 64 bit addressing is used this field is the upper 32 bits
198 * of the command table address associated with this command.
200 unsigned int ctbau;
201 /* Reserved and unused. */
202 unsigned int res[4];
205 /* Command scatter gather structure (PRD). */
206 struct mtip_cmd_sg {
208 * Low 32 bits of the data buffer address. For P320 this
209 * address must be 8 byte aligned signified by bits 2:0 being
210 * set to 0.
212 unsigned int dba;
214 * When 64 bit addressing is used this field is the upper
215 * 32 bits of the data buffer address.
217 unsigned int dba_upper;
218 /* Unused. */
219 unsigned int reserved;
221 * Bit 31: interrupt when this data block has been transferred.
222 * Bits 30..22: reserved
223 * Bits 21..0: byte count (minus 1). For P320 the byte count must be
224 * 8 byte aligned signified by bits 2:0 being set to 1.
226 unsigned int info;
228 struct mtip_port;
230 /* Structure used to describe a command. */
231 struct mtip_cmd {
233 struct mtip_cmd_hdr *command_header; /* ptr to command header entry */
235 dma_addr_t command_header_dma; /* corresponding physical address */
237 void *command; /* ptr to command table entry */
239 dma_addr_t command_dma; /* corresponding physical address */
241 void *comp_data; /* data passed to completion function comp_func() */
243 * Completion function called by the ISR upon completion of
244 * a command.
246 void (*comp_func)(struct mtip_port *port,
247 int tag,
248 void *data,
249 int status);
250 /* Additional callback function that may be called by comp_func() */
251 void (*async_callback)(void *data, int status);
253 void *async_data; /* Addl. data passed to async_callback() */
255 int scatter_ents; /* Number of scatter list entries used */
257 struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */
259 int retries; /* The number of retries left for this command. */
261 int direction; /* Data transfer direction */
263 unsigned long comp_time; /* command completion time, in jiffies */
265 atomic_t active; /* declares if this command sent to the drive. */
268 /* Structure used to describe a port. */
269 struct mtip_port {
270 /* Pointer back to the driver data for this port. */
271 struct driver_data *dd;
273 * Used to determine if the data pointed to by the
274 * identify field is valid.
276 unsigned long identify_valid;
277 /* Base address of the memory mapped IO for the port. */
278 void __iomem *mmio;
279 /* Array of pointers to the memory mapped s_active registers. */
280 void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
281 /* Array of pointers to the memory mapped completed registers. */
282 void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
283 /* Array of pointers to the memory mapped Command Issue registers. */
284 void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
286 * Pointer to the beginning of the command header memory as used
287 * by the driver.
289 void *command_list;
291 * Pointer to the beginning of the command header memory as used
292 * by the DMA.
294 dma_addr_t command_list_dma;
296 * Pointer to the beginning of the RX FIS memory as used
297 * by the driver.
299 void *rxfis;
301 * Pointer to the beginning of the RX FIS memory as used
302 * by the DMA.
304 dma_addr_t rxfis_dma;
306 * Pointer to the beginning of the command table memory as used
307 * by the driver.
309 void *command_table;
311 * Pointer to the beginning of the command table memory as used
312 * by the DMA.
314 dma_addr_t command_tbl_dma;
316 * Pointer to the beginning of the identify data memory as used
317 * by the driver.
319 u16 *identify;
321 * Pointer to the beginning of the identify data memory as used
322 * by the DMA.
324 dma_addr_t identify_dma;
326 * Pointer to the beginning of a sector buffer that is used
327 * by the driver when issuing internal commands.
329 u16 *sector_buffer;
331 * Pointer to the beginning of a sector buffer that is used
332 * by the DMA when the driver issues internal commands.
334 dma_addr_t sector_buffer_dma;
336 * Bit significant, used to determine if a command slot has
337 * been allocated. i.e. the slot is in use. Bits are cleared
338 * when the command slot and all associated data structures
339 * are no longer needed.
341 unsigned long allocated[SLOTBITS_IN_LONGS];
343 * Array of command slots. Structure includes pointers to the
344 * command header and command table, and completion function and data
345 * pointers.
347 struct mtip_cmd commands[MTIP_MAX_COMMAND_SLOTS];
348 /* Non-zero if an internal command is in progress. */
349 int internal_cmd_in_progress;
351 * Timer used to complete commands that have been active for too long.
353 struct timer_list cmd_timer;
355 * Semaphore used to block threads if there are no
356 * command slots available.
358 struct semaphore cmd_slot;
359 /* Spinlock for working around command-issue bug. */
360 spinlock_t cmd_issue_lock;
364 * Driver private data structure.
366 * One structure is allocated per probed device.
368 struct driver_data {
369 void __iomem *mmio; /* Base address of the HBA registers. */
371 int major; /* Major device number. */
373 int instance; /* Instance number. First device probed is 0, ... */
375 int protocol; /* FIXME: Protocol ops array index. */
377 struct gendisk *disk; /* Pointer to our gendisk structure. */
379 struct pci_dev *pdev; /* Pointer to the PCI device structure. */
381 struct request_queue *queue; /* Our request queue. */
383 * Semaphore used to lock out read/write commands during the
384 * execution of an internal command.
386 struct rw_semaphore internal_sem;
388 struct mtip_port *port; /* Pointer to the port data structure. */
390 /* Tasklet used to process the bottom half of the ISR. */
391 struct tasklet_struct tasklet;
393 unsigned product_type; /* magic value declaring the product type */
395 unsigned slot_groups; /* number of slot groups the product supports */
397 atomic_t drv_cleanup_done; /* Atomic variable for SRSI */
399 unsigned long index; /* Index to determine the disk name */
401 unsigned int ftlrebuildflag; /* FTL rebuild flag */
403 atomic_t resumeflag; /* Atomic variable to track suspend/resume */
405 atomic_t eh_active; /* Flag for error handling tracking */
408 /* Function declarations */
409 extern int mtip_block_initialize(struct driver_data *dd);
410 extern int mtip_block_remove(struct driver_data *dd);
411 extern int mtip_block_shutdown(struct driver_data *dd);
412 extern int mtip_block_suspend(struct driver_data *dd);
413 extern int mtip_block_resume(struct driver_data *dd);
414 extern int mtip_hw_init(struct driver_data *dd);
415 extern int mtip_hw_exit(struct driver_data *dd);
416 extern int mtip_hw_shutdown(struct driver_data *dd);
417 extern bool mtip_hw_get_capacity(struct driver_data *dd, sector_t *sectors);
418 extern void mtip_hw_release_scatterlist(
419 struct driver_data *dd,
420 int tag);
421 extern struct scatterlist *mtip_hw_get_scatterlist(
422 struct driver_data *dd,
423 int *tag);
424 extern void mtip_hw_submit_io(struct driver_data *dd,
425 sector_t start,
426 int nsect,
427 int nents,
428 int tag,
429 void *callback,
430 void *data,
431 int barrier,
432 int dir);
433 extern int mtip_hw_ioctl(struct driver_data *dd,
434 unsigned int cmd,
435 unsigned long arg,
436 unsigned char compat);
437 extern int mtip_hw_sysfs_init(struct driver_data *dd, struct kobject *kobj);
438 extern int mtip_hw_sysfs_exit(struct driver_data *dd, struct kobject *kobj);
439 extern int mtip_hw_resume(struct driver_data *dd);
440 extern int mtip_hw_suspend(struct driver_data *dd);
441 void mtip_command_cleanup(struct driver_data *dd);
442 bool mtip_check_surprise_removal(struct pci_dev *pdev);
443 void mtip_restart_port(struct mtip_port *port);
445 #endif