Subversion Repositories shark

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
422 giacomo 1
/*
2
 * I2O user space accessible structures/APIs
3
 *
4
 * (c) Copyright 1999, 2000 Red Hat Software
5
 *
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.  
10
 *
11
 *************************************************************************
12
 *
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.
17
 *
18
 */
19
 
20
#ifndef _I2O_DEV_H
21
#define _I2O_DEV_H
22
 
23
/* How many controllers are we allowing */
24
#define MAX_I2O_CONTROLLERS     32
25
 
26
#include <linux/ioctl.h>
27
 
28
/*
29
 * I2O Control IOCTLs and structures
30
 */
31
#define I2O_MAGIC_NUMBER        'i'
32
#define I2OGETIOPS              _IOR(I2O_MAGIC_NUMBER,0,u8[MAX_I2O_CONTROLLERS])
33
#define I2OHRTGET               _IOWR(I2O_MAGIC_NUMBER,1,struct i2o_cmd_hrtlct)
34
#define I2OLCTGET               _IOWR(I2O_MAGIC_NUMBER,2,struct i2o_cmd_hrtlct)
35
#define I2OPARMSET              _IOWR(I2O_MAGIC_NUMBER,3,struct i2o_cmd_psetget)
36
#define I2OPARMGET              _IOWR(I2O_MAGIC_NUMBER,4,struct i2o_cmd_psetget)
37
#define I2OSWDL                 _IOWR(I2O_MAGIC_NUMBER,5,struct i2o_sw_xfer)
38
#define I2OSWUL                 _IOWR(I2O_MAGIC_NUMBER,6,struct i2o_sw_xfer)
39
#define I2OSWDEL                _IOWR(I2O_MAGIC_NUMBER,7,struct i2o_sw_xfer)
40
#define I2OVALIDATE             _IOR(I2O_MAGIC_NUMBER,8,u32)
41
#define I2OHTML                 _IOWR(I2O_MAGIC_NUMBER,9,struct i2o_html)
42
#define I2OEVTREG               _IOW(I2O_MAGIC_NUMBER,10,struct i2o_evt_id)
43
#define I2OEVTGET               _IOR(I2O_MAGIC_NUMBER,11,struct i2o_evt_info)
44
 
45
struct i2o_cmd_hrtlct
46
{
47
        unsigned int iop;       /* IOP unit number */
48
        void *resbuf;           /* Buffer for result */
49
        unsigned int *reslen;   /* Buffer length in bytes */
50
};
51
 
52
struct i2o_cmd_psetget
53
{
54
        unsigned int iop;       /* IOP unit number */
55
        unsigned int tid;       /* Target device TID */
56
        void *opbuf;            /* Operation List buffer */
57
        unsigned int oplen;     /* Operation List buffer length in bytes */
58
        void *resbuf;           /* Result List buffer */
59
        unsigned int *reslen;   /* Result List buffer length in bytes */
60
};
61
 
62
struct i2o_sw_xfer
63
{
64
        unsigned int iop;       /* IOP unit number */
65
        unsigned char flags;    /* Flags field */
66
        unsigned char sw_type;  /* Software type */
67
        unsigned int sw_id;     /* Software ID */
68
        void *buf;              /* Pointer to software buffer */
69
        unsigned int *swlen;    /* Length of software data */
70
        unsigned int *maxfrag;  /* Maximum fragment count */
71
        unsigned int *curfrag;  /* Current fragment count */
72
};
73
 
74
struct i2o_html
75
{
76
        unsigned int iop;       /* IOP unit number */
77
        unsigned int tid;       /* Target device ID */
78
        unsigned int page;      /* HTML page */
79
        void *resbuf;           /* Buffer for reply HTML page */
80
        unsigned int *reslen;   /* Length in bytes of reply buffer */
81
        void *qbuf;             /* Pointer to HTTP query string */
82
        unsigned int qlen;      /* Length in bytes of query string buffer */
83
};
84
 
85
#define I2O_EVT_Q_LEN 32
86
 
87
struct i2o_evt_id
88
{
89
        unsigned int iop;
90
        unsigned int tid;
91
        unsigned int evt_mask;
92
};
93
 
94
/* Event data size = frame size - message header + evt indicator */
95
#define I2O_EVT_DATA_SIZE 88
96
 
97
struct i2o_evt_info
98
{
99
        struct i2o_evt_id id;
100
        unsigned char evt_data[I2O_EVT_DATA_SIZE];
101
        unsigned int data_size;
102
};
103
 
