[deliverable/linux.git] / drivers / block / mtip32xx / mtip32xx.h

/*
 * mtip32xx.h - Header file for the P320 SSD Block Driver
 *   Copyright (C) 2011 Micron Technology, Inc.
 *
 * Portions of this code were derived from works subjected to the
 * following copyright:
 *    Copyright (C) 2009 Integrated Device Technology, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */

#ifndef __MTIP32XX_H__
#define __MTIP32XX_H__

#include <linux/spinlock.h>
#include <linux/rwsem.h>
#include <linux/ata.h>
#include <linux/interrupt.h>
#include <linux/genhd.h>

/* Offset of Subsystem Device ID in pci confoguration space */
#define PCI_SUBSYSTEM_DEVICEID	0x2E

/* offset of Device Control register in PCIe extended capabilites space */
#define PCIE_CONFIG_EXT_DEVICE_CONTROL_OFFSET	0x48

/* # of times to retry timed out/failed IOs */
#define MTIP_MAX_RETRIES	2

/* Various timeout values in ms */
#define MTIP_NCQ_COMMAND_TIMEOUT_MS       5000
#define MTIP_IOCTL_COMMAND_TIMEOUT_MS     5000
#define MTIP_INTERNAL_COMMAND_TIMEOUT_MS  5000

/* check for timeouts every 500ms */
#define MTIP_TIMEOUT_CHECK_PERIOD	500

/* ftl rebuild */
#define MTIP_FTL_REBUILD_OFFSET		142
#define MTIP_FTL_REBUILD_MAGIC		0xED51
#define MTIP_FTL_REBUILD_TIMEOUT_MS	2400000

/* Macro to extract the tag bit number from a tag value. */
#define MTIP_TAG_BIT(tag)	(tag & 0x1F)

/*
 * Macro to extract the tag index from a tag value. The index
 * is used to access the correct s_active/Command Issue register based
 * on the tag value.
 */
#define MTIP_TAG_INDEX(tag)	(tag >> 5)

/*
 * Maximum number of scatter gather entries
 * a single command may have.
 */
#define MTIP_MAX_SG		128

/*
 * Maximum number of slot groups (Command Issue & s_active registers)
 * NOTE: This is the driver maximum; check dd->slot_groups for actual value.
 */
#define MTIP_MAX_SLOT_GROUPS	8

/* Internal command tag. */
#define MTIP_TAG_INTERNAL	0

/* Micron Vendor ID & P320x SSD Device ID */
#define PCI_VENDOR_ID_MICRON    0x1344
#define P320_DEVICE_ID		0x5150

/* Driver name and version strings */
#define MTIP_DRV_NAME		"mtip32xx"
#define MTIP_DRV_VERSION	"1.2.6os3"

/* Maximum number of minor device numbers per device. */
#define MTIP_MAX_MINORS		16

/* Maximum number of supported command slots. */
#define MTIP_MAX_COMMAND_SLOTS	(MTIP_MAX_SLOT_GROUPS * 32)

/*
 * Per-tag bitfield size in longs.
 * Linux bit manipulation functions
 * (i.e. test_and_set_bit, find_next_zero_bit)
 * manipulate memory in longs, so we try to make the math work.
 * take the slot groups and find the number of longs, rounding up.
 * Careful! i386 and x86_64 use different size longs!
 */
#define U32_PER_LONG	(sizeof(long) / sizeof(u32))
#define SLOTBITS_IN_LONGS ((MTIP_MAX_SLOT_GROUPS + \
					(U32_PER_LONG-1))/U32_PER_LONG)

/* BAR number used to access the HBA registers. */
#define MTIP_ABAR		5

