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