include/linux/i2o-dev.h

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