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