1 /***************************************************************************
2                           dpti.h  -  description
3                              -------------------
4     begin                : Thu Sep 7 2000
5     copyright            : (C) 2001 by Adaptec
6 
7     See Documentation/scsi/dpti.txt for history, notes, license info
8     and credits
9  ***************************************************************************/
10 
11 /***************************************************************************
12  *                                                                         *
13  *   This program is free software; you can redistribute it and/or modify  *
14  *   it under the terms of the GNU General Public License as published by  *
15  *   the Free Software Foundation; either version 2 of the License, or     *
16  *   (at your option) any later version.                                   *
17  *                                                                         *
18  ***************************************************************************/
19 
20 #ifndef _DPT_H
21 #define _DPT_H
22 
23 #define MAX_TO_IOP_MESSAGES   (255)
24 #define MAX_FROM_IOP_MESSAGES (255)
25 
26 
27 /*
28  * SCSI interface function Prototypes
29  */
30 
31 static int adpt_detect(struct scsi_host_template * sht);
32 static int adpt_queue(struct Scsi_Host *h, struct scsi_cmnd * cmd);
33 static int adpt_abort(struct scsi_cmnd * cmd);
34 static int adpt_reset(struct scsi_cmnd* cmd);
35 static int adpt_release(struct Scsi_Host *host);
36 static int adpt_slave_configure(struct scsi_device *);
37 
38 static const char *adpt_info(struct Scsi_Host *pSHost);
39 static int adpt_bios_param(struct scsi_device * sdev, struct block_device *dev,
40 		sector_t, int geom[]);
41 
42 static int adpt_bus_reset(struct scsi_cmnd* cmd);
43 static int adpt_device_reset(struct scsi_cmnd* cmd);
44 
45 
46 /*
47  * struct scsi_host_template (see scsi/scsi_host.h)
48  */
49 
50 #define DPT_DRIVER_NAME	"Adaptec I2O RAID"
51 
52 #ifndef HOSTS_C
53 
54 #include "dpt/sys_info.h"
55 #include <linux/wait.h>
56 #include "dpt/dpti_i2o.h"
57 #include "dpt/dpti_ioctl.h"
58 
59 #define DPT_I2O_VERSION "2.4 Build 5go"
60 #define DPT_VERSION     2
61 #define DPT_REVISION    '4'
62 #define DPT_SUBREVISION '5'
63 #define DPT_BETA	""
64 #define DPT_MONTH      8
65 #define DPT_DAY        7
66 #define DPT_YEAR        (2001-1980)
67 
68 #define DPT_DRIVER	"dpt_i2o"
69 #define DPTI_I2O_MAJOR	(151)
70 #define DPT_ORGANIZATION_ID (0x1B)        /* For Private Messages */
71 #define DPTI_MAX_HBA	(16)
72 #define MAX_CHANNEL     (5)	// Maximum Channel # Supported
73 #define MAX_ID        	(128)	// Maximum Target ID Supported
74 
75 /* Sizes in 4 byte words */
76 #define REPLY_FRAME_SIZE  (17)
77 #define MAX_MESSAGE_SIZE  (128)
78 #define SG_LIST_ELEMENTS  (56)
79 
80 #define EMPTY_QUEUE           0xffffffff
81 #define I2O_INTERRUPT_PENDING_B   (0x08)
82 
83 #define PCI_DPT_VENDOR_ID         (0x1044)	// DPT PCI Vendor ID
84 #define PCI_DPT_DEVICE_ID         (0xA501)	// DPT PCI I2O Device ID
85 #define PCI_DPT_RAPTOR_DEVICE_ID  (0xA511)
86 
87 /* Debugging macro from Linux Device Drivers - Rubini */
88 #undef PDEBUG
89 #ifdef DEBUG
90 //TODO add debug level switch
91 #  define PDEBUG(fmt, args...)  printk(KERN_DEBUG "dpti: " fmt, ##args)
92 #  define PDEBUGV(fmt, args...) printk(KERN_DEBUG "dpti: " fmt, ##args)
93 #else
94 # define PDEBUG(fmt, args...) /* not debugging: nothing */
95 # define PDEBUGV(fmt, args...) /* not debugging: nothing */
96 #endif
97 
98 #define PERROR(fmt, args...) printk(KERN_ERR fmt, ##args)
99 #define PWARN(fmt, args...) printk(KERN_WARNING fmt, ##args)
100 #define PINFO(fmt, args...) printk(KERN_INFO fmt, ##args)
101 #define PCRIT(fmt, args...) printk(KERN_CRIT fmt, ##args)
102 
103 #define SHUTDOWN_SIGS	(sigmask(SIGKILL)|sigmask(SIGINT)|sigmask(SIGTERM))
104 
105 // Command timeouts
106 #define FOREVER			(0)
107 #define TMOUT_INQUIRY 		(20)
108 #define TMOUT_FLUSH		(360/45)
109 #define TMOUT_ABORT		(30)
110 #define TMOUT_SCSI		(300)
111 #define TMOUT_IOPRESET		(360)
112 #define TMOUT_GETSTATUS		(15)
113 #define TMOUT_INITOUTBOUND	(15)
114 #define TMOUT_LCT		(360)
115 
116 
117 #define I2O_SCSI_DEVICE_DSC_MASK                0x00FF
118 
119 #define I2O_DETAIL_STATUS_UNSUPPORTED_FUNCTION  0x000A
120 
121 #define I2O_SCSI_DSC_MASK                   0xFF00
122 #define I2O_SCSI_DSC_SUCCESS                0x0000
123 #define I2O_SCSI_DSC_REQUEST_ABORTED        0x0200
124 #define I2O_SCSI_DSC_UNABLE_TO_ABORT        0x0300
125 #define I2O_SCSI_DSC_COMPLETE_WITH_ERROR    0x0400
126 #define I2O_SCSI_DSC_ADAPTER_BUSY           0x0500
127 #define I2O_SCSI_DSC_REQUEST_INVALID        0x0600
128 #define I2O_SCSI_DSC_PATH_INVALID           0x0700
129 #define I2O_SCSI_DSC_DEVICE_NOT_PRESENT     0x0800
130 #define I2O_SCSI_DSC_UNABLE_TO_TERMINATE    0x0900
131 #define I2O_SCSI_DSC_SELECTION_TIMEOUT      0x0A00
132 #define I2O_SCSI_DSC_COMMAND_TIMEOUT        0x0B00
133 #define I2O_SCSI_DSC_MR_MESSAGE_RECEIVED    0x0D00
134 #define I2O_SCSI_DSC_SCSI_BUS_RESET         0x0E00
135 #define I2O_SCSI_DSC_PARITY_ERROR_FAILURE   0x0F00
136 #define I2O_SCSI_DSC_AUTOSENSE_FAILED       0x1000
137 #define I2O_SCSI_DSC_NO_ADAPTER             0x1100
138 #define I2O_SCSI_DSC_DATA_OVERRUN           0x1200
139 #define I2O_SCSI_DSC_UNEXPECTED_BUS_FREE    0x1300
140 #define I2O_SCSI_DSC_SEQUENCE_FAILURE       0x1400
141 #define I2O_SCSI_DSC_REQUEST_LENGTH_ERROR   0x1500
142 #define I2O_SCSI_DSC_PROVIDE_FAILURE        0x1600
143 #define I2O_SCSI_DSC_BDR_MESSAGE_SENT       0x1700
144 #define I2O_SCSI_DSC_REQUEST_TERMINATED     0x1800
145 #define I2O_SCSI_DSC_IDE_MESSAGE_SENT       0x3300
146 #define I2O_SCSI_DSC_RESOURCE_UNAVAILABLE   0x3400
147 #define I2O_SCSI_DSC_UNACKNOWLEDGED_EVENT   0x3500
148 #define I2O_SCSI_DSC_MESSAGE_RECEIVED       0x3600
149 #define I2O_SCSI_DSC_INVALID_CDB            0x3700
150 #define I2O_SCSI_DSC_LUN_INVALID            0x3800
151 #define I2O_SCSI_DSC_SCSI_TID_INVALID       0x3900
152 #define I2O_SCSI_DSC_FUNCTION_UNAVAILABLE   0x3A00
153 #define I2O_SCSI_DSC_NO_NEXUS               0x3B00
154 #define I2O_SCSI_DSC_SCSI_IID_INVALID       0x3C00
155 #define I2O_SCSI_DSC_CDB_RECEIVED           0x3D00
156 #define I2O_SCSI_DSC_LUN_ALREADY_ENABLED    0x3E00
157 #define I2O_SCSI_DSC_BUS_BUSY               0x3F00
158 #define I2O_SCSI_DSC_QUEUE_FROZEN           0x4000
159 
160 
161 #ifndef TRUE
162 #define TRUE                  1
163 #define FALSE                 0
164 #endif
165 
166 #define HBA_FLAGS_INSTALLED_B       0x00000001	// Adapter Was Installed
167 #define HBA_FLAGS_BLINKLED_B        0x00000002	// Adapter In Blink LED State
168 #define HBA_FLAGS_IN_RESET	0x00000040	/* in reset */
169 #define HBA_HOSTRESET_FAILED	0x00000080	/* adpt_resethost failed */
170 
171 
172 // Device state flags
173 #define DPTI_DEV_ONLINE    0x00
174 #define DPTI_DEV_UNSCANNED 0x01
175 #define DPTI_DEV_RESET	   0x02
176 #define DPTI_DEV_OFFLINE   0x04
177 
178 
179 struct adpt_device {
180 	struct adpt_device* next_lun;
181 	u32	flags;
182 	u32	type;
183 	u32	capacity;
184 	u32	block_size;
185 	u8	scsi_channel;
186 	u8	scsi_id;
187 	u8 	scsi_lun;
188 	u8	state;
189 	u16	tid;
190 	struct i2o_device* pI2o_dev;
191 	struct scsi_device *pScsi_dev;
192 };
193 
194 struct adpt_channel {
195 	struct adpt_device* device[MAX_ID];	/* used as an array of 128 scsi ids */
196 	u8	scsi_id;
197 	u8	type;
198 	u16	tid;
199 	u32	state;
200 	struct i2o_device* pI2o_dev;
201 };
202 
203 // HBA state flags
204 #define DPTI_STATE_RESET	(0x01)
205 #define DPTI_STATE_IOCTL	(0x02)
206 
207 typedef struct _adpt_hba {
208 	struct _adpt_hba *next;
209 	struct pci_dev *pDev;
210 	struct Scsi_Host *host;
211 	u32 state;
212 	spinlock_t state_lock;
213 	int unit;
214 	int host_no;		/* SCSI host number */
215 	u8 initialized;
216 	u8 in_use;		/* is the management node open*/
217 
218 	char name[32];
219 	char detail[55];
220 
221 	void __iomem *base_addr_virt;
222 	void __iomem *msg_addr_virt;
223 	ulong base_addr_phys;
224 	void __iomem *post_port;
225 	void __iomem *reply_port;
226 	void __iomem *irq_mask;
227 	u16  post_count;
228 	u32  post_fifo_size;
229 	u32  reply_fifo_size;
230 	u32* reply_pool;
231 	dma_addr_t reply_pool_pa;
232 	u32  sg_tablesize;	// Scatter/Gather List Size.
233 	u8  top_scsi_channel;
234 	u8  top_scsi_id;
235 	u8  top_scsi_lun;
236 	u8  dma64;
237 
238 	i2o_status_block* status_block;
239 	dma_addr_t status_block_pa;
240 	i2o_hrt* hrt;
241 	dma_addr_t hrt_pa;
242 	i2o_lct* lct;
243 	dma_addr_t lct_pa;
244 	uint lct_size;
245 	struct i2o_device* devices;
246 	struct adpt_channel channel[MAX_CHANNEL];
247 	struct proc_dir_entry* proc_entry;	/* /proc dir */
248 
249 	void __iomem *FwDebugBuffer_P;	// Virtual Address Of FW Debug Buffer
250 	u32   FwDebugBufferSize;	// FW Debug Buffer Size In Bytes
251 	void __iomem *FwDebugStrLength_P;// Virtual Addr Of FW Debug String Len
252 	void __iomem *FwDebugFlags_P;	// Virtual Address Of FW Debug Flags
253 	void __iomem *FwDebugBLEDflag_P;// Virtual Addr Of FW Debug BLED
254 	void __iomem *FwDebugBLEDvalue_P;// Virtual Addr Of FW Debug BLED
255 	u32 FwDebugFlags;
256 	u32 *ioctl_reply_context[4];
257 } adpt_hba;
258 
259 struct sg_simple_element {
260    u32  flag_count;
261    u32 addr_bus;
262 };
263 
264 /*
265  * Function Prototypes
266  */
267 
268 static void adpt_i2o_sys_shutdown(void);
269 static int adpt_init(void);
270 static int adpt_i2o_build_sys_table(void);
271 static irqreturn_t adpt_isr(int irq, void *dev_id);
272 
273 static void adpt_i2o_report_hba_unit(adpt_hba* pHba, struct i2o_device *d);
274 static int adpt_i2o_query_scalar(adpt_hba* pHba, int tid,
275 			int group, int field, void *buf, int buflen);
276 #ifdef DEBUG
277 static const char *adpt_i2o_get_class_name(int class);
278 #endif
279 static int adpt_i2o_issue_params(int cmd, adpt_hba* pHba, int tid,
280 		  void *opblk, dma_addr_t opblk_pa, int oplen,
281 		  void *resblk, dma_addr_t resblk_pa, int reslen);
282 static int adpt_i2o_post_wait(adpt_hba* pHba, u32* msg, int len, int timeout);
283 static int adpt_i2o_lct_get(adpt_hba* pHba);
284 static int adpt_i2o_parse_lct(adpt_hba* pHba);
285 static int adpt_i2o_activate_hba(adpt_hba* pHba);
286 static int adpt_i2o_enable_hba(adpt_hba* pHba);
287 static int adpt_i2o_install_device(adpt_hba* pHba, struct i2o_device *d);
288 static s32 adpt_i2o_post_this(adpt_hba* pHba, u32* data, int len);
289 static s32 adpt_i2o_quiesce_hba(adpt_hba* pHba);
290 static s32 adpt_i2o_status_get(adpt_hba* pHba);
291 static s32 adpt_i2o_init_outbound_q(adpt_hba* pHba);
292 static s32 adpt_i2o_hrt_get(adpt_hba* pHba);
293 static s32 adpt_scsi_to_i2o(adpt_hba* pHba, struct scsi_cmnd* cmd, struct adpt_device* dptdevice);
294 static s32 adpt_i2o_to_scsi(void __iomem *reply, struct scsi_cmnd* cmd);
295 static s32 adpt_scsi_host_alloc(adpt_hba* pHba,struct scsi_host_template * sht);
296 static s32 adpt_hba_reset(adpt_hba* pHba);
297 static s32 adpt_i2o_reset_hba(adpt_hba* pHba);
298 static s32 adpt_rescan(adpt_hba* pHba);
299 static s32 adpt_i2o_reparse_lct(adpt_hba* pHba);
300 static s32 adpt_send_nop(adpt_hba*pHba,u32 m);
301 static void adpt_i2o_delete_hba(adpt_hba* pHba);
302 static void adpt_inquiry(adpt_hba* pHba);
303 static void adpt_fail_posted_scbs(adpt_hba* pHba);
304 static struct adpt_device* adpt_find_device(adpt_hba* pHba, u32 chan, u32 id, u32 lun);
305 static int adpt_install_hba(struct scsi_host_template* sht, struct pci_dev* pDev) ;
306 static int adpt_i2o_online_hba(adpt_hba* pHba);
307 static void adpt_i2o_post_wait_complete(u32, int);
308 static int adpt_i2o_systab_send(adpt_hba* pHba);
309 
310 static int adpt_ioctl(struct inode *inode, struct file *file, uint cmd, ulong arg);
311 static int adpt_open(struct inode *inode, struct file *file);
312 static int adpt_close(struct inode *inode, struct file *file);
313 
314 
315 #ifdef UARTDELAY
316 static void adpt_delay(int millisec);
317 #endif
318 
319 #define PRINT_BUFFER_SIZE     512
320 
321 #define HBA_FLAGS_DBG_FLAGS_MASK         0xffff0000	// Mask for debug flags
322 #define HBA_FLAGS_DBG_KERNEL_PRINT_B     0x00010000	// Kernel Debugger Print
323 #define HBA_FLAGS_DBG_FW_PRINT_B         0x00020000	// Firmware Debugger Print
324 #define HBA_FLAGS_DBG_FUNCTION_ENTRY_B   0x00040000	// Function Entry Point
325 #define HBA_FLAGS_DBG_FUNCTION_EXIT_B    0x00080000	// Function Exit
326 #define HBA_FLAGS_DBG_ERROR_B            0x00100000	// Error Conditions
327 #define HBA_FLAGS_DBG_INIT_B             0x00200000	// Init Prints
328 #define HBA_FLAGS_DBG_OS_COMMANDS_B      0x00400000	// OS Command Info
329 #define HBA_FLAGS_DBG_SCAN_B             0x00800000	// Device Scan
330 
331 #define FW_DEBUG_STR_LENGTH_OFFSET 0
332 #define FW_DEBUG_FLAGS_OFFSET      4
333 #define FW_DEBUG_BLED_OFFSET       8
334 
335 #define FW_DEBUG_FLAGS_NO_HEADERS_B    0x01
336 #endif				/* !HOSTS_C */
337 #endif				/* _DPT_H */
338