104
struct i2o_evt_get
105
{
106
        struct i2o_evt_info info;
107
        int pending;
108
        int lost;
109
};
110
 
111
 
112
/**************************************************************************
113
 * HRT related constants and structures
114
 **************************************************************************/
115
#define I2O_BUS_LOCAL   0
116
#define I2O_BUS_ISA     1
117
#define I2O_BUS_EISA    2
118
#define I2O_BUS_MCA     3
119
#define I2O_BUS_PCI     4
120
#define I2O_BUS_PCMCIA  5
121
#define I2O_BUS_NUBUS   6
122
#define I2O_BUS_CARDBUS 7
123
#define I2O_BUS_UNKNOWN 0x80
124
 
125
#ifndef __KERNEL__
126
 
127
typedef unsigned char u8;
128
typedef unsigned short u16;
129
typedef unsigned int u32;
130
 
131
#endif /* __KERNEL__ */
132
 
133
typedef struct _i2o_pci_bus
134
{
135
        u8      PciFunctionNumber;
136
        u8      PciDeviceNumber;
137
        u8      PciBusNumber;
138
        u8      reserved;
139
        u16     PciVendorID;
140
        u16     PciDeviceID;
141
} i2o_pci_bus;
142
 
143
typedef struct _i2o_local_bus
144
{
145
        u16     LbBaseIOPort;
146
        u16     reserved;
147
        u32     LbBaseMemoryAddress;
148
} i2o_local_bus;
149
 
150
typedef struct _i2o_isa_bus
151
{
152
        u16     IsaBaseIOPort;
153
        u8      CSN;
154
        u8      reserved;
155
        u32     IsaBaseMemoryAddress;
156
} i2o_isa_bus;
157
 
158
typedef struct _i2o_eisa_bus_info
159
{
160
        u16     EisaBaseIOPort;
161
        u8      reserved;
162
        u8      EisaSlotNumber;
163
        u32     EisaBaseMemoryAddress;
164
} i2o_eisa_bus;
165
 
166
typedef struct _i2o_mca_bus
167
{
168
        u16     McaBaseIOPort;
169
        u8      reserved;
170
        u8      McaSlotNumber;
171
        u32     McaBaseMemoryAddress;
172
} i2o_mca_bus;
173
 
174
typedef struct _i2o_other_bus
175
{
176
        u16 BaseIOPort;
177
        u16 reserved;
178
        u32 BaseMemoryAddress;
179
} i2o_other_bus;
180
 
181
typedef struct _i2o_hrt_entry
182
{
183
        u32     adapter_id;
184
        u32     parent_tid:12;
185
        u32     tate:4;
186
        u32     bus_num:8;
187
        u32     bus_type:8;
188
        union
189
        {
190
                i2o_pci_bus     pci_bus;
191
                i2o_local_bus   local_bus;
192
                i2o_isa_bus     isa_bus;
193
                i2o_eisa_bus    eisa_bus;
194
                i2o_mca_bus     mca_bus;
195
                i2o_other_bus   other_bus;
196
        } bus;
197
} i2o_hrt_entry;
198
 
199
typedef struct _i2o_hrt
200
{
201
        u16     num_entries;
202
        u8      entry_len;
203
        u8      hrt_version;
204
        u32     change_ind;
205
        i2o_hrt_entry hrt_entry[1];
206
} i2o_hrt;
207
 
208
typedef struct _i2o_lct_entry
209
{
210
        u32     entry_size:16;
211
        u32     tid:12;
212
        u32     reserved:4;
213
        u32     change_ind;
214
        u32     device_flags;
215
        u32     class_id:12;
216
        u32     version:4;
217
        u32     vendor_id:16;
218
        u32     sub_class;
219
        u32     user_tid:12;
220
        u32     parent_tid:12;
221
        u32     bios_info:8;
222
        u8      identity_tag[8];
223
        u32     event_capabilities;
224
} i2o_lct_entry;
225
 
226
typedef struct _i2o_lct
227
{
228
        u32     table_size:16;
229
        u32     boot_tid:12;
230
        u32     lct_ver:4;
231
        u32     iop_flags;
232
        u32     change_ind;
233
        i2o_lct_entry lct_entry[1];
234
} i2o_lct;
235
 
