drivers/scsi/dpt/dpti_i2o.h

   1 #ifndef _SCSI_I2O_H
   2 #define _SCSI_I2O_H
   3
   4 /* I2O kernel space accessible structures/APIs
   5  *
   6  * (c) Copyright 1999, 2000 Red Hat Software
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version
  11  * 2 of the License, or (at your option) any later version.
  12  *
  13  *************************************************************************
  14  *
  15  * This header file defined the I2O APIs/structures for use by
  16  * the I2O kernel modules.
  17  *
  18  */
  19
  20 #ifdef __KERNEL__       /* This file to be included by kernel only */
  21
  22 #include <linux/i2o-dev.h>
  23
  24 #include <linux/version.h>
  25 #include <linux/notifier.h>
  26 #include <asm/atomic.h>
  27
  28
  29 /*
  30  *      Tunable parameters first
  31  */
  32
  33 /* How many different OSM's are we allowing */
  34 #define MAX_I2O_MODULES         64
  35
  36 #define I2O_EVT_CAPABILITY_OTHER                0x01
  37 #define I2O_EVT_CAPABILITY_CHANGED              0x02
  38
  39 #define I2O_EVT_SENSOR_STATE_CHANGED            0x01
  40
  41 //#ifdef __KERNEL__   /* ioctl stuff only thing exported to users */
  42
  43 #define I2O_MAX_MANAGERS        4
  44
  45 /*
  46  *      I2O Interface Objects
  47  */
  48
  49 #include <linux/wait.h>
  50 typedef wait_queue_head_t adpt_wait_queue_head_t;
  51 #define ADPT_DECLARE_WAIT_QUEUE_HEAD(wait) DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wait)
  52 typedef wait_queue_t adpt_wait_queue_t;
  53
  54 /*
  55  * message structures
  56  */
  57
  58 struct i2o_message
  59 {
  60         u8      version_offset;
  61         u8      flags;
  62         u16     size;
  63         u32     target_tid:12;
  64         u32     init_tid:12;
  65         u32     function:8;
  66         u32     initiator_context;
  67         /* List follows */
  68 };
  69
  70 struct adpt_device;
  71 struct _adpt_hba;
  72 struct i2o_device
  73 {
  74         struct i2o_device *next;        /* Chain */
  75         struct i2o_device *prev;
  76
  77         char dev_name[8];               /* linux /dev name if available */
  78         i2o_lct_entry lct_data;/* Device LCT information */
  79         u32 flags;
  80         struct proc_dir_entry* proc_entry;      /* /proc dir */
  81         struct adpt_device *owner;
  82         struct _adpt_hba *controller;   /* Controlling IOP */
  83 };
  84
  85 /*
  86  *      Each I2O controller has one of these objects
  87  */
  88
  89 struct i2o_controller
  90 {
  91         char name[16];
  92         int unit;
  93         int type;
  94         int enabled;
  95
  96         struct notifier_block *event_notifer;   /* Events */
  97         atomic_t users;
  98         struct i2o_device *devices;             /* I2O device chain */
  99         struct i2o_controller *next;            /* Controller chain */
 100
 101 };
 102
 103 /*
 104  * I2O System table entry
 105  */
 106 struct i2o_sys_tbl_entry
 107 {
 108         u16     org_id;
 109         u16     reserved1;
 110         u32     iop_id:12;
 111         u32     reserved2:20;
 112         u16     seg_num:12;
 113         u16     i2o_version:4;
 114         u8      iop_state;
 115         u8      msg_type;
 116         u16     frame_size;
 117         u16     reserved3;
 118         u32     last_changed;
 119         u32     iop_capabilities;
 120         u32     inbound_low;
 121         u32     inbound_high;
 122 };
 123
 124 struct i2o_sys_tbl
 125 {
 126         u8      num_entries;
 127         u8      version;
 128         u16     reserved1;
 129         u32     change_ind;
 130         u32     reserved2;
 131         u32     reserved3;
 132         struct i2o_sys_tbl_entry iops[0];
 133 };
 134
 135 /*
 136  *      I2O classes / subclasses
 137  */
 138
 139 /*  Class ID and Code Assignments
 140  *  (LCT.ClassID.Version field)
 141  */
 142 #define    I2O_CLASS_VERSION_10                        0x00
 143 #define    I2O_CLASS_VERSION_11                        0x01
 144
 145 /*  Class code names
 146  *  (from v1.5 Table 6-1 Class Code Assignments.)
 147  */
 148
 149 #define    I2O_CLASS_EXECUTIVE                         0x000
 150 #define    I2O_CLASS_DDM                               0x001
 151 #define    I2O_CLASS_RANDOM_BLOCK_STORAGE              0x010
 152 #define    I2O_CLASS_SEQUENTIAL_STORAGE                0x011
 153 #define    I2O_CLASS_LAN                               0x020
 154 #define    I2O_CLASS_WAN                               0x030
 155 #define    I2O_CLASS_FIBRE_CHANNEL_PORT                0x040
 156 #define    I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL          0x041
 157 #define    I2O_CLASS_SCSI_PERIPHERAL                   0x051
 158 #define    I2O_CLASS_ATE_PORT                          0x060
 159 #define    I2O_CLASS_ATE_PERIPHERAL                    0x061
 160 #define    I2O_CLASS_FLOPPY_CONTROLLER                 0x070
 161 #define    I2O_CLASS_FLOPPY_DEVICE                     0x071
 162 #define    I2O_CLASS_BUS_ADAPTER_PORT                  0x080
 163 #define    I2O_CLASS_PEER_TRANSPORT_AGENT              0x090
 164 #define    I2O_CLASS_PEER_TRANSPORT                    0x091
 165
 166 /*  Rest of 0x092 - 0x09f reserved for peer-to-peer classes
 167  */
 168
 169 #define    I2O_CLASS_MATCH_ANYCLASS                    0xffffffff
 170
 171 /*  Subclasses
 172  */
 173
 174 #define    I2O_SUBCLASS_i960                           0x001
 175 #define    I2O_SUBCLASS_HDM                            0x020
 176 #define    I2O_SUBCLASS_ISM                            0x021
 177
 178 /* Operation functions */
 179
 180 #define I2O_PARAMS_FIELD_GET    0x0001
 181 #define I2O_PARAMS_LIST_GET     0x0002
 182 #define I2O_PARAMS_MORE_GET     0x0003
 183 #define I2O_PARAMS_SIZE_GET     0x0004
 184 #define I2O_PARAMS_TABLE_GET    0x0005
 185 #define I2O_PARAMS_FIELD_SET    0x0006
 186 #define I2O_PARAMS_LIST_SET     0x0007
 187 #define I2O_PARAMS_ROW_ADD      0x0008
 188 #define I2O_PARAMS_ROW_DELETE   0x0009
 189 #define I2O_PARAMS_TABLE_CLEAR  0x000A
 190
 191 /*
 192  *      I2O serial number conventions / formats
 193  *      (circa v1.5)
 194  */
 195
 196 #define    I2O_SNFORMAT_UNKNOWN                        0
 197 #define    I2O_SNFORMAT_BINARY                         1
 198 #define    I2O_SNFORMAT_ASCII                          2
 199 #define    I2O_SNFORMAT_UNICODE                        3
 200 #define    I2O_SNFORMAT_LAN48_MAC                      4
 201 #define    I2O_SNFORMAT_WAN                            5
 202
 203 /* Plus new in v2.0 (Yellowstone pdf doc)
 204  */
 205
 206 #define    I2O_SNFORMAT_LAN64_MAC                      6
 207 #define    I2O_SNFORMAT_DDM                            7
 208 #define    I2O_SNFORMAT_IEEE_REG64                     8
 209 #define    I2O_SNFORMAT_IEEE_REG128                    9
 210 #define    I2O_SNFORMAT_UNKNOWN2                       0xff
 211
 212 /* Transaction Reply Lists (TRL) Control Word structure */
 213
 214 #define TRL_SINGLE_FIXED_LENGTH         0x00
 215 #define TRL_SINGLE_VARIABLE_LENGTH      0x40
 216 #define TRL_MULTIPLE_FIXED_LENGTH       0x80
 217
 218 /*
 219  *      Messaging API values
 220  */
 221
 222 #define I2O_CMD_ADAPTER_ASSIGN          0xB3
 223 #define I2O_CMD_ADAPTER_READ            0xB2
 224 #define I2O_CMD_ADAPTER_RELEASE         0xB5
 225 #define I2O_CMD_BIOS_INFO_SET           0xA5
 226 #define I2O_CMD_BOOT_DEVICE_SET         0xA7
 227 #define I2O_CMD_CONFIG_VALIDATE         0xBB
 228 #define I2O_CMD_CONN_SETUP              0xCA
 229 #define I2O_CMD_DDM_DESTROY             0xB1
 230 #define I2O_CMD_DDM_ENABLE              0xD5
 231 #define I2O_CMD_DDM_QUIESCE             0xC7
 232 #define I2O_CMD_DDM_RESET               0xD9
 233 #define I2O_CMD_DDM_SUSPEND             0xAF
 234 #define I2O_CMD_DEVICE_ASSIGN           0xB7
 235 #define I2O_CMD_DEVICE_RELEASE          0xB9
 236 #define I2O_CMD_HRT_GET                 0xA8
 237 #define I2O_CMD_ADAPTER_CLEAR           0xBE
 238 #define I2O_CMD_ADAPTER_CONNECT         0xC9
 239 #define I2O_CMD_ADAPTER_RESET           0xBD
 240 #define I2O_CMD_LCT_NOTIFY              0xA2
 241 #define I2O_CMD_OUTBOUND_INIT           0xA1
 242 #define I2O_CMD_PATH_ENABLE             0xD3
 243 #define I2O_CMD_PATH_QUIESCE            0xC5
 244 #define I2O_CMD_PATH_RESET              0xD7
 245 #define I2O_CMD_STATIC_MF_CREATE        0xDD
 246 #define I2O_CMD_STATIC_MF_RELEASE       0xDF
 247 #define I2O_CMD_STATUS_GET              0xA0
 248 #define I2O_CMD_SW_DOWNLOAD             0xA9
 249 #define I2O_CMD_SW_UPLOAD               0xAB
 250 #define I2O_CMD_SW_REMOVE               0xAD
 251 #define I2O_CMD_SYS_ENABLE              0xD1
 252 #define I2O_CMD_SYS_MODIFY              0xC1
 253 #define I2O_CMD_SYS_QUIESCE             0xC3
 254 #define I2O_CMD_SYS_TAB_SET             0xA3
 255
 256 #define I2O_CMD_UTIL_NOP                0x00
 257 #define I2O_CMD_UTIL_ABORT              0x01
 258 #define I2O_CMD_UTIL_CLAIM              0x09
 259 #define I2O_CMD_UTIL_RELEASE            0x0B
 260 #define I2O_CMD_UTIL_PARAMS_GET         0x06
 261 #define I2O_CMD_UTIL_PARAMS_SET         0x05
 262 #define I2O_CMD_UTIL_EVT_REGISTER       0x13
 263 #define I2O_CMD_UTIL_EVT_ACK            0x14
 264 #define I2O_CMD_UTIL_CONFIG_DIALOG      0x10
 265 #define I2O_CMD_UTIL_DEVICE_RESERVE     0x0D
 266 #define I2O_CMD_UTIL_DEVICE_RELEASE     0x0F
 267 #define I2O_CMD_UTIL_LOCK               0x17
 268 #define I2O_CMD_UTIL_LOCK_RELEASE       0x19
 269 #define I2O_CMD_UTIL_REPLY_FAULT_NOTIFY 0x15
 270
 271 #define I2O_CMD_SCSI_EXEC               0x81
 272 #define I2O_CMD_SCSI_ABORT              0x83
 273 #define I2O_CMD_SCSI_BUSRESET           0x27
 274
 275 #define I2O_CMD_BLOCK_READ              0x30
 276 #define I2O_CMD_BLOCK_WRITE             0x31
 277 #define I2O_CMD_BLOCK_CFLUSH            0x37
 278 #define I2O_CMD_BLOCK_MLOCK             0x49
 279 #define I2O_CMD_BLOCK_MUNLOCK           0x4B
 280 #define I2O_CMD_BLOCK_MMOUNT            0x41
 281 #define I2O_CMD_BLOCK_MEJECT            0x43
 282
 283 #define I2O_PRIVATE_MSG                 0xFF
 284
 285 /*
 286  *      Init Outbound Q status
 287  */
 288
 289 #define I2O_CMD_OUTBOUND_INIT_IN_PROGRESS       0x01
 290 #define I2O_CMD_OUTBOUND_INIT_REJECTED          0x02
 291 #define I2O_CMD_OUTBOUND_INIT_FAILED            0x03
 292 #define I2O_CMD_OUTBOUND_INIT_COMPLETE          0x04
 293
 294 /*
 295  *      I2O Get Status State values
 296  */
 297
 298 #define ADAPTER_STATE_INITIALIZING              0x01
 299 #define ADAPTER_STATE_RESET                     0x02
 300 #define ADAPTER_STATE_HOLD                      0x04
 301 #define ADAPTER_STATE_READY                     0x05
 302 #define ADAPTER_STATE_OPERATIONAL               0x08
 303 #define ADAPTER_STATE_FAILED                    0x10
 304 #define ADAPTER_STATE_FAULTED                   0x11
 305
 306 /* I2O API function return values */
 307
 308 #define I2O_RTN_NO_ERROR                        0
 309 #define I2O_RTN_NOT_INIT                        1
 310 #define I2O_RTN_FREE_Q_EMPTY                    2
 311 #define I2O_RTN_TCB_ERROR                       3
 312 #define I2O_RTN_TRANSACTION_ERROR               4
 313 #define I2O_RTN_ADAPTER_ALREADY_INIT            5
 314 #define I2O_RTN_MALLOC_ERROR                    6
 315 #define I2O_RTN_ADPTR_NOT_REGISTERED            7
 316 #define I2O_RTN_MSG_REPLY_TIMEOUT               8
 317 #define I2O_RTN_NO_STATUS                       9
 318 #define I2O_RTN_NO_FIRM_VER                     10
 319 #define I2O_RTN_NO_LINK_SPEED                   11
 320
 321 /* Reply message status defines for all messages */
 322
 323 #define I2O_REPLY_STATUS_SUCCESS                        0x00
 324 #define I2O_REPLY_STATUS_ABORT_DIRTY                    0x01
 325 #define I2O_REPLY_STATUS_ABORT_NO_DATA_TRANSFER         0x02
 326 #define I2O_REPLY_STATUS_ABORT_PARTIAL_TRANSFER         0x03
 327 #define I2O_REPLY_STATUS_ERROR_DIRTY                    0x04
 328 #define I2O_REPLY_STATUS_ERROR_NO_DATA_TRANSFER         0x05
 329 #define I2O_REPLY_STATUS_ERROR_PARTIAL_TRANSFER         0x06
 330 #define I2O_REPLY_STATUS_PROCESS_ABORT_DIRTY            0x08
 331 #define I2O_REPLY_STATUS_PROCESS_ABORT_NO_DATA_TRANSFER 0x09
 332 #define I2O_REPLY_STATUS_PROCESS_ABORT_PARTIAL_TRANSFER 0x0A
 333 #define I2O_REPLY_STATUS_TRANSACTION_ERROR              0x0B
 334 #define I2O_REPLY_STATUS_PROGRESS_REPORT                0x80
 335
 336 /* Status codes and Error Information for Parameter functions */
 337
 338 #define I2O_PARAMS_STATUS_SUCCESS               0x00
 339 #define I2O_PARAMS_STATUS_BAD_KEY_ABORT         0x01
 340 #define I2O_PARAMS_STATUS_BAD_KEY_CONTINUE      0x02
 341 #define I2O_PARAMS_STATUS_BUFFER_FULL           0x03
 342 #define I2O_PARAMS_STATUS_BUFFER_TOO_SMALL      0x04
 343 #define I2O_PARAMS_STATUS_FIELD_UNREADABLE      0x05
 344 #define I2O_PARAMS_STATUS_FIELD_UNWRITEABLE     0x06
 345 #define I2O_PARAMS_STATUS_INSUFFICIENT_FIELDS   0x07
 346 #define I2O_PARAMS_STATUS_INVALID_GROUP_ID      0x08
 347 #define I2O_PARAMS_STATUS_INVALID_OPERATION     0x09
 348 #define I2O_PARAMS_STATUS_NO_KEY_FIELD          0x0A
 349 #define I2O_PARAMS_STATUS_NO_SUCH_FIELD         0x0B
 350 #define I2O_PARAMS_STATUS_NON_DYNAMIC_GROUP     0x0C
 351 #define I2O_PARAMS_STATUS_OPERATION_ERROR       0x0D
 352 #define I2O_PARAMS_STATUS_SCALAR_ERROR          0x0E
 353 #define I2O_PARAMS_STATUS_TABLE_ERROR           0x0F
 354 #define I2O_PARAMS_STATUS_WRONG_GROUP_TYPE      0x10
 355
 356 /* DetailedStatusCode defines for Executive, DDM, Util and Transaction error
 357  * messages: Table 3-2 Detailed Status Codes.*/
 358
 359 #define I2O_DSC_SUCCESS                        0x0000
 360 #define I2O_DSC_BAD_KEY                        0x0002
 361 #define I2O_DSC_TCL_ERROR                      0x0003
 362 #define I2O_DSC_REPLY_BUFFER_FULL              0x0004
 363 #define I2O_DSC_NO_SUCH_PAGE                   0x0005
 364 #define I2O_DSC_INSUFFICIENT_RESOURCE_SOFT     0x0006
 365 #define I2O_DSC_INSUFFICIENT_RESOURCE_HARD     0x0007
 366 #define I2O_DSC_CHAIN_BUFFER_TOO_LARGE         0x0009
 367 #define I2O_DSC_UNSUPPORTED_FUNCTION           0x000A
 368 #define I2O_DSC_DEVICE_LOCKED                  0x000B
 369 #define I2O_DSC_DEVICE_RESET                   0x000C
 370 #define I2O_DSC_INAPPROPRIATE_FUNCTION         0x000D
 371 #define I2O_DSC_INVALID_INITIATOR_ADDRESS      0x000E
 372 #define I2O_DSC_INVALID_MESSAGE_FLAGS          0x000F
 373 #define I2O_DSC_INVALID_OFFSET                 0x0010
 374 #define I2O_DSC_INVALID_PARAMETER              0x0011
 375 #define I2O_DSC_INVALID_REQUEST                0x0012
 376 #define I2O_DSC_INVALID_TARGET_ADDRESS         0x0013
 377 #define I2O_DSC_MESSAGE_TOO_LARGE              0x0014
 378 #define I2O_DSC_MESSAGE_TOO_SMALL              0x0015
 379 #define I2O_DSC_MISSING_PARAMETER              0x0016
 380 #define I2O_DSC_TIMEOUT                        0x0017
 381 #define I2O_DSC_UNKNOWN_ERROR                  0x0018
 382 #define I2O_DSC_UNKNOWN_FUNCTION               0x0019
 383 #define I2O_DSC_UNSUPPORTED_VERSION            0x001A
 384 #define I2O_DSC_DEVICE_BUSY                    0x001B
 385 #define I2O_DSC_DEVICE_NOT_AVAILABLE           0x001C
 386
 387 /* Device Claim Types */
 388 #define I2O_CLAIM_PRIMARY                                       0x01000000
 389 #define I2O_CLAIM_MANAGEMENT                                    0x02000000
 390 #define I2O_CLAIM_AUTHORIZED                                    0x03000000
 391 #define I2O_CLAIM_SECONDARY                                     0x04000000
 392
 393 /* Message header defines for VersionOffset */
 394 #define I2OVER15        0x0001
 395 #define I2OVER20        0x0002
 396 /* Default is 1.5, FIXME: Need support for both 1.5 and 2.0 */
 397 #define I2OVERSION      I2OVER15
 398 #define SGL_OFFSET_0    I2OVERSION
 399 #define SGL_OFFSET_4    (0x0040 | I2OVERSION)
 400 #define SGL_OFFSET_5    (0x0050 | I2OVERSION)
 401 #define SGL_OFFSET_6    (0x0060 | I2OVERSION)
 402 #define SGL_OFFSET_7    (0x0070 | I2OVERSION)
 403 #define SGL_OFFSET_8    (0x0080 | I2OVERSION)
 404 #define SGL_OFFSET_9    (0x0090 | I2OVERSION)
 405 #define SGL_OFFSET_10   (0x00A0 | I2OVERSION)
 406 #define SGL_OFFSET_12   (0x00C0 | I2OVERSION)
 407
 408 #define TRL_OFFSET_5    (0x0050 | I2OVERSION)
 409 #define TRL_OFFSET_6    (0x0060 | I2OVERSION)
 410
 411  /* msg header defines for MsgFlags */
 412 #define MSG_STATIC      0x0100
 413 #define MSG_64BIT_CNTXT 0x0200
 414 #define MSG_MULTI_TRANS 0x1000
 415 #define MSG_FAIL        0x2000
 416 #define MSG_LAST        0x4000
 417 #define MSG_REPLY       0x8000
 418
 419  /* minimum size msg */
 420 #define THREE_WORD_MSG_SIZE     0x00030000
 421 #define FOUR_WORD_MSG_SIZE      0x00040000
 422 #define FIVE_WORD_MSG_SIZE      0x00050000
 423 #define SIX_WORD_MSG_SIZE       0x00060000
 424 #define SEVEN_WORD_MSG_SIZE     0x00070000
 425 #define EIGHT_WORD_MSG_SIZE     0x00080000
 426 #define NINE_WORD_MSG_SIZE      0x00090000
 427 #define TEN_WORD_MSG_SIZE       0x000A0000
 428 #define I2O_MESSAGE_SIZE(x)     ((x)<<16)
 429
 430
 431 /* Special TID Assignments */
 432
 433 #define ADAPTER_TID             0
 434 #define HOST_TID                1
 435
 436 #define MSG_FRAME_SIZE          128
 437 #define NMBR_MSG_FRAMES         128
 438
 439 #define MSG_POOL_SIZE           16384
 440
 441 #define I2O_POST_WAIT_OK        0
 442 #define I2O_POST_WAIT_TIMEOUT   -ETIMEDOUT
 443
 444
 445 #endif /* __KERNEL__ */
 446
 447 #endif /* _SCSI_I2O_H */