]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - drivers/block/mtip32xx/mtip32xx.h
933192abe178ed1f49f558fc547cbe42f8735988
[~shefty/rdma-dev.git] / 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 IOs */
38 #define MTIP_MAX_RETRIES        5
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 /* Forced Unit Access Bit */
108 #define FUA_BIT                 0x80
109
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
116
117 #define __force_bit2int (unsigned int __force)
118
119 /* below are bit numbers in 'flags' defined in mtip_port */
120 #define MTIP_FLAG_IC_ACTIVE_BIT                 0
121 #define MTIP_FLAG_EH_ACTIVE_BIT                 1
122 #define MTIP_FLAG_SVC_THD_ACTIVE_BIT            2
123 #define MTIP_FLAG_ISSUE_CMDS_BIT                4
124 #define MTIP_FLAG_SVC_THD_SHOULD_STOP_BIT       8
125
126 /* Register Frame Information Structure (FIS), host to device. */
127 struct host_to_dev_fis {
128         /*
129          * FIS type.
130          * - 27h Register FIS, host to device.
131          * - 34h Register FIS, device to host.
132          * - 39h DMA Activate FIS, device to host.
133          * - 41h DMA Setup FIS, bi-directional.
134          * - 46h Data FIS, bi-directional.
135          * - 58h BIST Activate FIS, bi-directional.
136          * - 5Fh PIO Setup FIS, device to host.
137          * - A1h Set Device Bits FIS, device to host.
138          */
139         unsigned char type;
140         unsigned char opts;
141         unsigned char command;
142         unsigned char features;
143
144         union {
145                 unsigned char lba_low;
146                 unsigned char sector;
147         };
148         union {
149                 unsigned char lba_mid;
150                 unsigned char cyl_low;
151         };
152         union {
153                 unsigned char lba_hi;
154                 unsigned char cyl_hi;
155         };
156         union {
157                 unsigned char device;
158                 unsigned char head;
159         };
160
161         union {
162                 unsigned char lba_low_ex;
163                 unsigned char sector_ex;
164         };
165         union {
166                 unsigned char lba_mid_ex;
167                 unsigned char cyl_low_ex;
168         };
169         union {
170                 unsigned char lba_hi_ex;
171                 unsigned char cyl_hi_ex;
172         };
173         unsigned char features_ex;
174
175         unsigned char sect_count;
176         unsigned char sect_cnt_ex;
177         unsigned char res2;
178         unsigned char control;
179
180         unsigned int res3;
181 };
182
183 /* Command header structure. */
184 struct mtip_cmd_hdr {
185         /*
186          * Command options.
187          * - Bits 31:16 Number of PRD entries.
188          * - Bits 15:8 Unused in this implementation.
189          * - Bit 7 Prefetch bit, informs the drive to prefetch PRD entries.
190          * - Bit 6 Write bit, should be set when writing data to the device.
191          * - Bit 5 Unused in this implementation.
192          * - Bits 4:0 Length of the command FIS in DWords (DWord = 4 bytes).
193          */
194         unsigned int opts;
195         /* This field is unsed when using NCQ. */
196         union {
197                 unsigned int byte_count;
198                 unsigned int status;
199         };
200         /*
201          * Lower 32 bits of the command table address associated with this
202          * header. The command table addresses must be 128 byte aligned.
203          */
204         unsigned int ctba;
205         /*
206          * If 64 bit addressing is used this field is the upper 32 bits
207          * of the command table address associated with this command.
208          */
209         unsigned int ctbau;
210         /* Reserved and unused. */
211         unsigned int res[4];
212 };
213
214 /* Command scatter gather structure (PRD). */
215 struct mtip_cmd_sg {
216         /*
217          * Low 32 bits of the data buffer address. For P320 this
218          * address must be 8 byte aligned signified by bits 2:0 being
219          * set to 0.
220          */
221         unsigned int dba;
222         /*
223          * When 64 bit addressing is used this field is the upper
224          * 32 bits of the data buffer address.
225          */
226         unsigned int dba_upper;
227         /* Unused. */
228         unsigned int reserved;
229         /*
230          * Bit 31: interrupt when this data block has been transferred.
231          * Bits 30..22: reserved
232          * Bits 21..0: byte count (minus 1).  For P320 the byte count must be
233          * 8 byte aligned signified by bits 2:0 being set to 1.
234          */
235         unsigned int info;
236 };
237 struct mtip_port;
238
239 /* Structure used to describe a command. */
240 struct mtip_cmd {
241
242         struct mtip_cmd_hdr *command_header; /* ptr to command header entry */
243
244         dma_addr_t command_header_dma; /* corresponding physical address */
245
246         void *command; /* ptr to command table entry */
247
248         dma_addr_t command_dma; /* corresponding physical address */
249
250         void *comp_data; /* data passed to completion function comp_func() */
251         /*
252          * Completion function called by the ISR upon completion of
253          * a command.
254          */
255         void (*comp_func)(struct mtip_port *port,
256                                 int tag,
257                                 void *data,
258                                 int status);
259         /* Additional callback function that may be called by comp_func() */
260         void (*async_callback)(void *data, int status);
261
262         void *async_data; /* Addl. data passed to async_callback() */
263
264         int scatter_ents; /* Number of scatter list entries used */
265
266         struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */
267
268         int retries; /* The number of retries left for this command. */
269
270         int direction; /* Data transfer direction */
271
272         unsigned long comp_time; /* command completion time, in jiffies */
273
274         atomic_t active; /* declares if this command sent to the drive. */
275 };
276
277 /* Structure used to describe a port. */
278 struct mtip_port {
279         /* Pointer back to the driver data for this port. */
280         struct driver_data *dd;
281         /*
282          * Used to determine if the data pointed to by the
283          * identify field is valid.
284          */
285         unsigned long identify_valid;
286         /* Base address of the memory mapped IO for the port. */
287         void __iomem *mmio;
288         /* Array of pointers to the memory mapped s_active registers. */
289         void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
290         /* Array of pointers to the memory mapped completed registers. */
291         void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
292         /* Array of pointers to the memory mapped Command Issue registers. */
293         void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
294         /*
295          * Pointer to the beginning of the command header memory as used
296          * by the driver.
297          */
298         void *command_list;
299         /*
300          * Pointer to the beginning of the command header memory as used
301          * by the DMA.
302          */
303         dma_addr_t command_list_dma;
304         /*
305          * Pointer to the beginning of the RX FIS memory as used
306          * by the driver.
307          */
308         void *rxfis;
309         /*
310          * Pointer to the beginning of the RX FIS memory as used
311          * by the DMA.
312          */
313         dma_addr_t rxfis_dma;
314         /*
315          * Pointer to the beginning of the command table memory as used
316          * by the driver.
317          */
318         void *command_table;
319         /*
320          * Pointer to the beginning of the command table memory as used
321          * by the DMA.
322          */
323         dma_addr_t command_tbl_dma;
324         /*
325          * Pointer to the beginning of the identify data memory as used
326          * by the driver.
327          */
328         u16 *identify;
329         /*
330          * Pointer to the beginning of the identify data memory as used
331          * by the DMA.
332          */
333         dma_addr_t identify_dma;
334         /*
335          * Pointer to the beginning of a sector buffer that is used
336          * by the driver when issuing internal commands.
337          */
338         u16 *sector_buffer;
339         /*
340          * Pointer to the beginning of a sector buffer that is used
341          * by the DMA when the driver issues internal commands.
342          */
343         dma_addr_t sector_buffer_dma;
344         /*
345          * Bit significant, used to determine if a command slot has
346          * been allocated. i.e. the slot is in use.  Bits are cleared
347          * when the command slot and all associated data structures
348          * are no longer needed.
349          */
350         unsigned long allocated[SLOTBITS_IN_LONGS];
351         /*
352          * used to queue commands when an internal command is in progress
353          * or error handling is active
354          */
355         unsigned long cmds_to_issue[SLOTBITS_IN_LONGS];
356         /*
357          * Array of command slots. Structure includes pointers to the
358          * command header and command table, and completion function and data
359          * pointers.
360          */
361         struct mtip_cmd commands[MTIP_MAX_COMMAND_SLOTS];
362         /* Used by mtip_service_thread to wait for an event */
363         wait_queue_head_t svc_wait;
364         /*
365          * indicates the state of the port. Also, helps the service thread
366          * to determine its action on wake up.
367          */
368         unsigned long flags;
369         /*
370          * Timer used to complete commands that have been active for too long.
371          */
372         struct timer_list cmd_timer;
373         /*
374          * Semaphore used to block threads if there are no
375          * command slots available.
376          */
377         struct semaphore cmd_slot;
378         /* Spinlock for working around command-issue bug. */
379         spinlock_t cmd_issue_lock;
380 };
381
382 /*
383  * Driver private data structure.
384  *
385  * One structure is allocated per probed device.
386  */
387 struct driver_data {
388         void __iomem *mmio; /* Base address of the HBA registers. */
389
390         int major; /* Major device number. */
391
392         int instance; /* Instance number. First device probed is 0, ... */
393
394         struct gendisk *disk; /* Pointer to our gendisk structure. */
395
396         struct pci_dev *pdev; /* Pointer to the PCI device structure. */
397
398         struct request_queue *queue; /* Our request queue. */
399
400         struct mtip_port *port; /* Pointer to the port data structure. */
401
402         /* Tasklet used to process the bottom half of the ISR. */
403         struct tasklet_struct tasklet;
404
405         unsigned product_type; /* magic value declaring the product type */
406
407         unsigned slot_groups; /* number of slot groups the product supports */
408
409         atomic_t drv_cleanup_done; /* Atomic variable for SRSI */
410
411         unsigned long index; /* Index to determine the disk name */
412
413         unsigned int ftlrebuildflag; /* FTL rebuild flag */
414
415         atomic_t resumeflag; /* Atomic variable to track suspend/resume */
416
417         atomic_t eh_active; /* Flag for error handling tracking */
418
419         struct task_struct *mtip_svc_handler; /* task_struct of svc thd */
420 };
421
422 #endif