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 #ifndef __KERNEL__
  28
  29 typedef unsigned char u8;
  30 typedef unsigned short u16;
  31 typedef unsigned int u32;
  32
  33 #endif                          /* __KERNEL__ */
  34
  35 /*
  36  *      Software module types
  37  */
  38 #define I2O_SOFTWARE_MODULE_IRTOS               0x11
  39 #define I2O_SOFTWARE_MODULE_IOP_PRIVATE         0x22
  40 #define I2O_SOFTWARE_MODULE_IOP_CONFIG          0x23
  41
  42 /*
  43  *      Vendors
  44  */
  45 #define I2O_VENDOR_DPT                          0x001b
  46
  47 /*
  48  * I2O Control IOCTLs and structures
  49  */
  50 #define I2O_MAGIC_NUMBER        'i'
  51 #define I2OGETIOPS              _IOR(I2O_MAGIC_NUMBER,0,u8[MAX_I2O_CONTROLLERS])
  52 #define I2OHRTGET               _IOWR(I2O_MAGIC_NUMBER,1,struct i2o_cmd_hrtlct)
  53 #define I2OLCTGET               _IOWR(I2O_MAGIC_NUMBER,2,struct i2o_cmd_hrtlct)
  54 #define I2OPARMSET              _IOWR(I2O_MAGIC_NUMBER,3,struct i2o_cmd_psetget)
  55 #define I2OPARMGET              _IOWR(I2O_MAGIC_NUMBER,4,struct i2o_cmd_psetget)
  56 #define I2OSWDL                 _IOWR(I2O_MAGIC_NUMBER,5,struct i2o_sw_xfer)
  57 #define I2OSWUL                 _IOWR(I2O_MAGIC_NUMBER,6,struct i2o_sw_xfer)
  58 #define I2OSWDEL                _IOWR(I2O_MAGIC_NUMBER,7,struct i2o_sw_xfer)
  59 #define I2OVALIDATE             _IOR(I2O_MAGIC_NUMBER,8,u32)
  60 #define I2OHTML                 _IOWR(I2O_MAGIC_NUMBER,9,struct i2o_html)
  61 #define I2OEVTREG               _IOW(I2O_MAGIC_NUMBER,10,struct i2o_evt_id)
  62 #define I2OEVTGET               _IOR(I2O_MAGIC_NUMBER,11,struct i2o_evt_info)
  63 #define I2OPASSTHRU             _IOR(I2O_MAGIC_NUMBER,12,struct i2o_cmd_passthru)
  64 #define I2OPASSTHRU32           _IOR(I2O_MAGIC_NUMBER,12,struct i2o_cmd_passthru32)
  65
  66 struct i2o_cmd_passthru32 {
  67         unsigned int iop;       /* IOP unit number */
  68         u32 msg;                /* message */
  69 };
  70
  71 struct i2o_cmd_passthru {
  72         unsigned int iop;       /* IOP unit number */
  73         void __user *msg;       /* message */
  74 };
  75
  76 struct i2o_cmd_hrtlct {
  77         unsigned int iop;       /* IOP unit number */
  78         void __user *resbuf;    /* Buffer for result */
  79         unsigned int __user *reslen;    /* Buffer length in bytes */
  80 };
  81
  82 struct i2o_cmd_psetget {
  83         unsigned int iop;       /* IOP unit number */
  84         unsigned int tid;       /* Target device TID */
  85         void __user *opbuf;     /* Operation List buffer */
  86         unsigned int oplen;     /* Operation List buffer length in bytes */
  87         void __user *resbuf;    /* Result List buffer */
  88         unsigned int __user *reslen;    /* Result List buffer length in bytes */
  89 };
  90
  91 struct i2o_sw_xfer {
  92         unsigned int iop;       /* IOP unit number */
  93         unsigned char flags;    /* Flags field */
  94         unsigned char sw_type;  /* Software type */
  95         unsigned int sw_id;     /* Software ID */
  96         void __user *buf;       /* Pointer to software buffer */
  97         unsigned int __user *swlen;     /* Length of software data */
  98         unsigned int __user *maxfrag;   /* Maximum fragment count */
  99         unsigned int __user *curfrag;   /* Current fragment count */
 100 };
 101
 102 struct i2o_html {
 103         unsigned int iop;       /* IOP unit number */
 104         unsigned int tid;       /* Target device ID */
 105         unsigned int page;      /* HTML page */
 106         void __user *resbuf;    /* Buffer for reply HTML page */
 107         unsigned int __user *reslen;    /* Length in bytes of reply buffer */
 108         void __user *qbuf;      /* Pointer to HTTP query string */
 109         unsigned int qlen;      /* Length in bytes of query string buffer */
 110 };
 111
 112 #define I2O_EVT_Q_LEN 32
 113
 114 struct i2o_evt_id {
 115         unsigned int iop;
 116         unsigned int tid;
 117         unsigned int evt_mask;
 118 };
 119
 120 /* Event data size = frame size - message header + evt indicator */
 121 #define I2O_EVT_DATA_SIZE 88
 122
 123 struct i2o_evt_info {
 124         struct i2o_evt_id id;
 125         unsigned char evt_data[I2O_EVT_DATA_SIZE];
 126         unsigned int data_size;
 127 };
 128
 129 struct i2o_evt_get {
 130         struct i2o_evt_info info;
 131         int pending;
 132         int lost;
 133 };
 134
 135 typedef struct i2o_sg_io_hdr {
 136         unsigned int flags;     /* see I2O_DPT_SG_IO_FLAGS */
 137 } i2o_sg_io_hdr_t;
 138
 139 /**************************************************************************
 140  * HRT related constants and structures
 141  **************************************************************************/
 142 #define I2O_BUS_LOCAL   0
 143 #define I2O_BUS_ISA     1
 144 #define I2O_BUS_EISA    2
 145 #define I2O_BUS_MCA     3
 146 #define I2O_BUS_PCI     4
 147 #define I2O_BUS_PCMCIA  5
 148 #define I2O_BUS_NUBUS   6
 149 #define I2O_BUS_CARDBUS 7
 150 #define I2O_BUS_UNKNOWN 0x80
 151
 152 typedef struct _i2o_pci_bus {
 153         u8 PciFunctionNumber;
 154         u8 PciDeviceNumber;
 155         u8 PciBusNumber;
 156         u8 reserved;
 157         u16 PciVendorID;
 158         u16 PciDeviceID;
 159 } i2o_pci_bus;
 160
 161 typedef struct _i2o_local_bus {
 162         u16 LbBaseIOPort;
 163         u16 reserved;
 164         u32 LbBaseMemoryAddress;
 165 } i2o_local_bus;
 166
 167 typedef struct _i2o_isa_bus {
 168         u16 IsaBaseIOPort;
 169         u8 CSN;
 170         u8 reserved;
 171         u32 IsaBaseMemoryAddress;
 172 } i2o_isa_bus;
 173
 174 typedef struct _i2o_eisa_bus_info {
 175         u16 EisaBaseIOPort;
 176         u8 reserved;
 177         u8 EisaSlotNumber;
 178         u32 EisaBaseMemoryAddress;
 179 } i2o_eisa_bus;
 180
 181 typedef struct _i2o_mca_bus {
 182         u16 McaBaseIOPort;
 183         u8 reserved;
 184         u8 McaSlotNumber;
 185         u32 McaBaseMemoryAddress;
 186 } i2o_mca_bus;
 187
 188 typedef struct _i2o_other_bus {
 189         u16 BaseIOPort;
 190         u16 reserved;
 191         u32 BaseMemoryAddress;
 192 } i2o_other_bus;
 193
 194 typedef struct _i2o_hrt_entry {
 195         u32 adapter_id;
 196         u32 parent_tid:12;
 197         u32 state:4;
 198         u32 bus_num:8;
 199         u32 bus_type:8;
 200         union {
 201                 i2o_pci_bus pci_bus;
 202                 i2o_local_bus local_bus;
 203                 i2o_isa_bus isa_bus;
 204                 i2o_eisa_bus eisa_bus;
 205                 i2o_mca_bus mca_bus;
 206                 i2o_other_bus other_bus;
 207         } bus;
 208 } i2o_hrt_entry;
 209
 210 typedef struct _i2o_hrt {
 211         u16 num_entries;
 212         u8 entry_len;
 213         u8 hrt_version;
 214         u32 change_ind;
 215         i2o_hrt_entry hrt_entry[1];
 216 } i2o_hrt;
 217
 218 typedef struct _i2o_lct_entry {
 219         u32 entry_size:16;
 220         u32 tid:12;
 221         u32 reserved:4;
 222         u32 change_ind;
 223         u32 device_flags;
 224         u32 class_id:12;
 225         u32 version:4;
 226         u32 vendor_id:16;
 227         u32 sub_class;
 228         u32 user_tid:12;
 229         u32 parent_tid:12;
 230         u32 bios_info:8;
 231         u8 identity_tag[8];
 232         u32 event_capabilities;
 233 } i2o_lct_entry;
 234
 235 typedef struct _i2o_lct {
 236         u32 table_size:16;
 237         u32 boot_tid:12;
 238         u32 lct_ver:4;
 239         u32 iop_flags;
 240         u32 change_ind;
 241         i2o_lct_entry lct_entry[1];
 242 } i2o_lct;
 243
 244 typedef struct _i2o_status_block {
 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                   0x080
 352 #define I2O_CLASS_PEER_TRANSPORT_AGENT          0x090
 353 #define I2O_CLASS_PEER_TRANSPORT                0x091
 354 #define I2O_CLASS_END                           0xfff
 355
 356 /*
 357  *  Rest of 0x092 - 0x09f reserved for peer-to-peer classes
 358  */
 359
 360 #define I2O_CLASS_MATCH_ANYCLASS                0xffffffff
 361
 362 /*
 363  *  Subclasses
 364  */
 365
 366 #define I2O_SUBCLASS_i960                       0x001
 367 #define I2O_SUBCLASS_HDM                        0x020
 368 #define I2O_SUBCLASS_ISM                        0x021
 369
 370 /* Operation functions */
 371
 372 #define I2O_PARAMS_FIELD_GET                    0x0001
 373 #define I2O_PARAMS_LIST_GET                     0x0002
 374 #define I2O_PARAMS_MORE_GET                     0x0003
 375 #define I2O_PARAMS_SIZE_GET                     0x0004
 376 #define I2O_PARAMS_TABLE_GET                    0x0005
 377 #define I2O_PARAMS_FIELD_SET                    0x0006
 378 #define I2O_PARAMS_LIST_SET                     0x0007
 379 #define I2O_PARAMS_ROW_ADD                      0x0008
 380 #define I2O_PARAMS_ROW_DELETE                   0x0009
 381 #define I2O_PARAMS_TABLE_CLEAR                  0x000A
 382
 383 /*
 384  * I2O serial number conventions / formats
 385  * (circa v1.5)
 386  */
 387
 388 #define I2O_SNFORMAT_UNKNOWN                    0
 389 #define I2O_SNFORMAT_BINARY                     1
 390 #define I2O_SNFORMAT_ASCII                      2
 391 #define I2O_SNFORMAT_UNICODE                    3
 392 #define I2O_SNFORMAT_LAN48_MAC                  4
 393 #define I2O_SNFORMAT_WAN                        5
 394
 395 /*
 396  * Plus new in v2.0 (Yellowstone pdf doc)
 397  */
 398
 399 #define I2O_SNFORMAT_LAN64_MAC                  6
 400 #define I2O_SNFORMAT_DDM                        7
 401 #define I2O_SNFORMAT_IEEE_REG64                 8
 402 #define I2O_SNFORMAT_IEEE_REG128                9
 403 #define I2O_SNFORMAT_UNKNOWN2                   0xff
 404
 405 /*
 406  *      I2O Get Status State values
 407  */
 408
 409 #define ADAPTER_STATE_INITIALIZING              0x01
 410 #define ADAPTER_STATE_RESET                     0x02
 411 #define ADAPTER_STATE_HOLD                      0x04
 412 #define ADAPTER_STATE_READY                     0x05
 413 #define ADAPTER_STATE_OPERATIONAL               0x08
 414 #define ADAPTER_STATE_FAILED                    0x10
 415 #define ADAPTER_STATE_FAULTED                   0x11
 416
 417
 418 /*
 419  * DPT / Adaptec specific values for i2o_sg_io_hdr flags.
 420  */
 421 #define I2O_DPT_SG_FLAG_INTERPRET               0x00010000
 422 #define I2O_DPT_SG_FLAG_PHYSICAL                0x00020000
 423
 424 #define I2O_DPT_FLASH_FRAG_SIZE                 0x10000
 425 #define I2O_DPT_FLASH_READ                      0x0101
 426 #define I2O_DPT_FLASH_WRITE                     0x0102
 427
 428 #endif                          /* _I2O_DEV_H */