Merge master.kernel.org:/pub/scm/linux/kernel/git/jejb/scsi-misc-2.6
[linux-2.6.git] / drivers / scsi / dpt / dpti_i2o.h
1 #ifndef _SCSI_I2O_H
2 #define _SCSI_I2O_H
3
4 /* I2O kernel space accessible structures/APIs
5  *
6  * (c) Copyright 1999, 2000 Red Hat Software
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version
11  * 2 of the License, or (at your option) any later version.
12  *
13  *************************************************************************
14  *
15  * This header file defined the I2O APIs/structures for use by
16  * the I2O kernel modules.
17  *
18  */
19
20 #ifdef __KERNEL__       /* This file to be included by kernel only */
21
22 #include <linux/i2o-dev.h>
23
24 #include <asm/semaphore.h> /* Needed for MUTEX init macros */
25 #include <linux/version.h>
26 #include <linux/notifier.h>
27 #include <asm/atomic.h>
28
29
30 /*
31  *      Tunable parameters first
32  */
33
34 /* How many different OSM's are we allowing */
35 #define MAX_I2O_MODULES         64
36
37 #define I2O_EVT_CAPABILITY_OTHER                0x01
38 #define I2O_EVT_CAPABILITY_CHANGED              0x02
39
40 #define I2O_EVT_SENSOR_STATE_CHANGED            0x01
41
42 //#ifdef __KERNEL__   /* ioctl stuff only thing exported to users */
43
44 #define I2O_MAX_MANAGERS        4
45
46 /*
47  *      I2O Interface Objects
48  */
49
50 #include <linux/wait.h>
51 typedef wait_queue_head_t adpt_wait_queue_head_t;
52 #define ADPT_DECLARE_WAIT_QUEUE_HEAD(wait) DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wait)
53 typedef wait_queue_t adpt_wait_queue_t;
54
55 /*
56  * message structures
57  */
58
59 struct i2o_message
60 {
61         u8      version_offset;
62         u8      flags;
63         u16     size;
64         u32     target_tid:12;
65         u32     init_tid:12;
66         u32     function:8;
67         u32     initiator_context;
68         /* List follows */
69 };
70
71 struct adpt_device;
72 struct _adpt_hba;
73 struct i2o_device
74 {
75         struct i2o_device *next;        /* Chain */
76         struct i2o_device *prev;
77
78         char dev_name[8];               /* linux /dev name if available */
79         i2o_lct_entry lct_data;/* Device LCT information */
80         u32 flags;
81         struct proc_dir_entry* proc_entry;      /* /proc dir */
82         struct adpt_device *owner;
83         struct _adpt_hba *controller;   /* Controlling IOP */
84 };
85
86 /*
87  *      Each I2O controller has one of these objects
88  */
89
90 struct i2o_controller
91 {
92         char name[16];
93         int unit;
94         int type;
95         int enabled;
96
97         struct notifier_block *event_notifer;   /* Events */
98         atomic_t users;
99         struct i2o_device *devices;             /* I2O device chain */
100         struct i2o_controller *next;            /* Controller chain */
101
102 };
103
104 /*
105  * I2O System table entry
106  */
107 struct i2o_sys_tbl_entry
108 {
109         u16     org_id;
110         u16     reserved1;
111         u32     iop_id:12;
112         u32     reserved2:20;
113         u16     seg_num:12;
114         u16     i2o_version:4;
115         u8      iop_state;
116         u8      msg_type;
117         u16     frame_size;
118         u16     reserved3;
119         u32     last_changed;
120         u32     iop_capabilities;
121         u32     inbound_low;
122         u32     inbound_high;
123 };
124
125 struct i2o_sys_tbl
126 {
127         u8      num_entries;
128         u8      version;
129         u16     reserved1;
130         u32     change_ind;
131         u32     reserved2;
132         u32     reserved3;
133         struct i2o_sys_tbl_entry iops[0];
134 };
135
136 /*
137  *      I2O classes / subclasses
138  */
139
140 /*  Class ID and Code Assignments
141  *  (LCT.ClassID.Version field)
142  */
143 #define    I2O_CLASS_VERSION_10                        0x00
144 #define    I2O_CLASS_VERSION_11                        0x01
145
146 /*  Class code names
147  *  (from v1.5 Table 6-1 Class Code Assignments.)
148  */
149
150 #define    I2O_CLASS_EXECUTIVE                         0x000
151 #define    I2O_CLASS_DDM                               0x001
152 #define    I2O_CLASS_RANDOM_BLOCK_STORAGE              0x010
153 #define    I2O_CLASS_SEQUENTIAL_STORAGE                0x011
154 #define    I2O_CLASS_LAN                               0x020
155 #define    I2O_CLASS_WAN                               0x030
156 #define    I2O_CLASS_FIBRE_CHANNEL_PORT                0x040
157 #define    I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL          0x041
158 #define    I2O_CLASS_SCSI_PERIPHERAL                   0x051
159 #define    I2O_CLASS_ATE_PORT                          0x060
160 #define    I2O_CLASS_ATE_PERIPHERAL                    0x061
161 #define    I2O_CLASS_FLOPPY_CONTROLLER                 0x070
162 #define    I2O_CLASS_FLOPPY_DEVICE                     0x071
163 #define    I2O_CLASS_BUS_ADAPTER_PORT                  0x080
164 #define    I2O_CLASS_PEER_TRANSPORT_AGENT              0x090
165 #define    I2O_CLASS_PEER_TRANSPORT                    0x091
166
167 /*  Rest of 0x092 - 0x09f reserved for peer-to-peer classes
168  */
169
170 #define    I2O_CLASS_MATCH_ANYCLASS                    0xffffffff
171
172 /*  Subclasses
173  */
174
175 #define    I2O_SUBCLASS_i960                           0x001
176 #define    I2O_SUBCLASS_HDM                            0x020
177 #define    I2O_SUBCLASS_ISM                            0x021
178
179 /* Operation functions */
180
181 #define I2O_PARAMS_FIELD_GET    0x0001
182 #define I2O_PARAMS_LIST_GET     0x0002
183 #define I2O_PARAMS_MORE_GET     0x0003
184 #define I2O_PARAMS_SIZE_GET     0x0004
185 #define I2O_PARAMS_TABLE_GET    0x0005
186 #define I2O_PARAMS_FIELD_SET    0x0006
187 #define I2O_PARAMS_LIST_SET     0x0007
188 #define I2O_PARAMS_ROW_ADD      0x0008
189 #define I2O_PARAMS_ROW_DELETE   0x0009
190 #define I2O_PARAMS_TABLE_CLEAR  0x000A
191
192 /*
193  *      I2O serial number conventions / formats
194  *      (circa v1.5)
195  */
196
197 #define    I2O_SNFORMAT_UNKNOWN                        0
198 #define    I2O_SNFORMAT_BINARY                         1
199 #define    I2O_SNFORMAT_ASCII                          2
200 #define    I2O_SNFORMAT_UNICODE                        3
201 #define    I2O_SNFORMAT_LAN48_MAC                      4
202 #define    I2O_SNFORMAT_WAN                            5
203
204 /* Plus new in v2.0 (Yellowstone pdf doc)
205  */
206
207 #define    I2O_SNFORMAT_LAN64_MAC                      6
208 #define    I2O_SNFORMAT_DDM                            7
209 #define    I2O_SNFORMAT_IEEE_REG64                     8
210 #define    I2O_SNFORMAT_IEEE_REG128                    9
211 #define    I2O_SNFORMAT_UNKNOWN2                       0xff
212
213 /* Transaction Reply Lists (TRL) Control Word structure */
214
215 #define TRL_SINGLE_FIXED_LENGTH         0x00
216 #define TRL_SINGLE_VARIABLE_LENGTH      0x40
217 #define TRL_MULTIPLE_FIXED_LENGTH       0x80
218
219 /*
220  *      Messaging API values
221  */
222
223 #define I2O_CMD_ADAPTER_ASSIGN          0xB3
224 #define I2O_CMD_ADAPTER_READ            0xB2
225 #define I2O_CMD_ADAPTER_RELEASE         0xB5
226 #define I2O_CMD_BIOS_INFO_SET           0xA5
227 #define I2O_CMD_BOOT_DEVICE_SET         0xA7
228 #define I2O_CMD_CONFIG_VALIDATE         0xBB
229 #define I2O_CMD_CONN_SETUP              0xCA
230 #define I2O_CMD_DDM_DESTROY             0xB1
231 #define I2O_CMD_DDM_ENABLE              0xD5
232 #define I2O_CMD_DDM_QUIESCE             0xC7
233 #define I2O_CMD_DDM_RESET               0xD9
234 #define I2O_CMD_DDM_SUSPEND             0xAF
235 #define I2O_CMD_DEVICE_ASSIGN           0xB7
236 #define I2O_CMD_DEVICE_RELEASE          0xB9
237 #define I2O_CMD_HRT_GET                 0xA8
238 #define I2O_CMD_ADAPTER_CLEAR           0xBE
239 #define I2O_CMD_ADAPTER_CONNECT         0xC9
240 #define I2O_CMD_ADAPTER_RESET           0xBD
241 #define I2O_CMD_LCT_NOTIFY              0xA2
242 #define I2O_CMD_OUTBOUND_INIT           0xA1
243 #define I2O_CMD_PATH_ENABLE             0xD3
244 #define I2O_CMD_PATH_QUIESCE            0xC5
245 #define I2O_CMD_PATH_RESET              0xD7
246 #define I2O_CMD_STATIC_MF_CREATE        0xDD
247 #define I2O_CMD_STATIC_MF_RELEASE       0xDF
248 #define I2O_CMD_STATUS_GET              0xA0
249 #define I2O_CMD_SW_DOWNLOAD             0xA9
250 #define I2O_CMD_SW_UPLOAD               0xAB
251 #define I2O_CMD_SW_REMOVE               0xAD
252 #define I2O_CMD_SYS_ENABLE              0xD1
253 #define I2O_CMD_SYS_MODIFY              0xC1
254 #define I2O_CMD_SYS_QUIESCE             0xC3
255 #define I2O_CMD_SYS_TAB_SET             0xA3
256
257 #define I2O_CMD_UTIL_NOP                0x00
258 #define I2O_CMD_UTIL_ABORT              0x01
259 #define I2O_CMD_UTIL_CLAIM              0x09
260 #define I2O_CMD_UTIL_RELEASE            0x0B
261 #define I2O_CMD_UTIL_PARAMS_GET         0x06
262 #define I2O_CMD_UTIL_PARAMS_SET         0x05
263 #define I2O_CMD_UTIL_EVT_REGISTER       0x13
264 #define I2O_CMD_UTIL_EVT_ACK            0x14
265 #define I2O_CMD_UTIL_CONFIG_DIALOG      0x10
266 #define I2O_CMD_UTIL_DEVICE_RESERVE     0x0D
267 #define I2O_CMD_UTIL_DEVICE_RELEASE     0x0F
268 #define I2O_CMD_UTIL_LOCK               0x17
269 #define I2O_CMD_UTIL_LOCK_RELEASE       0x19
270 #define I2O_CMD_UTIL_REPLY_FAULT_NOTIFY 0x15
271
272 #define I2O_CMD_SCSI_EXEC               0x81
273 #define I2O_CMD_SCSI_ABORT              0x83
274 #define I2O_CMD_SCSI_BUSRESET           0x27
275
276 #define I2O_CMD_BLOCK_READ              0x30
277 #define I2O_CMD_BLOCK_WRITE             0x31
278 #define I2O_CMD_BLOCK_CFLUSH            0x37
279 #define I2O_CMD_BLOCK_MLOCK             0x49
280 #define I2O_CMD_BLOCK_MUNLOCK           0x4B
281 #define I2O_CMD_BLOCK_MMOUNT            0x41
282 #define I2O_CMD_BLOCK_MEJECT            0x43
283
284 #define I2O_PRIVATE_MSG                 0xFF
285
286 /*
287  *      Init Outbound Q status
288  */
289
290 #define I2O_CMD_OUTBOUND_INIT_IN_PROGRESS       0x01
291 #define I2O_CMD_OUTBOUND_INIT_REJECTED          0x02
292 #define I2O_CMD_OUTBOUND_INIT_FAILED            0x03
293 #define I2O_CMD_OUTBOUND_INIT_COMPLETE          0x04
294
295 /*
296  *      I2O Get Status State values
297  */
298
299 #define ADAPTER_STATE_INITIALIZING              0x01
300 #define ADAPTER_STATE_RESET                     0x02
301 #define ADAPTER_STATE_HOLD                      0x04
302 #define ADAPTER_STATE_READY                     0x05
303 #define ADAPTER_STATE_OPERATIONAL               0x08
304 #define ADAPTER_STATE_FAILED                    0x10
305 #define ADAPTER_STATE_FAULTED                   0x11
306
307 /* I2O API function return values */
308
309 #define I2O_RTN_NO_ERROR                        0
310 #define I2O_RTN_NOT_INIT                        1
311 #define I2O_RTN_FREE_Q_EMPTY                    2
312 #define I2O_RTN_TCB_ERROR                       3
313 #define I2O_RTN_TRANSACTION_ERROR               4
314 #define I2O_RTN_ADAPTER_ALREADY_INIT            5
315 #define I2O_RTN_MALLOC_ERROR                    6
316 #define I2O_RTN_ADPTR_NOT_REGISTERED            7
317 #define I2O_RTN_MSG_REPLY_TIMEOUT               8
318 #define I2O_RTN_NO_STATUS                       9
319 #define I2O_RTN_NO_FIRM_VER                     10
320 #define I2O_RTN_NO_LINK_SPEED                   11
321
322 /* Reply message status defines for all messages */
323
324 #define I2O_REPLY_STATUS_SUCCESS                        0x00
325 #define I2O_REPLY_STATUS_ABORT_DIRTY                    0x01
326 #define I2O_REPLY_STATUS_ABORT_NO_DATA_TRANSFER         0x02
327 #define I2O_REPLY_STATUS_ABORT_PARTIAL_TRANSFER         0x03
328 #define I2O_REPLY_STATUS_ERROR_DIRTY                    0x04
329 #define I2O_REPLY_STATUS_ERROR_NO_DATA_TRANSFER         0x05
330 #define I2O_REPLY_STATUS_ERROR_PARTIAL_TRANSFER         0x06
331 #define I2O_REPLY_STATUS_PROCESS_ABORT_DIRTY            0x08
332 #define I2O_REPLY_STATUS_PROCESS_ABORT_NO_DATA_TRANSFER 0x09
333 #define I2O_REPLY_STATUS_PROCESS_ABORT_PARTIAL_TRANSFER 0x0A
334 #define I2O_REPLY_STATUS_TRANSACTION_ERROR              0x0B
335 #define I2O_REPLY_STATUS_PROGRESS_REPORT                0x80
336
337 /* Status codes and Error Information for Parameter functions */
338
339 #define I2O_PARAMS_STATUS_SUCCESS               0x00
340 #define I2O_PARAMS_STATUS_BAD_KEY_ABORT         0x01
341 #define I2O_PARAMS_STATUS_BAD_KEY_CONTINUE      0x02
342 #define I2O_PARAMS_STATUS_BUFFER_FULL           0x03
343 #define I2O_PARAMS_STATUS_BUFFER_TOO_SMALL      0x04
344 #define I2O_PARAMS_STATUS_FIELD_UNREADABLE      0x05
345 #define I2O_PARAMS_STATUS_FIELD_UNWRITEABLE     0x06
346 #define I2O_PARAMS_STATUS_INSUFFICIENT_FIELDS   0x07
347 #define I2O_PARAMS_STATUS_INVALID_GROUP_ID      0x08
348 #define I2O_PARAMS_STATUS_INVALID_OPERATION     0x09
349 #define I2O_PARAMS_STATUS_NO_KEY_FIELD          0x0A
350 #define I2O_PARAMS_STATUS_NO_SUCH_FIELD         0x0B
351 #define I2O_PARAMS_STATUS_NON_DYNAMIC_GROUP     0x0C
352 #define I2O_PARAMS_STATUS_OPERATION_ERROR       0x0D
353 #define I2O_PARAMS_STATUS_SCALAR_ERROR          0x0E
354 #define I2O_PARAMS_STATUS_TABLE_ERROR           0x0F
355 #define I2O_PARAMS_STATUS_WRONG_GROUP_TYPE      0x10
356
357 /* DetailedStatusCode defines for Executive, DDM, Util and Transaction error
358  * messages: Table 3-2 Detailed Status Codes.*/
359
360 #define I2O_DSC_SUCCESS                        0x0000
361 #define I2O_DSC_BAD_KEY                        0x0002
362 #define I2O_DSC_TCL_ERROR                      0x0003
363 #define I2O_DSC_REPLY_BUFFER_FULL              0x0004
364 #define I2O_DSC_NO_SUCH_PAGE                   0x0005
365 #define I2O_DSC_INSUFFICIENT_RESOURCE_SOFT     0x0006
366 #define I2O_DSC_INSUFFICIENT_RESOURCE_HARD     0x0007
367 #define I2O_DSC_CHAIN_BUFFER_TOO_LARGE         0x0009
368 #define I2O_DSC_UNSUPPORTED_FUNCTION           0x000A
369 #define I2O_DSC_DEVICE_LOCKED                  0x000B
370 #define I2O_DSC_DEVICE_RESET                   0x000C
371 #define I2O_DSC_INAPPROPRIATE_FUNCTION         0x000D
372 #define I2O_DSC_INVALID_INITIATOR_ADDRESS      0x000E
373 #define I2O_DSC_INVALID_MESSAGE_FLAGS          0x000F
374 #define I2O_DSC_INVALID_OFFSET                 0x0010
375 #define I2O_DSC_INVALID_PARAMETER              0x0011
376 #define I2O_DSC_INVALID_REQUEST                0x0012
377 #define I2O_DSC_INVALID_TARGET_ADDRESS         0x0013
378 #define I2O_DSC_MESSAGE_TOO_LARGE              0x0014
379 #define I2O_DSC_MESSAGE_TOO_SMALL              0x0015
380 #define I2O_DSC_MISSING_PARAMETER              0x0016
381 #define I2O_DSC_TIMEOUT                        0x0017
382 #define I2O_DSC_UNKNOWN_ERROR                  0x0018
383 #define I2O_DSC_UNKNOWN_FUNCTION               0x0019
384 #define I2O_DSC_UNSUPPORTED_VERSION            0x001A
385 #define I2O_DSC_DEVICE_BUSY                    0x001B
386 #define I2O_DSC_DEVICE_NOT_AVAILABLE           0x001C
387
388 /* Device Claim Types */
389 #define I2O_CLAIM_PRIMARY                                       0x01000000
390 #define I2O_CLAIM_MANAGEMENT                                    0x02000000
391 #define I2O_CLAIM_AUTHORIZED                                    0x03000000
392 #define I2O_CLAIM_SECONDARY                                     0x04000000
393
394 /* Message header defines for VersionOffset */
395 #define I2OVER15        0x0001
396 #define I2OVER20        0x0002
397 /* Default is 1.5, FIXME: Need support for both 1.5 and 2.0 */
398 #define I2OVERSION      I2OVER15
399 #define SGL_OFFSET_0    I2OVERSION
400 #define SGL_OFFSET_4    (0x0040 | I2OVERSION)
401 #define SGL_OFFSET_5    (0x0050 | I2OVERSION)
402 #define SGL_OFFSET_6    (0x0060 | I2OVERSION)
403 #define SGL_OFFSET_7    (0x0070 | I2OVERSION)
404 #define SGL_OFFSET_8    (0x0080 | I2OVERSION)
405 #define SGL_OFFSET_9    (0x0090 | I2OVERSION)
406 #define SGL_OFFSET_10   (0x00A0 | I2OVERSION)
407 #define SGL_OFFSET_12   (0x00C0 | I2OVERSION)
408
409 #define TRL_OFFSET_5    (0x0050 | I2OVERSION)
410 #define TRL_OFFSET_6    (0x0060 | I2OVERSION)
411
412  /* msg header defines for MsgFlags */
413 #define MSG_STATIC      0x0100
414 #define MSG_64BIT_CNTXT 0x0200
415 #define MSG_MULTI_TRANS 0x1000
416 #define MSG_FAIL        0x2000
417 #define MSG_LAST        0x4000
418 #define MSG_REPLY       0x8000
419
420  /* minimum size msg */
421 #define THREE_WORD_MSG_SIZE     0x00030000
422 #define FOUR_WORD_MSG_SIZE      0x00040000
423 #define FIVE_WORD_MSG_SIZE      0x00050000
424 #define SIX_WORD_MSG_SIZE       0x00060000
425 #define SEVEN_WORD_MSG_SIZE     0x00070000
426 #define EIGHT_WORD_MSG_SIZE     0x00080000
427 #define NINE_WORD_MSG_SIZE      0x00090000
428 #define TEN_WORD_MSG_SIZE       0x000A0000
429 #define I2O_MESSAGE_SIZE(x)     ((x)<<16)
430
431
432 /* Special TID Assignments */
433
434 #define ADAPTER_TID             0
435 #define HOST_TID                1
436
437 #define MSG_FRAME_SIZE          128
438 #define NMBR_MSG_FRAMES         128
439
440 #define MSG_POOL_SIZE           16384
441
442 #define I2O_POST_WAIT_OK        0
443 #define I2O_POST_WAIT_TIMEOUT   -ETIMEDOUT
444
445
446 #endif /* __KERNEL__ */
447
448 #endif /* _SCSI_I2O_H */