236
typedef struct _i2o_status_block
237
{
238
        u16     org_id;
239
        u16     reserved;
240
        u16     iop_id:12;
241
        u16     reserved1:4;
242
        u16     host_unit_id;
243
        u16     segment_number:12;
244
        u16     i2o_version:4;
245
        u8      iop_state;
246
        u8      msg_type;
247
        u16     inbound_frame_size;
248
        u8      init_code;
249
        u8      reserved2;
250
        u32     max_inbound_frames;
251
        u32     cur_inbound_frames;
252
        u32     max_outbound_frames;
253
        char    product_id[24];
254
        u32     expected_lct_size;
255
        u32     iop_capabilities;
256
        u32     desired_mem_size;
257
        u32     current_mem_size;
258
        u32     current_mem_base;
259
        u32     desired_io_size;
260
        u32     current_io_size;
261
        u32     current_io_base;
262
        u32     reserved3:24;
263
        u32     cmd_status:8;
264
} i2o_status_block;
265
 
266
/* Event indicator mask flags */
267
#define I2O_EVT_IND_STATE_CHANGE                0x80000000
268
#define I2O_EVT_IND_GENERAL_WARNING             0x40000000
269
#define I2O_EVT_IND_CONFIGURATION_FLAG          0x20000000
270
#define I2O_EVT_IND_LOCK_RELEASE                0x10000000
271
#define I2O_EVT_IND_CAPABILITY_CHANGE           0x08000000
272
#define I2O_EVT_IND_DEVICE_RESET                0x04000000
273
#define I2O_EVT_IND_EVT_MASK_MODIFIED           0x02000000
274
#define I2O_EVT_IND_FIELD_MODIFIED              0x01000000
275
#define I2O_EVT_IND_VENDOR_EVT                  0x00800000
276
#define I2O_EVT_IND_DEVICE_STATE                0x00400000
277
 
278
/* Executive event indicitors */
279
#define I2O_EVT_IND_EXEC_RESOURCE_LIMITS        0x00000001
280
#define I2O_EVT_IND_EXEC_CONNECTION_FAIL        0x00000002
281
#define I2O_EVT_IND_EXEC_ADAPTER_FAULT          0x00000004
282
#define I2O_EVT_IND_EXEC_POWER_FAIL             0x00000008
283
#define I2O_EVT_IND_EXEC_RESET_PENDING          0x00000010
284
#define I2O_EVT_IND_EXEC_RESET_IMMINENT         0x00000020
285
#define I2O_EVT_IND_EXEC_HW_FAIL                0x00000040
286
#define I2O_EVT_IND_EXEC_XCT_CHANGE             0x00000080
287
#define I2O_EVT_IND_EXEC_NEW_LCT_ENTRY          0x00000100
288
#define I2O_EVT_IND_EXEC_MODIFIED_LCT           0x00000200
289
#define I2O_EVT_IND_EXEC_DDM_AVAILABILITY       0x00000400
290
 
291
/* Random Block Storage Event Indicators */
292
#define I2O_EVT_IND_BSA_VOLUME_LOAD             0x00000001
293
#define I2O_EVT_IND_BSA_VOLUME_UNLOAD           0x00000002
294
#define I2O_EVT_IND_BSA_VOLUME_UNLOAD_REQ       0x00000004
295
#define I2O_EVT_IND_BSA_CAPACITY_CHANGE         0x00000008
296
#define I2O_EVT_IND_BSA_SCSI_SMART              0x00000010
297
 
298
/* Event data for generic events */
299
#define I2O_EVT_STATE_CHANGE_NORMAL             0x00
300
#define I2O_EVT_STATE_CHANGE_SUSPENDED          0x01
301
#define I2O_EVT_STATE_CHANGE_RESTART            0x02
302
#define I2O_EVT_STATE_CHANGE_NA_RECOVER         0x03
303
#define I2O_EVT_STATE_CHANGE_NA_NO_RECOVER      0x04
304
#define I2O_EVT_STATE_CHANGE_QUIESCE_REQUEST    0x05
305
#define I2O_EVT_STATE_CHANGE_FAILED             0x10
306
#define I2O_EVT_STATE_CHANGE_FAULTED            0x11
307
 
308
#define I2O_EVT_GEN_WARNING_NORMAL              0x00
309
#define I2O_EVT_GEN_WARNING_ERROR_THRESHOLD     0x01
310
#define I2O_EVT_GEN_WARNING_MEDIA_FAULT         0x02
311
 
312
#define I2O_EVT_CAPABILITY_OTHER                0x01
313
#define I2O_EVT_CAPABILITY_CHANGED              0x02
314
 
