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