Merge branch 'master'
[linux-2.6.git] / drivers / scsi / dpti.h
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_cmnd * cmd, void (*cmdcomplete) (struct scsi_cmnd *));
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 hosts.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 //#define REBOOT_NOTIFIER 1
88 /* Debugging macro from Linux Device Drivers - Rubini */
89 #undef PDEBUG
90 #ifdef DEBUG
91 //TODO add debug level switch
92 #  define PDEBUG(fmt, args...)  printk(KERN_DEBUG "dpti: " fmt, ##args)
93 #  define PDEBUGV(fmt, args...) printk(KERN_DEBUG "dpti: " fmt, ##args)
94 #else
95 # define PDEBUG(fmt, args...) /* not debugging: nothing */
96 # define PDEBUGV(fmt, args...) /* not debugging: nothing */
97 #endif
98
99 #define PERROR(fmt, args...) printk(KERN_ERR fmt, ##args)
100 #define PWARN(fmt, args...) printk(KERN_WARNING fmt, ##args)
101 #define PINFO(fmt, args...) printk(KERN_INFO fmt, ##args)
102 #define PCRIT(fmt, args...) printk(KERN_CRIT fmt, ##args)
103
104 #define SHUTDOWN_SIGS   (sigmask(SIGKILL)|sigmask(SIGINT)|sigmask(SIGTERM))
105
106 // Command timeouts
107 #define FOREVER                 (0)
108 #define TMOUT_INQUIRY           (20)
109 #define TMOUT_FLUSH             (360/45)
110 #define TMOUT_ABORT             (30)
111 #define TMOUT_SCSI              (300)
112 #define TMOUT_IOPRESET          (360)
113 #define TMOUT_GETSTATUS         (15)
114 #define TMOUT_INITOUTBOUND      (15)
115 #define TMOUT_LCT               (360)
116
117
118 #define I2O_SCSI_DEVICE_DSC_MASK                0x00FF
119
120 #define I2O_DETAIL_STATUS_UNSUPPORTED_FUNCTION  0x000A
121
122 #define I2O_SCSI_DSC_MASK                   0xFF00
123 #define I2O_SCSI_DSC_SUCCESS                0x0000
124 #define I2O_SCSI_DSC_REQUEST_ABORTED        0x0200
125 #define I2O_SCSI_DSC_UNABLE_TO_ABORT        0x0300
126 #define I2O_SCSI_DSC_COMPLETE_WITH_ERROR    0x0400
127 #define I2O_SCSI_DSC_ADAPTER_BUSY           0x0500
128 #define I2O_SCSI_DSC_REQUEST_INVALID        0x0600
129 #define I2O_SCSI_DSC_PATH_INVALID           0x0700
130 #define I2O_SCSI_DSC_DEVICE_NOT_PRESENT     0x0800
131 #define I2O_SCSI_DSC_UNABLE_TO_TERMINATE    0x0900
132 #define I2O_SCSI_DSC_SELECTION_TIMEOUT      0x0A00
133 #define I2O_SCSI_DSC_COMMAND_TIMEOUT        0x0B00
134 #define I2O_SCSI_DSC_MR_MESSAGE_RECEIVED    0x0D00
135 #define I2O_SCSI_DSC_SCSI_BUS_RESET         0x0E00
136 #define I2O_SCSI_DSC_PARITY_ERROR_FAILURE   0x0F00
137 #define I2O_SCSI_DSC_AUTOSENSE_FAILED       0x1000
138 #define I2O_SCSI_DSC_NO_ADAPTER             0x1100
139 #define I2O_SCSI_DSC_DATA_OVERRUN           0x1200
140 #define I2O_SCSI_DSC_UNEXPECTED_BUS_FREE    0x1300
141 #define I2O_SCSI_DSC_SEQUENCE_FAILURE       0x1400
142 #define I2O_SCSI_DSC_REQUEST_LENGTH_ERROR   0x1500
143 #define I2O_SCSI_DSC_PROVIDE_FAILURE        0x1600
144 #define I2O_SCSI_DSC_BDR_MESSAGE_SENT       0x1700
145 #define I2O_SCSI_DSC_REQUEST_TERMINATED     0x1800
146 #define I2O_SCSI_DSC_IDE_MESSAGE_SENT       0x3300
147 #define I2O_SCSI_DSC_RESOURCE_UNAVAILABLE   0x3400
148 #define I2O_SCSI_DSC_UNACKNOWLEDGED_EVENT   0x3500
149 #define I2O_SCSI_DSC_MESSAGE_RECEIVED       0x3600
150 #define I2O_SCSI_DSC_INVALID_CDB            0x3700
151 #define I2O_SCSI_DSC_LUN_INVALID            0x3800
152 #define I2O_SCSI_DSC_SCSI_TID_INVALID       0x3900
153 #define I2O_SCSI_DSC_FUNCTION_UNAVAILABLE   0x3A00
154 #define I2O_SCSI_DSC_NO_NEXUS               0x3B00
155 #define I2O_SCSI_DSC_SCSI_IID_INVALID       0x3C00
156 #define I2O_SCSI_DSC_CDB_RECEIVED           0x3D00
157 #define I2O_SCSI_DSC_LUN_ALREADY_ENABLED    0x3E00
158 #define I2O_SCSI_DSC_BUS_BUSY               0x3F00
159 #define I2O_SCSI_DSC_QUEUE_FROZEN           0x4000
160
161
162 #ifndef TRUE
163 #define TRUE                  1
164 #define FALSE                 0
165 #endif
166
167 #define HBA_FLAGS_INSTALLED_B       0x00000001  // Adapter Was Installed
168 #define HBA_FLAGS_BLINKLED_B        0x00000002  // Adapter In Blink LED State
169 #define HBA_FLAGS_IN_RESET      0x00000040      /* in reset */
170 #define HBA_HOSTRESET_FAILED    0x00000080      /* adpt_resethost failed */
171
172
173 // Device state flags
174 #define DPTI_DEV_ONLINE    0x00
175 #define DPTI_DEV_UNSCANNED 0x01
176 #define DPTI_DEV_RESET     0x02
177 #define DPTI_DEV_OFFLINE   0x04
178
179
180 struct adpt_device {
181         struct adpt_device* next_lun;
182         u32     flags;
183         u32     type;
184         u32     capacity;
185         u32     block_size;
186         u8      scsi_channel;
187         u8      scsi_id;
188         u8      scsi_lun;
189         u8      state;
190         u16     tid;
191         struct i2o_device* pI2o_dev;
192         struct scsi_device *pScsi_dev;
193 };
194
195 struct adpt_channel {
196         struct adpt_device* device[MAX_ID];     /* used as an array of 128 scsi ids */
197         u8      scsi_id;
198         u8      type;
199         u16     tid;
200         u32     state;
201         struct i2o_device* pI2o_dev;
202 };
203
204 // HBA state flags
205 #define DPTI_STATE_RESET        (0x01)
206 #define DPTI_STATE_IOCTL        (0x02)
207
208 typedef struct _adpt_hba {
209         struct _adpt_hba *next;
210         struct pci_dev *pDev;
211         struct Scsi_Host *host;
212         u32 state;
213         spinlock_t state_lock;
214         int unit;
215         int host_no;            /* SCSI host number */
216         u8 initialized;
217         u8 in_use;              /* is the management node open*/
218
219         char name[32];
220         char detail[55];
221
222         void __iomem *base_addr_virt;
223         void __iomem *msg_addr_virt;
224         ulong base_addr_phys;
225         void __iomem *post_port;
226         void __iomem *reply_port;
227         void __iomem *irq_mask;
228         u16  post_count;
229         u32  post_fifo_size;
230         u32  reply_fifo_size;
231         u32* reply_pool;
232         u32  sg_tablesize;      // Scatter/Gather List Size.       
233         u8  top_scsi_channel;
234         u8  top_scsi_id;
235         u8  top_scsi_lun;
236
237         i2o_status_block* status_block;
238         i2o_hrt* hrt;
239         i2o_lct* lct;
240         uint lct_size;
241         struct i2o_device* devices;
242         struct adpt_channel channel[MAX_CHANNEL];
243         struct proc_dir_entry* proc_entry;      /* /proc dir */
244
245         void __iomem *FwDebugBuffer_P;  // Virtual Address Of FW Debug Buffer
246         u32   FwDebugBufferSize;        // FW Debug Buffer Size In Bytes
247         void __iomem *FwDebugStrLength_P;// Virtual Addr Of FW Debug String Len
248         void __iomem *FwDebugFlags_P;   // Virtual Address Of FW Debug Flags 
249         void __iomem *FwDebugBLEDflag_P;// Virtual Addr Of FW Debug BLED
250         void __iomem *FwDebugBLEDvalue_P;// Virtual Addr Of FW Debug BLED
251         u32 FwDebugFlags;
252 } adpt_hba;
253
254 struct sg_simple_element {
255    u32  flag_count;
256    u32 addr_bus;
257 }; 
258
259 /*
260  * Function Prototypes
261  */
262
263 static void adpt_i2o_sys_shutdown(void);
264 static int adpt_init(void);
265 static int adpt_i2o_build_sys_table(void);
266 static irqreturn_t adpt_isr(int irq, void *dev_id, struct pt_regs *regs);
267 #ifdef REBOOT_NOTIFIER
268 static int adpt_reboot_event(struct notifier_block *n, ulong code, void *p);
269 #endif
270
271 static void adpt_i2o_report_hba_unit(adpt_hba* pHba, struct i2o_device *d);
272 static int adpt_i2o_query_scalar(adpt_hba* pHba, int tid, 
273                         int group, int field, void *buf, int buflen);
274 #ifdef DEBUG
275 static const char *adpt_i2o_get_class_name(int class);
276 #endif
277 static int adpt_i2o_issue_params(int cmd, adpt_hba* pHba, int tid, 
278                   void *opblk, int oplen, void *resblk, int reslen);
279 static int adpt_i2o_post_wait(adpt_hba* pHba, u32* msg, int len, int timeout);
280 static int adpt_i2o_lct_get(adpt_hba* pHba);
281 static int adpt_i2o_parse_lct(adpt_hba* pHba);
282 static int adpt_i2o_activate_hba(adpt_hba* pHba);
283 static int adpt_i2o_enable_hba(adpt_hba* pHba);
284 static int adpt_i2o_install_device(adpt_hba* pHba, struct i2o_device *d);
285 static s32 adpt_i2o_post_this(adpt_hba* pHba, u32* data, int len);
286 static s32 adpt_i2o_quiesce_hba(adpt_hba* pHba);
287 static s32 adpt_i2o_status_get(adpt_hba* pHba);
288 static s32 adpt_i2o_init_outbound_q(adpt_hba* pHba);
289 static s32 adpt_i2o_hrt_get(adpt_hba* pHba);
290 static s32 adpt_scsi_to_i2o(adpt_hba* pHba, struct scsi_cmnd* cmd, struct adpt_device* dptdevice);
291 static s32 adpt_i2o_to_scsi(void __iomem *reply, struct scsi_cmnd* cmd);
292 static s32 adpt_scsi_register(adpt_hba* pHba,struct scsi_host_template * sht);
293 static s32 adpt_hba_reset(adpt_hba* pHba);
294 static s32 adpt_i2o_reset_hba(adpt_hba* pHba);
295 static s32 adpt_rescan(adpt_hba* pHba);
296 static s32 adpt_i2o_reparse_lct(adpt_hba* pHba);
297 static s32 adpt_send_nop(adpt_hba*pHba,u32 m);
298 static void adpt_i2o_delete_hba(adpt_hba* pHba);
299 static void adpt_inquiry(adpt_hba* pHba);
300 static void adpt_fail_posted_scbs(adpt_hba* pHba);
301 static struct adpt_device* adpt_find_device(adpt_hba* pHba, u32 chan, u32 id, u32 lun);
302 static int adpt_install_hba(struct scsi_host_template* sht, struct pci_dev* pDev) ;
303 static int adpt_i2o_online_hba(adpt_hba* pHba);
304 static void adpt_i2o_post_wait_complete(u32, int);
305 static int adpt_i2o_systab_send(adpt_hba* pHba);
306
307 static int adpt_ioctl(struct inode *inode, struct file *file, uint cmd, ulong arg);
308 static int adpt_open(struct inode *inode, struct file *file);
309 static int adpt_close(struct inode *inode, struct file *file);
310
311
312 #ifdef UARTDELAY
313 static void adpt_delay(int millisec);
314 #endif
315
316 #if defined __ia64__ 
317 static void adpt_ia64_info(sysInfo_S* si);
318 #endif
319 #if defined __sparc__ 
320 static void adpt_sparc_info(sysInfo_S* si);
321 #endif
322 #if defined __alpha__ 
323 static void adpt_sparc_info(sysInfo_S* si);
324 #endif
325 #if defined __i386__
326 static void adpt_i386_info(sysInfo_S* si);
327 #endif
328
329 #define PRINT_BUFFER_SIZE     512
330
331 #define HBA_FLAGS_DBG_FLAGS_MASK         0xffff0000     // Mask for debug flags
332 #define HBA_FLAGS_DBG_KERNEL_PRINT_B     0x00010000     // Kernel Debugger Print
333 #define HBA_FLAGS_DBG_FW_PRINT_B         0x00020000     // Firmware Debugger Print
334 #define HBA_FLAGS_DBG_FUNCTION_ENTRY_B   0x00040000     // Function Entry Point
335 #define HBA_FLAGS_DBG_FUNCTION_EXIT_B    0x00080000     // Function Exit
336 #define HBA_FLAGS_DBG_ERROR_B            0x00100000     // Error Conditions
337 #define HBA_FLAGS_DBG_INIT_B             0x00200000     // Init Prints
338 #define HBA_FLAGS_DBG_OS_COMMANDS_B      0x00400000     // OS Command Info
339 #define HBA_FLAGS_DBG_SCAN_B             0x00800000     // Device Scan
340
341 #define FW_DEBUG_STR_LENGTH_OFFSET 0
342 #define FW_DEBUG_FLAGS_OFFSET      4
343 #define FW_DEBUG_BLED_OFFSET       8
344
345 #define FW_DEBUG_FLAGS_NO_HEADERS_B    0x01
346 #endif                          /* !HOSTS_C */
347 #endif                          /* _DPT_H */