315
#define I2O_EVT_SENSOR_STATE_CHANGED            0x01
316
 
317
/*
318
 *      I2O classes / subclasses
319
 */
320
 
321
/*  Class ID and Code Assignments
322
 *  (LCT.ClassID.Version field)
323
 */
324
#define I2O_CLASS_VERSION_10                    0x00
325
#define I2O_CLASS_VERSION_11                    0x01
326
 
327
/*  Class code names
328
 *  (from v1.5 Table 6-1 Class Code Assignments.)
329
 */
330
 
331
#define I2O_CLASS_EXECUTIVE                     0x000
332
#define I2O_CLASS_DDM                           0x001
333
#define I2O_CLASS_RANDOM_BLOCK_STORAGE          0x010
334
#define I2O_CLASS_SEQUENTIAL_STORAGE            0x011
335
#define I2O_CLASS_LAN                           0x020
336
#define I2O_CLASS_WAN                           0x030
337
#define I2O_CLASS_FIBRE_CHANNEL_PORT            0x040
338
#define I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL      0x041
339
#define I2O_CLASS_SCSI_PERIPHERAL               0x051
340
#define I2O_CLASS_ATE_PORT                      0x060
341
#define I2O_CLASS_ATE_PERIPHERAL                0x061
342
#define I2O_CLASS_FLOPPY_CONTROLLER             0x070
343
#define I2O_CLASS_FLOPPY_DEVICE                 0x071
344
#define I2O_CLASS_BUS_ADAPTER_PORT              0x080
345
#define I2O_CLASS_PEER_TRANSPORT_AGENT          0x090
346
#define I2O_CLASS_PEER_TRANSPORT                0x091
347
 
348
/*
349
 *  Rest of 0x092 - 0x09f reserved for peer-to-peer classes
350
 */
351
 
352
#define I2O_CLASS_MATCH_ANYCLASS                0xffffffff
353
 
354
/*
355
 *  Subclasses
356
 */
357
 
358
#define I2O_SUBCLASS_i960                       0x001
359
#define I2O_SUBCLASS_HDM                        0x020
360
#define I2O_SUBCLASS_ISM                        0x021
361
 
362
/* Operation functions */
363
 
364
#define I2O_PARAMS_FIELD_GET                    0x0001
365
#define I2O_PARAMS_LIST_GET                     0x0002
366
#define I2O_PARAMS_MORE_GET                     0x0003
367
#define I2O_PARAMS_SIZE_GET                     0x0004
368
#define I2O_PARAMS_TABLE_GET                    0x0005
369
#define I2O_PARAMS_FIELD_SET                    0x0006
370
#define I2O_PARAMS_LIST_SET                     0x0007
371
#define I2O_PARAMS_ROW_ADD                      0x0008
372
#define I2O_PARAMS_ROW_DELETE                   0x0009
373
#define I2O_PARAMS_TABLE_CLEAR                  0x000A
374
 
375
/*
376
 * I2O serial number conventions / formats
377
 * (circa v1.5)
378
 */
379
 
380
#define I2O_SNFORMAT_UNKNOWN                    0
381
#define I2O_SNFORMAT_BINARY                     1
382
#define I2O_SNFORMAT_ASCII                      2
383
#define I2O_SNFORMAT_UNICODE                    3
384
#define I2O_SNFORMAT_LAN48_MAC                  4
385
#define I2O_SNFORMAT_WAN                        5
386
 
387
/*
388
 * Plus new in v2.0 (Yellowstone pdf doc)
389
 */
390
 
391
#define I2O_SNFORMAT_LAN64_MAC                  6
392
#define I2O_SNFORMAT_DDM                        7
393
#define I2O_SNFORMAT_IEEE_REG64                 8
394
#define I2O_SNFORMAT_IEEE_REG128                9
395
#define I2O_SNFORMAT_UNKNOWN2                   0xff
396
 
397
/*
398
 *      I2O Get Status State values
399
 */
400
 
401
#define ADAPTER_STATE_INITIALIZING              0x01
402
#define ADAPTER_STATE_RESET                     0x02
403
#define ADAPTER_STATE_HOLD                      0x04
404
#define ADAPTER_STATE_READY                     0x05
405
#define ADAPTER_STATE_OPERATIONAL               0x08
406
#define ADAPTER_STATE_FAILED                    0x10
407
#define ADAPTER_STATE_FAULTED                   0x11
408
 
409
#endif /* _I2O_DEV_H */