#ifdef DEBUG
 #define dbg_printk(format, arg...)	\
	printk(pr_fmt(format), ##arg);
#else
 #define dbg_printk(format, arg...)
#endif

#define MTIP_DFS_MAX_BUF_SIZE 1024

#define __force_bit2int (unsigned int __force)

enum {
	/* below are bit numbers in 'flags' defined in mtip_port */
	MTIP_PF_IC_ACTIVE_BIT       = 0, /* pio/ioctl */
	MTIP_PF_EH_ACTIVE_BIT       = 1, /* error handling */
	MTIP_PF_SE_ACTIVE_BIT       = 2, /* secure erase */
	MTIP_PF_DM_ACTIVE_BIT       = 3, /* download microcde */
	MTIP_PF_PAUSE_IO      =	((1 << MTIP_PF_IC_ACTIVE_BIT) | \
				(1 << MTIP_PF_EH_ACTIVE_BIT) | \
				(1 << MTIP_PF_SE_ACTIVE_BIT) | \
				(1 << MTIP_PF_DM_ACTIVE_BIT)),

	MTIP_PF_SVC_THD_ACTIVE_BIT  = 4,
	MTIP_PF_ISSUE_CMDS_BIT      = 5,
	MTIP_PF_REBUILD_BIT         = 6,
	MTIP_PF_SVC_THD_STOP_BIT    = 8,

	/* below are bit numbers in 'dd_flag' defined in driver_data */
	MTIP_DDF_REMOVE_PENDING_BIT = 1,
	MTIP_DDF_OVER_TEMP_BIT      = 2,
	MTIP_DDF_WRITE_PROTECT_BIT  = 3,
	MTIP_DDF_STOP_IO      = ((1 << MTIP_DDF_REMOVE_PENDING_BIT) | \
				(1 << MTIP_DDF_OVER_TEMP_BIT) | \
				(1 << MTIP_DDF_WRITE_PROTECT_BIT)),

	MTIP_DDF_CLEANUP_BIT        = 5,
	MTIP_DDF_RESUME_BIT         = 6,
	MTIP_DDF_INIT_DONE_BIT      = 7,
	MTIP_DDF_REBUILD_FAILED_BIT = 8,
};

__packed struct smart_attr{
	u8 attr_id;
	u16 flags;
	u8 cur;
	u8 worst;
	u32 data;
	u8 res[3];
};

/* Register Frame Information Structure (FIS), host to device. */
struct host_to_dev_fis {
	/*
	 * FIS type.
	 * - 27h Register FIS, host to device.
	 * - 34h Register FIS, device to host.
	 * - 39h DMA Activate FIS, device to host.
	 * - 41h DMA Setup FIS, bi-directional.
	 * - 46h Data FIS, bi-directional.
	 * - 58h BIST Activate FIS, bi-directional.
	 * - 5Fh PIO Setup FIS, device to host.
	 * - A1h Set Device Bits FIS, device to host.
	 */
	unsigned char type;
	unsigned char opts;
	unsigned char command;
	unsigned char features;

	union {
		unsigned char lba_low;
		unsigned char sector;
	};
	union {
		unsigned char lba_mid;
		unsigned char cyl_low;
	};
	union {
		unsigned char lba_hi;
		unsigned char cyl_hi;
	};
	union {
		unsigned char device;
		unsigned char head;
	};

	union {
		unsigned char lba_low_ex;
		unsigned char sector_ex;
	};
	union {
		unsigned char lba_mid_ex;
		unsigned char cyl_low_ex;
	};
	union {
		unsigned char lba_hi_ex;
		unsigned char cyl_hi_ex;
	};
	unsigned char features_ex;

	unsigned char sect_count;
	unsigned char sect_cnt_ex;
	unsigned char res2;
	unsigned char control;

	unsigned int res3;
};

/* Command header structure. */
struct mtip_cmd_hdr {
	/*
	 * Command options.
	 * - Bits 31:16 Number of PRD entries.
	 * - Bits 15:8 Unused in this implementation.
	 * - Bit 7 Prefetch bit, informs the drive to prefetch PRD entries.
	 * - Bit 6 Write bit, should be set when writing data to the device.
	 * - Bit 5 Unused in this implementation.
	 * - Bits 4:0 Length of the command FIS in DWords (DWord = 4 bytes).
	 */
	unsigned int opts;
	/* This field is unsed when using NCQ. */
	union {
		unsigned int byte_count;
		unsigned int status;
	};
	/*
	 * Lower 32 bits of the command table address associated with this
	 * header. The command table addresses must be 128 byte aligned.
	 */
	unsigned int ctba;
	/*
	 * If 64 bit addressing is used this field is the upper 32 bits
	 * of the command table address associated with this command.
	 */
	unsigned int ctbau;
	/* Reserved and unused. */
	unsigned int res[4];
};

/* Command scatter gather structure (PRD). */
struct mtip_cmd_sg {
	/*
	 * Low 32 bits of the data buffer address. For P320 this
	 * address must be 8 byte aligned signified by bits 2:0 being
	 * set to 0.
	 */
	unsigned int dba;
	/*
	 * When 64 bit addressing is used this field is the upper
	 * 32 bits of the data buffer address.
	 */
	unsigned int dba_upper;
	/* Unused. */
	unsigned int reserved;
	/*
	 * Bit 31: interrupt when this data block has been transferred.
	 * Bits 30..22: reserved
	 * Bits 21..0: byte count (minus 1).  For P320 the byte count must be
	 * 8 byte aligned signified by bits 2:0 being set to 1.
	 */
	unsigned int info;
};
struct mtip_port;

/* Structure used to describe a command. */
struct mtip_cmd {

	struct mtip_cmd_hdr *command_header; /* ptr to command header entry */

	dma_addr_t command_header_dma; /* corresponding physical address */

	void *command; /* ptr to command table entry */

	dma_addr_t command_dma; /* corresponding physical address */

	void *comp_data; /* data passed to completion function comp_func() */
	/*
	 * Completion function called by the ISR upon completion of
	 * a command.
	 */
	void (*comp_func)(struct mtip_port *port,
				int tag,
				void *data,
				int status);
	/* Additional callback function that may be called by comp_func() */
	void (*async_callback)(void *data, int status);

	void *async_data; /* Addl. data passed to async_callback() */

	int scatter_ents; /* Number of scatter list entries used */

	struct scatterlist sg[MTIP_MAX_SG]; /* Scatter list entries */

	int retries; /* The number of retries left for this command. */

	int direction; /* Data transfer direction */

	unsigned long comp_time; /* command completion time, in jiffies */

	atomic_t active; /* declares if this command sent to the drive. */
};

/* Structure used to describe a port. */
struct mtip_port {
	/* Pointer back to the driver data for this port. */
	struct driver_data *dd;
	/*
	 * Used to determine if the data pointed to by the
	 * identify field is valid.
	 */
	unsigned long identify_valid;
	/* Base address of the memory mapped IO for the port. */
	void __iomem *mmio;
	/* Array of pointers to the memory mapped s_active registers. */
	void __iomem *s_active[MTIP_MAX_SLOT_GROUPS];
	/* Array of pointers to the memory mapped completed registers. */
	void __iomem *completed[MTIP_MAX_SLOT_GROUPS];
	/* Array of pointers to the memory mapped Command Issue registers. */
	void __iomem *cmd_issue[MTIP_MAX_SLOT_GROUPS];
	/*
	 * Pointer to the beginning of the command header memory as used
	 * by the driver.
	 */
	void *command_list;
	/*
	 * Pointer to the beginning of the command header memory as used
	 * by the DMA.
	 */
	dma_addr_t command_list_dma;
	/*
	 * Pointer to the beginning of the RX FIS memory as used
	 * by the driver.
	 */
	void *rxfis;
	/*
	 * Pointer to the beginning of the RX FIS memory as used
	 * by the DMA.
	 */
	dma_addr_t rxfis_dma;
	/*
	 * Pointer to the beginning of the command table memory as used
	 * by the driver.
	 */
	void *command_table;
	/*
	 * Pointer to the beginning of the command table memory as used
	 * by the DMA.
	 */
	dma_addr_t command_tbl_dma;
	/*
	 * Pointer to the beginning of the identify data memory as used
	 * by the driver.
	 */
	u16 *identify;
	/*
	 * Pointer to the beginning of the identify data memory as used
	 * by the DMA.
	 */
	dma_addr_t identify_dma;
	/*
	 * Pointer to the beginning of a sector buffer that is used
	 * by the driver when issuing internal commands.
	 */
	u16 *sector_buffer;
	/*
	 * Pointer to the beginning of a sector buffer that is used
	 * by the DMA when the driver issues internal commands.
	 */
	dma_addr_t sector_buffer_dma;
	/*
	 * Bit significant, used to determine if a command slot has
	 * been allocated. i.e. the slot is in use.  Bits are cleared
	 * when the command slot and all associated data structures
	 * are no longer needed.
	 */
	u16 *log_buf;
	dma_addr_t log_buf_dma;

	u8 *smart_buf;
	dma_addr_t smart_buf_dma;

	unsigned long allocated[SLOTBITS_IN_LONGS];
	/*
	 * used to queue commands when an internal command is in progress
	 * or error handling is active
	 */
	unsigned long cmds_to_issue[SLOTBITS_IN_LONGS];
	/*
	 * Array of command slots. Structure includes pointers to the
	 * command header and command table, and completion function and data
	 * pointers.
	 */
	struct mtip_cmd commands[MTIP_MAX_COMMAND_SLOTS];
	/* Used by mtip_service_thread to wait for an event */
	wait_queue_head_t svc_wait;
	/*
	 * indicates the state of the port. Also, helps the service thread
	 * to determine its action on wake up.
	 */
	unsigned long flags;
	/*
	 * Timer used to complete commands that have been active for too long.
	 */
	struct timer_list cmd_timer;
	unsigned long ic_pause_timer;
	/*
	 * Semaphore used to block threads if there are no
	 * command slots available.
	 */
	struct semaphore cmd_slot;
	/* Spinlock for working around command-issue bug. */
	spinlock_t cmd_issue_lock;
};

/*
 * Driver private data structure.
 *
 * One structure is allocated per probed device.
 */
struct driver_data {
	void __iomem *mmio; /* Base address of the HBA registers. */

	int major; /* Major device number. */

	int instance; /* Instance number. First device probed is 0, ... */

	struct gendisk *disk; /* Pointer to our gendisk structure. */

	struct pci_dev *pdev; /* Pointer to the PCI device structure. */

	struct request_queue *queue; /* Our request queue. */

	struct mtip_port *port; /* Pointer to the port data structure. */

	/* Tasklet used to process the bottom half of the ISR. */
	struct tasklet_struct tasklet;

	unsigned product_type; /* magic value declaring the product type */

	unsigned slot_groups; /* number of slot groups the product supports */

	unsigned long index; /* Index to determine the disk name */

	unsigned long dd_flag; /* NOTE: use atomic bit operations on this */

	struct task_struct *mtip_svc_handler; /* task_struct of svc thd */

	struct dentry *dfs_node;
};

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