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