xref: /linux/drivers/scsi/megaraid/megaraid_mbox.h (revision 9b4f2e9576658c4e52d95dc8d309f51b2e2db096)
1 /*
2  *
3  *			Linux MegaRAID device driver
4  *
5  * Copyright (c) 2003-2004  LSI Logic Corporation.
6  *
7  *	   This program is free software; you can redistribute it and/or
8  *	   modify it under the terms of the GNU General Public License
9  *	   as published by the Free Software Foundation; either version
10  *	   2 of the License, or (at your option) any later version.
11  *
12  * FILE		: megaraid_mbox.h
13  */
14 
15 #ifndef _MEGARAID_H_
16 #define _MEGARAID_H_
17 
18 
19 #include "mega_common.h"
20 #include "mbox_defs.h"
21 #include "megaraid_ioctl.h"
22 
23 
24 #define MEGARAID_VERSION	"2.20.4.9"
25 #define MEGARAID_EXT_VERSION	"(Release Date: Sun Jul 16 12:27:22 EST 2006)"
26 
27 
28 /*
29  * Define some PCI values here until they are put in the kernel
30  */
31 #define PCI_DEVICE_ID_PERC4_DI_DISCOVERY		0x000E
32 #define PCI_SUBSYS_ID_PERC4_DI_DISCOVERY		0x0123
33 
34 #define PCI_DEVICE_ID_PERC4_SC				0x1960
35 #define PCI_SUBSYS_ID_PERC4_SC				0x0520
36 
37 #define PCI_DEVICE_ID_PERC4_DC				0x1960
38 #define PCI_SUBSYS_ID_PERC4_DC				0x0518
39 
40 #define PCI_DEVICE_ID_VERDE				0x0407
41 
42 #define PCI_DEVICE_ID_PERC4_DI_EVERGLADES		0x000F
43 #define PCI_SUBSYS_ID_PERC4_DI_EVERGLADES		0x014A
44 
45 #define PCI_DEVICE_ID_PERC4E_SI_BIGBEND			0x0013
46 #define PCI_SUBSYS_ID_PERC4E_SI_BIGBEND			0x016c
47 
48 #define PCI_DEVICE_ID_PERC4E_DI_KOBUK			0x0013
49 #define PCI_SUBSYS_ID_PERC4E_DI_KOBUK			0x016d
50 
51 #define PCI_DEVICE_ID_PERC4E_DI_CORVETTE		0x0013
52 #define PCI_SUBSYS_ID_PERC4E_DI_CORVETTE		0x016e
53 
54 #define PCI_DEVICE_ID_PERC4E_DI_EXPEDITION		0x0013
55 #define PCI_SUBSYS_ID_PERC4E_DI_EXPEDITION		0x016f
56 
57 #define PCI_DEVICE_ID_PERC4E_DI_GUADALUPE		0x0013
58 #define PCI_SUBSYS_ID_PERC4E_DI_GUADALUPE		0x0170
59 
60 #define PCI_DEVICE_ID_DOBSON				0x0408
61 
62 #define PCI_DEVICE_ID_MEGARAID_SCSI_320_0		0x1960
63 #define PCI_SUBSYS_ID_MEGARAID_SCSI_320_0		0xA520
64 
65 #define PCI_DEVICE_ID_MEGARAID_SCSI_320_1		0x1960
66 #define PCI_SUBSYS_ID_MEGARAID_SCSI_320_1		0x0520
67 
68 #define PCI_DEVICE_ID_MEGARAID_SCSI_320_2		0x1960
69 #define PCI_SUBSYS_ID_MEGARAID_SCSI_320_2		0x0518
70 
71 #define PCI_DEVICE_ID_MEGARAID_I4_133_RAID		0x1960
72 #define PCI_SUBSYS_ID_MEGARAID_I4_133_RAID		0x0522
73 
74 #define PCI_DEVICE_ID_MEGARAID_SATA_150_4		0x1960
75 #define PCI_SUBSYS_ID_MEGARAID_SATA_150_4		0x4523
76 
77 #define PCI_DEVICE_ID_MEGARAID_SATA_150_6		0x1960
78 #define PCI_SUBSYS_ID_MEGARAID_SATA_150_6		0x0523
79 
80 #define PCI_DEVICE_ID_LINDSAY				0x0409
81 
82 #define PCI_DEVICE_ID_INTEL_RAID_SRCS16			0x1960
83 #define PCI_SUBSYS_ID_INTEL_RAID_SRCS16			0x0523
84 
85 #define PCI_DEVICE_ID_INTEL_RAID_SRCU41L_LAKE_SHETEK	0x1960
86 #define PCI_SUBSYS_ID_INTEL_RAID_SRCU41L_LAKE_SHETEK	0x0520
87 
88 #define PCI_SUBSYS_ID_PERC3_QC				0x0471
89 #define PCI_SUBSYS_ID_PERC3_DC				0x0493
90 #define PCI_SUBSYS_ID_PERC3_SC				0x0475
91 
92 
93 #define MBOX_MAX_SCSI_CMDS	128	// number of cmds reserved for kernel
94 #define MBOX_MAX_USER_CMDS	32	// number of cmds for applications
95 #define MBOX_DEF_CMD_PER_LUN	64	// default commands per lun
96 #define MBOX_DEFAULT_SG_SIZE	26	// default sg size supported by all fw
97 #define MBOX_MAX_SG_SIZE	32	// maximum scatter-gather list size
98 #define MBOX_MAX_SECTORS	128	// maximum sectors per IO
99 #define MBOX_TIMEOUT		30	// timeout value for internal cmds
100 #define MBOX_BUSY_WAIT		10	// max usec to wait for busy mailbox
101 #define MBOX_RESET_WAIT		180	// wait these many seconds in reset
102 #define MBOX_RESET_EXT_WAIT	120	// extended wait reset
103 #define MBOX_SYNC_WAIT_CNT	0xFFFF	// wait loop index for synchronous mode
104 
105 #define MBOX_SYNC_DELAY_200	200	// 200 micro-seconds
106 
107 /*
108  * maximum transfer that can happen through the firmware commands issued
109  * internnaly from the driver.
110  */
111 #define MBOX_IBUF_SIZE		4096
112 
113 
114 /**
115  * mbox_ccb_t - command control block specific to mailbox based controllers
116  * @raw_mbox		: raw mailbox pointer
117  * @mbox		: mailbox
118  * @mbox64		: extended mailbox
119  * @mbox_dma_h		: maibox dma address
120  * @sgl64		: 64-bit scatter-gather list
121  * @sgl32		: 32-bit scatter-gather list
122  * @sgl_dma_h		: dma handle for the scatter-gather list
123  * @pthru		: passthru structure
124  * @pthru_dma_h		: dma handle for the passthru structure
125  * @epthru		: extended passthru structure
126  * @epthru_dma_h	: dma handle for extended passthru structure
127  * @buf_dma_h		: dma handle for buffers w/o sg list
128  *
129  * command control block specific to the mailbox based controllers
130  */
131 typedef struct {
132 	uint8_t			*raw_mbox;
133 	mbox_t			*mbox;
134 	mbox64_t		*mbox64;
135 	dma_addr_t		mbox_dma_h;
136 	mbox_sgl64		*sgl64;
137 	mbox_sgl32		*sgl32;
138 	dma_addr_t		sgl_dma_h;
139 	mraid_passthru_t	*pthru;
140 	dma_addr_t		pthru_dma_h;
141 	mraid_epassthru_t	*epthru;
142 	dma_addr_t		epthru_dma_h;
143 	dma_addr_t		buf_dma_h;
144 } mbox_ccb_t;
145 
146 
147 /**
148  * mraid_device_t - adapter soft state structure for mailbox controllers
149  * @param una_mbox64		: 64-bit mbox - unaligned
150  * @param una_mbox64_dma	: mbox dma addr - unaligned
151  * @param mbox			: 32-bit mbox - aligned
152  * @param mbox64		: 64-bit mbox - aligned
153  * @param mbox_dma		: mbox dma addr - aligned
154  * @param mailbox_lock		: exclusion lock for the mailbox
155  * @param baseport		: base port of hba memory
156  * @param baseaddr		: mapped addr of hba memory
157  * @param mbox_pool		: pool of mailboxes
158  * @param mbox_pool_handle	: handle for the mailbox pool memory
159  * @param epthru_pool		: a pool for extended passthru commands
160  * @param epthru_pool_handle	: handle to the pool above
161  * @param sg_pool		: pool of scatter-gather lists for this driver
162  * @param sg_pool_handle	: handle to the pool above
163  * @param ccb_list		: list of our command control blocks
164  * @param uccb_list		: list of cmd control blocks for mgmt module
165  * @param umbox64		: array of mailbox for user commands (cmm)
166  * @param pdrv_state		: array for state of each physical drive.
167  * @param last_disp		: flag used to show device scanning
168  * @param hw_error		: set if FW not responding
169  * @param fast_load		: If set, skip physical device scanning
170  * @channel_class		: channel class, RAID or SCSI
171  * @sysfs_sem			: semaphore to serialize access to sysfs res.
172  * @sysfs_uioc			: management packet to issue FW calls from sysfs
173  * @sysfs_mbox64		: mailbox packet to issue FW calls from sysfs
174  * @sysfs_buffer		: data buffer for FW commands issued from sysfs
175  * @sysfs_buffer_dma		: DMA buffer for FW commands issued from sysfs
176  * @sysfs_wait_q		: wait queue for sysfs operations
177  * @random_del_supported	: set if the random deletion is supported
178  * @curr_ldmap			: current LDID map
179  *
180  * Initialization structure for mailbox controllers: memory based and IO based
181  * All the fields in this structure are LLD specific and may be discovered at
182  * init() or start() time.
183  *
184  * NOTE: The fields of this structures are placed to minimize cache misses
185  */
186 #define MAX_LD_EXTENDED64	64
187 typedef struct {
188 	mbox64_t			*una_mbox64;
189 	dma_addr_t			una_mbox64_dma;
190 	mbox_t				*mbox;
191 	mbox64_t			*mbox64;
192 	dma_addr_t			mbox_dma;
193 	spinlock_t			mailbox_lock;
194 	unsigned long			baseport;
195 	void __iomem *			baseaddr;
196 	struct mraid_pci_blk		mbox_pool[MBOX_MAX_SCSI_CMDS];
197 	struct dma_pool			*mbox_pool_handle;
198 	struct mraid_pci_blk		epthru_pool[MBOX_MAX_SCSI_CMDS];
199 	struct dma_pool			*epthru_pool_handle;
200 	struct mraid_pci_blk		sg_pool[MBOX_MAX_SCSI_CMDS];
201 	struct dma_pool			*sg_pool_handle;
202 	mbox_ccb_t			ccb_list[MBOX_MAX_SCSI_CMDS];
203 	mbox_ccb_t			uccb_list[MBOX_MAX_USER_CMDS];
204 	mbox64_t			umbox64[MBOX_MAX_USER_CMDS];
205 
206 	uint8_t				pdrv_state[MBOX_MAX_PHYSICAL_DRIVES];
207 	uint32_t			last_disp;
208 	int				hw_error;
209 	int				fast_load;
210 	uint8_t				channel_class;
211 	struct semaphore		sysfs_sem;
212 	uioc_t				*sysfs_uioc;
213 	mbox64_t			*sysfs_mbox64;
214 	caddr_t				sysfs_buffer;
215 	dma_addr_t			sysfs_buffer_dma;
216 	wait_queue_head_t		sysfs_wait_q;
217 	int				random_del_supported;
218 	uint16_t			curr_ldmap[MAX_LD_EXTENDED64];
219 } mraid_device_t;
220 
221 // route to raid device from adapter
222 #define ADAP2RAIDDEV(adp)	((mraid_device_t *)((adp)->raid_device))
223 
224 #define MAILBOX_LOCK(rdev)	(&(rdev)->mailbox_lock)
225 
226 // Find out if this channel is a RAID or SCSI
227 #define IS_RAID_CH(rdev, ch)	(((rdev)->channel_class >> (ch)) & 0x01)
228 
229 
230 #define RDINDOOR(rdev)		readl((rdev)->baseaddr + 0x20)
231 #define RDOUTDOOR(rdev)		readl((rdev)->baseaddr + 0x2C)
232 #define WRINDOOR(rdev, value)	writel(value, (rdev)->baseaddr + 0x20)
233 #define WROUTDOOR(rdev, value)	writel(value, (rdev)->baseaddr + 0x2C)
234 
235 #endif // _MEGARAID_H_
236 
237 // vim: set ts=8 sw=8 tw=78:
238