2 * I2O user space accessible structures/APIs
4 * (c) Copyright 1999, 2000 Red Hat Software
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
11 *************************************************************************
13 * This header file defines the I2O APIs that are available to both
14 * the kernel and user level applications. Kernel specific structures
15 * are defined in i2o_osm. OSMs should include _only_ i2o_osm.h which
16 * automatically includs this file.
23 /* How many controllers are we allowing */
24 #define MAX_I2O_CONTROLLERS 32
26 //#include <linux/ioctl.h>
29 typedef unsigned char u8;
30 typedef unsigned short u16;
31 typedef unsigned int u32;
33 #endif /* __KERNEL__ */
38 #define I2O_VENDOR_DPT 0x001b
41 * I2O Control IOCTLs and structures
43 #define I2O_MAGIC_NUMBER 'i'
44 #define I2OGETIOPS _IOR(I2O_MAGIC_NUMBER,0,u8[MAX_I2O_CONTROLLERS])
45 #define I2OHRTGET _IOWR(I2O_MAGIC_NUMBER,1,struct i2o_cmd_hrtlct)
46 #define I2OLCTGET _IOWR(I2O_MAGIC_NUMBER,2,struct i2o_cmd_hrtlct)
47 #define I2OPARMSET _IOWR(I2O_MAGIC_NUMBER,3,struct i2o_cmd_psetget)
48 #define I2OPARMGET _IOWR(I2O_MAGIC_NUMBER,4,struct i2o_cmd_psetget)
49 #define I2OSWDL _IOWR(I2O_MAGIC_NUMBER,5,struct i2o_sw_xfer)
50 #define I2OSWUL _IOWR(I2O_MAGIC_NUMBER,6,struct i2o_sw_xfer)
51 #define I2OSWDEL _IOWR(I2O_MAGIC_NUMBER,7,struct i2o_sw_xfer)
52 #define I2OVALIDATE _IOR(I2O_MAGIC_NUMBER,8,u32)
53 #define I2OHTML _IOWR(I2O_MAGIC_NUMBER,9,struct i2o_html)
54 #define I2OEVTREG _IOW(I2O_MAGIC_NUMBER,10,struct i2o_evt_id)
55 #define I2OEVTGET _IOR(I2O_MAGIC_NUMBER,11,struct i2o_evt_info)
56 #define I2OPASSTHRU _IOR(I2O_MAGIC_NUMBER,12,struct i2o_cmd_passthru)
57 #define I2OPASSTHRU32 _IOR(I2O_MAGIC_NUMBER,12,struct i2o_cmd_passthru32)
59 struct i2o_cmd_passthru32 {
60 unsigned int iop; /* IOP unit number */
61 u32 msg; /* message */
64 struct i2o_cmd_passthru {
65 unsigned int iop; /* IOP unit number */
66 void __user *msg; /* message */
69 struct i2o_cmd_hrtlct {
70 unsigned int iop; /* IOP unit number */
71 void __user *resbuf; /* Buffer for result */
72 unsigned int __user *reslen; /* Buffer length in bytes */
75 struct i2o_cmd_psetget {
76 unsigned int iop; /* IOP unit number */
77 unsigned int tid; /* Target device TID */
78 void __user *opbuf; /* Operation List buffer */
79 unsigned int oplen; /* Operation List buffer length in bytes */
80 void __user *resbuf; /* Result List buffer */
81 unsigned int __user *reslen; /* Result List buffer length in bytes */
85 unsigned int iop; /* IOP unit number */
86 unsigned char flags; /* Flags field */
87 unsigned char sw_type; /* Software type */
88 unsigned int sw_id; /* Software ID */
89 void __user *buf; /* Pointer to software buffer */
90 unsigned int __user *swlen; /* Length of software data */
91 unsigned int __user *maxfrag; /* Maximum fragment count */
92 unsigned int __user *curfrag; /* Current fragment count */
96 unsigned int iop; /* IOP unit number */
97 unsigned int tid; /* Target device ID */
98 unsigned int page; /* HTML page */
99 void __user *resbuf; /* Buffer for reply HTML page */
100 unsigned int __user *reslen; /* Length in bytes of reply buffer */
101 void __user *qbuf; /* Pointer to HTTP query string */
102 unsigned int qlen; /* Length in bytes of query string buffer */
105 #define I2O_EVT_Q_LEN 32
110 unsigned int evt_mask;
113 /* Event data size = frame size - message header + evt indicator */
114 #define I2O_EVT_DATA_SIZE 88
116 struct i2o_evt_info {
117 struct i2o_evt_id id;
118 unsigned char evt_data[I2O_EVT_DATA_SIZE];
119 unsigned int data_size;
123 struct i2o_evt_info info;
128 /**************************************************************************
129 * HRT related constants and structures
130 **************************************************************************/
131 #define I2O_BUS_LOCAL 0
132 #define I2O_BUS_ISA 1
133 #define I2O_BUS_EISA 2
134 #define I2O_BUS_MCA 3
135 #define I2O_BUS_PCI 4
136 #define I2O_BUS_PCMCIA 5
137 #define I2O_BUS_NUBUS 6
138 #define I2O_BUS_CARDBUS 7
139 #define I2O_BUS_UNKNOWN 0x80
141 typedef struct _i2o_pci_bus {
142 u8 PciFunctionNumber;
150 typedef struct _i2o_local_bus {
153 u32 LbBaseMemoryAddress;
156 typedef struct _i2o_isa_bus {
160 u32 IsaBaseMemoryAddress;
163 typedef struct _i2o_eisa_bus_info {
167 u32 EisaBaseMemoryAddress;
170 typedef struct _i2o_mca_bus {
174 u32 McaBaseMemoryAddress;
177 typedef struct _i2o_other_bus {
180 u32 BaseMemoryAddress;
183 typedef struct _i2o_hrt_entry {
191 i2o_local_bus local_bus;
193 i2o_eisa_bus eisa_bus;
195 i2o_other_bus other_bus;
199 typedef struct _i2o_hrt {
204 i2o_hrt_entry hrt_entry[1];
207 typedef struct _i2o_lct_entry {
221 u32 event_capabilities;
224 typedef struct _i2o_lct {
230 i2o_lct_entry lct_entry[1];
233 typedef struct _i2o_status_block {
239 u16 segment_number:12;
243 u16 inbound_frame_size;
246 u32 max_inbound_frames;
247 u32 cur_inbound_frames;
248 u32 max_outbound_frames;
250 u32 expected_lct_size;
251 u32 iop_capabilities;
252 u32 desired_mem_size;
253 u32 current_mem_size;
254 u32 current_mem_base;
262 /* Event indicator mask flags */
263 #define I2O_EVT_IND_STATE_CHANGE 0x80000000
264 #define I2O_EVT_IND_GENERAL_WARNING 0x40000000
265 #define I2O_EVT_IND_CONFIGURATION_FLAG 0x20000000
266 #define I2O_EVT_IND_LOCK_RELEASE 0x10000000
267 #define I2O_EVT_IND_CAPABILITY_CHANGE 0x08000000
268 #define I2O_EVT_IND_DEVICE_RESET 0x04000000
269 #define I2O_EVT_IND_EVT_MASK_MODIFIED 0x02000000
270 #define I2O_EVT_IND_FIELD_MODIFIED 0x01000000
271 #define I2O_EVT_IND_VENDOR_EVT 0x00800000
272 #define I2O_EVT_IND_DEVICE_STATE 0x00400000
274 /* Executive event indicitors */
275 #define I2O_EVT_IND_EXEC_RESOURCE_LIMITS 0x00000001
276 #define I2O_EVT_IND_EXEC_CONNECTION_FAIL 0x00000002
277 #define I2O_EVT_IND_EXEC_ADAPTER_FAULT 0x00000004
278 #define I2O_EVT_IND_EXEC_POWER_FAIL 0x00000008
279 #define I2O_EVT_IND_EXEC_RESET_PENDING 0x00000010
280 #define I2O_EVT_IND_EXEC_RESET_IMMINENT 0x00000020
281 #define I2O_EVT_IND_EXEC_HW_FAIL 0x00000040
282 #define I2O_EVT_IND_EXEC_XCT_CHANGE 0x00000080
283 #define I2O_EVT_IND_EXEC_NEW_LCT_ENTRY 0x00000100
284 #define I2O_EVT_IND_EXEC_MODIFIED_LCT 0x00000200
285 #define I2O_EVT_IND_EXEC_DDM_AVAILABILITY 0x00000400
287 /* Random Block Storage Event Indicators */
288 #define I2O_EVT_IND_BSA_VOLUME_LOAD 0x00000001
289 #define I2O_EVT_IND_BSA_VOLUME_UNLOAD 0x00000002
290 #define I2O_EVT_IND_BSA_VOLUME_UNLOAD_REQ 0x00000004
291 #define I2O_EVT_IND_BSA_CAPACITY_CHANGE 0x00000008
292 #define I2O_EVT_IND_BSA_SCSI_SMART 0x00000010
294 /* Event data for generic events */
295 #define I2O_EVT_STATE_CHANGE_NORMAL 0x00
296 #define I2O_EVT_STATE_CHANGE_SUSPENDED 0x01
297 #define I2O_EVT_STATE_CHANGE_RESTART 0x02
298 #define I2O_EVT_STATE_CHANGE_NA_RECOVER 0x03
299 #define I2O_EVT_STATE_CHANGE_NA_NO_RECOVER 0x04
300 #define I2O_EVT_STATE_CHANGE_QUIESCE_REQUEST 0x05
301 #define I2O_EVT_STATE_CHANGE_FAILED 0x10
302 #define I2O_EVT_STATE_CHANGE_FAULTED 0x11
304 #define I2O_EVT_GEN_WARNING_NORMAL 0x00
305 #define I2O_EVT_GEN_WARNING_ERROR_THRESHOLD 0x01
306 #define I2O_EVT_GEN_WARNING_MEDIA_FAULT 0x02
308 #define I2O_EVT_CAPABILITY_OTHER 0x01
309 #define I2O_EVT_CAPABILITY_CHANGED 0x02
311 #define I2O_EVT_SENSOR_STATE_CHANGED 0x01
314 * I2O classes / subclasses
317 /* Class ID and Code Assignments
318 * (LCT.ClassID.Version field)
320 #define I2O_CLASS_VERSION_10 0x00
321 #define I2O_CLASS_VERSION_11 0x01
324 * (from v1.5 Table 6-1 Class Code Assignments.)
327 #define I2O_CLASS_EXECUTIVE 0x000
328 #define I2O_CLASS_DDM 0x001
329 #define I2O_CLASS_RANDOM_BLOCK_STORAGE 0x010
330 #define I2O_CLASS_SEQUENTIAL_STORAGE 0x011
331 #define I2O_CLASS_LAN 0x020
332 #define I2O_CLASS_WAN 0x030
333 #define I2O_CLASS_FIBRE_CHANNEL_PORT 0x040
334 #define I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL 0x041
335 #define I2O_CLASS_SCSI_PERIPHERAL 0x051
336 #define I2O_CLASS_ATE_PORT 0x060
337 #define I2O_CLASS_ATE_PERIPHERAL 0x061
338 #define I2O_CLASS_FLOPPY_CONTROLLER 0x070
339 #define I2O_CLASS_FLOPPY_DEVICE 0x071
340 #define I2O_CLASS_BUS_ADAPTER 0x080
341 #define I2O_CLASS_PEER_TRANSPORT_AGENT 0x090
342 #define I2O_CLASS_PEER_TRANSPORT 0x091
343 #define I2O_CLASS_END 0xfff
346 * Rest of 0x092 - 0x09f reserved for peer-to-peer classes
349 #define I2O_CLASS_MATCH_ANYCLASS 0xffffffff
355 #define I2O_SUBCLASS_i960 0x001
356 #define I2O_SUBCLASS_HDM 0x020
357 #define I2O_SUBCLASS_ISM 0x021
359 /* Operation functions */
361 #define I2O_PARAMS_FIELD_GET 0x0001
362 #define I2O_PARAMS_LIST_GET 0x0002
363 #define I2O_PARAMS_MORE_GET 0x0003
364 #define I2O_PARAMS_SIZE_GET 0x0004
365 #define I2O_PARAMS_TABLE_GET 0x0005
366 #define I2O_PARAMS_FIELD_SET 0x0006
367 #define I2O_PARAMS_LIST_SET 0x0007
368 #define I2O_PARAMS_ROW_ADD 0x0008
369 #define I2O_PARAMS_ROW_DELETE 0x0009
370 #define I2O_PARAMS_TABLE_CLEAR 0x000A
373 * I2O serial number conventions / formats
377 #define I2O_SNFORMAT_UNKNOWN 0
378 #define I2O_SNFORMAT_BINARY 1
379 #define I2O_SNFORMAT_ASCII 2
380 #define I2O_SNFORMAT_UNICODE 3
381 #define I2O_SNFORMAT_LAN48_MAC 4
382 #define I2O_SNFORMAT_WAN 5
385 * Plus new in v2.0 (Yellowstone pdf doc)
388 #define I2O_SNFORMAT_LAN64_MAC 6
389 #define I2O_SNFORMAT_DDM 7
390 #define I2O_SNFORMAT_IEEE_REG64 8
391 #define I2O_SNFORMAT_IEEE_REG128 9
392 #define I2O_SNFORMAT_UNKNOWN2 0xff
395 * I2O Get Status State values
398 #define ADAPTER_STATE_INITIALIZING 0x01
399 #define ADAPTER_STATE_RESET 0x02
400 #define ADAPTER_STATE_HOLD 0x04
401 #define ADAPTER_STATE_READY 0x05
402 #define ADAPTER_STATE_OPERATIONAL 0x08
403 #define ADAPTER_STATE_FAILED 0x10
404 #define ADAPTER_STATE_FAULTED 0x11
406 #endif /* _I2O_DEV_H */