| #ifndef _SCSI_I2O_H |
| #define _SCSI_I2O_H |
| |
| /* I2O kernel space accessible structures/APIs |
| * |
| * (c) Copyright 1999, 2000 Red Hat Software |
| * |
| * This program is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU General Public License |
| * as published by the Free Software Foundation; either version |
| * 2 of the License, or (at your option) any later version. |
| * |
| ************************************************************************* |
| * |
| * This header file defined the I2O APIs/structures for use by |
| * the I2O kernel modules. |
| * |
| */ |
| |
| #ifdef __KERNEL__ /* This file to be included by kernel only */ |
| |
| #include <linux/i2o-dev.h> |
| |
| #include <linux/notifier.h> |
| #include <linux/atomic.h> |
| |
| |
| /* |
| * Tunable parameters first |
| */ |
| |
| /* How many different OSM's are we allowing */ |
| #define MAX_I2O_MODULES 64 |
| |
| #define I2O_EVT_CAPABILITY_OTHER 0x01 |
| #define I2O_EVT_CAPABILITY_CHANGED 0x02 |
| |
| #define I2O_EVT_SENSOR_STATE_CHANGED 0x01 |
| |
| //#ifdef __KERNEL__ /* ioctl stuff only thing exported to users */ |
| |
| #define I2O_MAX_MANAGERS 4 |
| |
| /* |
| * I2O Interface Objects |
| */ |
| |
| #include <linux/wait.h> |
| typedef wait_queue_head_t adpt_wait_queue_head_t; |
| #define ADPT_DECLARE_WAIT_QUEUE_HEAD(wait) DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wait) |
| typedef wait_queue_entry_t adpt_wait_queue_entry_t; |
| |
| /* |
| * message structures |
| */ |
| |
| struct i2o_message |
| { |
| u8 version_offset; |
| u8 flags; |
| u16 size; |
| u32 target_tid:12; |
| u32 init_tid:12; |
| u32 function:8; |
| u32 initiator_context; |
| /* List follows */ |
| }; |
| |
| struct adpt_device; |
| struct _adpt_hba; |
| struct i2o_device |
| { |
| struct i2o_device *next; /* Chain */ |
| struct i2o_device *prev; |
| |
| char dev_name[8]; /* linux /dev name if available */ |
| i2o_lct_entry lct_data;/* Device LCT information */ |
| u32 flags; |
| struct proc_dir_entry* proc_entry; /* /proc dir */ |
| struct adpt_device *owner; |
| struct _adpt_hba *controller; /* Controlling IOP */ |
| }; |
| |
| /* |
| * Each I2O controller has one of these objects |
| */ |
| |
| struct i2o_controller |
| { |
| char name[16]; |
| int unit; |
| int type; |
| int enabled; |
| |
| struct notifier_block *event_notifer; /* Events */ |
| atomic_t users; |
| struct i2o_device *devices; /* I2O device chain */ |
| struct i2o_controller *next; /* Controller chain */ |
| |
| }; |
| |
| /* |
| * I2O System table entry |
| */ |
| struct i2o_sys_tbl_entry |
| { |
| u16 org_id; |
| u16 reserved1; |
| u32 iop_id:12; |
| u32 reserved2:20; |
| u16 seg_num:12; |
| u16 i2o_version:4; |
| u8 iop_state; |
| u8 msg_type; |
| u16 frame_size; |
| u16 reserved3; |
| u32 last_changed; |
| u32 iop_capabilities; |
| u32 inbound_low; |
| u32 inbound_high; |
| }; |
| |
| struct i2o_sys_tbl |
| { |
| u8 num_entries; |
| u8 version; |
| u16 reserved1; |
| u32 change_ind; |
| u32 reserved2; |
| u32 reserved3; |
| struct i2o_sys_tbl_entry iops[0]; |
| }; |
| |
| /* |
| * I2O classes / subclasses |
| */ |
| |
| /* Class ID and Code Assignments |
| * (LCT.ClassID.Version field) |
| */ |
| #define I2O_CLASS_VERSION_10 0x00 |
| #define I2O_CLASS_VERSION_11 0x01 |
| |
| /* Class code names |
| * (from v1.5 Table 6-1 Class Code Assignments.) |
| */ |
| |
| #define I2O_CLASS_EXECUTIVE 0x000 |
| #define I2O_CLASS_DDM 0x001 |
| #define I2O_CLASS_RANDOM_BLOCK_STORAGE 0x010 |
| #define I2O_CLASS_SEQUENTIAL_STORAGE 0x011 |
| #define I2O_CLASS_LAN 0x020 |
| #define I2O_CLASS_WAN 0x030 |
| #define I2O_CLASS_FIBRE_CHANNEL_PORT 0x040 |
| #define I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL 0x041 |
| #define I2O_CLASS_SCSI_PERIPHERAL 0x051 |
| #define I2O_CLASS_ATE_PORT 0x060 |
| #define I2O_CLASS_ATE_PERIPHERAL 0x061 |
| #define I2O_CLASS_FLOPPY_CONTROLLER 0x070 |
| #define I2O_CLASS_FLOPPY_DEVICE 0x071 |
| #define I2O_CLASS_BUS_ADAPTER_PORT 0x080 |
| #define I2O_CLASS_PEER_TRANSPORT_AGENT 0x090 |
| #define I2O_CLASS_PEER_TRANSPORT 0x091 |
| |
| /* Rest of 0x092 - 0x09f reserved for peer-to-peer classes |
| */ |
| |
| #define I2O_CLASS_MATCH_ANYCLASS 0xffffffff |
| |
| /* Subclasses |
| */ |
| |
| #define I2O_SUBCLASS_i960 0x001 |
| #define I2O_SUBCLASS_HDM 0x020 |
| #define I2O_SUBCLASS_ISM 0x021 |
| |
| /* Operation functions */ |
| |
| #define I2O_PARAMS_FIELD_GET 0x0001 |
| #define I2O_PARAMS_LIST_GET 0x0002 |
| #define I2O_PARAMS_MORE_GET 0x0003 |
| #define I2O_PARAMS_SIZE_GET 0x0004 |
| #define I2O_PARAMS_TABLE_GET 0x0005 |
| #define I2O_PARAMS_FIELD_SET 0x0006 |
| #define I2O_PARAMS_LIST_SET 0x0007 |
| #define I2O_PARAMS_ROW_ADD 0x0008 |
| #define I2O_PARAMS_ROW_DELETE 0x0009 |
| #define I2O_PARAMS_TABLE_CLEAR 0x000A |
| |
| /* |
| * I2O serial number conventions / formats |
| * (circa v1.5) |
| */ |
| |
| #define I2O_SNFORMAT_UNKNOWN 0 |
| #define I2O_SNFORMAT_BINARY 1 |
| #define I2O_SNFORMAT_ASCII 2 |
| #define I2O_SNFORMAT_UNICODE 3 |
| #define I2O_SNFORMAT_LAN48_MAC 4 |
| #define I2O_SNFORMAT_WAN 5 |
| |
| /* Plus new in v2.0 (Yellowstone pdf doc) |
| */ |
| |
| #define I2O_SNFORMAT_LAN64_MAC 6 |
| #define I2O_SNFORMAT_DDM 7 |
| #define I2O_SNFORMAT_IEEE_REG64 8 |
| #define I2O_SNFORMAT_IEEE_REG128 9 |
| #define I2O_SNFORMAT_UNKNOWN2 0xff |
| |
| /* Transaction Reply Lists (TRL) Control Word structure */ |
| |
| #define TRL_SINGLE_FIXED_LENGTH 0x00 |
| #define TRL_SINGLE_VARIABLE_LENGTH 0x40 |
| #define TRL_MULTIPLE_FIXED_LENGTH 0x80 |
| |
| /* |
| * Messaging API values |
| */ |
| |
| #define I2O_CMD_ADAPTER_ASSIGN 0xB3 |
| #define I2O_CMD_ADAPTER_READ 0xB2 |
| #define I2O_CMD_ADAPTER_RELEASE 0xB5 |
| #define I2O_CMD_BIOS_INFO_SET 0xA5 |
| #define I2O_CMD_BOOT_DEVICE_SET 0xA7 |
| #define I2O_CMD_CONFIG_VALIDATE 0xBB |
| #define I2O_CMD_CONN_SETUP 0xCA |
| #define I2O_CMD_DDM_DESTROY 0xB1 |
| #define I2O_CMD_DDM_ENABLE 0xD5 |
| #define I2O_CMD_DDM_QUIESCE 0xC7 |
| #define I2O_CMD_DDM_RESET 0xD9 |
| #define I2O_CMD_DDM_SUSPEND 0xAF |
| #define I2O_CMD_DEVICE_ASSIGN 0xB7 |
| #define I2O_CMD_DEVICE_RELEASE 0xB9 |
| #define I2O_CMD_HRT_GET 0xA8 |
| #define I2O_CMD_ADAPTER_CLEAR 0xBE |
| #define I2O_CMD_ADAPTER_CONNECT 0xC9 |
| #define I2O_CMD_ADAPTER_RESET 0xBD |
| #define I2O_CMD_LCT_NOTIFY 0xA2 |
| #define I2O_CMD_OUTBOUND_INIT 0xA1 |
| #define I2O_CMD_PATH_ENABLE 0xD3 |
| #define I2O_CMD_PATH_QUIESCE 0xC5 |
| #define I2O_CMD_PATH_RESET 0xD7 |
| #define I2O_CMD_STATIC_MF_CREATE 0xDD |
| #define I2O_CMD_STATIC_MF_RELEASE 0xDF |
| #define I2O_CMD_STATUS_GET 0xA0 |
| #define I2O_CMD_SW_DOWNLOAD 0xA9 |
| #define I2O_CMD_SW_UPLOAD 0xAB |
| #define I2O_CMD_SW_REMOVE 0xAD |
| #define I2O_CMD_SYS_ENABLE 0xD1 |
| #define I2O_CMD_SYS_MODIFY 0xC1 |
| #define I2O_CMD_SYS_QUIESCE 0xC3 |
| #define I2O_CMD_SYS_TAB_SET 0xA3 |
| |
| #define I2O_CMD_UTIL_NOP 0x00 |
| #define I2O_CMD_UTIL_ABORT 0x01 |
| #define I2O_CMD_UTIL_CLAIM 0x09 |
| #define I2O_CMD_UTIL_RELEASE 0x0B |
| #define I2O_CMD_UTIL_PARAMS_GET 0x06 |
| #define I2O_CMD_UTIL_PARAMS_SET 0x05 |
| #define I2O_CMD_UTIL_EVT_REGISTER 0x13 |
| #define I2O_CMD_UTIL_EVT_ACK 0x14 |
| #define I2O_CMD_UTIL_CONFIG_DIALOG 0x10 |
| #define I2O_CMD_UTIL_DEVICE_RESERVE 0x0D |
| #define I2O_CMD_UTIL_DEVICE_RELEASE 0x0F |
| #define I2O_CMD_UTIL_LOCK 0x17 |
| #define I2O_CMD_UTIL_LOCK_RELEASE 0x19 |
| #define I2O_CMD_UTIL_REPLY_FAULT_NOTIFY 0x15 |
| |
| #define I2O_CMD_SCSI_EXEC 0x81 |
| #define I2O_CMD_SCSI_ABORT 0x83 |
| #define I2O_CMD_SCSI_BUSRESET 0x27 |
| |
| #define I2O_CMD_BLOCK_READ 0x30 |
| #define I2O_CMD_BLOCK_WRITE 0x31 |
| #define I2O_CMD_BLOCK_CFLUSH 0x37 |
| #define I2O_CMD_BLOCK_MLOCK 0x49 |
| #define I2O_CMD_BLOCK_MUNLOCK 0x4B |
| #define I2O_CMD_BLOCK_MMOUNT 0x41 |
| #define I2O_CMD_BLOCK_MEJECT 0x43 |
| |
| #define I2O_PRIVATE_MSG 0xFF |
| |
| /* |
| * Init Outbound Q status |
| */ |
| |
| #define I2O_CMD_OUTBOUND_INIT_IN_PROGRESS 0x01 |
| #define I2O_CMD_OUTBOUND_INIT_REJECTED 0x02 |
| #define I2O_CMD_OUTBOUND_INIT_FAILED 0x03 |
| #define I2O_CMD_OUTBOUND_INIT_COMPLETE 0x04 |
| |
| /* |
| * I2O Get Status State values |
| */ |
| |
| #define ADAPTER_STATE_INITIALIZING 0x01 |
| #define ADAPTER_STATE_RESET 0x02 |
| #define ADAPTER_STATE_HOLD 0x04 |
| #define ADAPTER_STATE_READY 0x05 |
| #define ADAPTER_STATE_OPERATIONAL 0x08 |
| #define ADAPTER_STATE_FAILED 0x10 |
| #define ADAPTER_STATE_FAULTED 0x11 |
| |
| /* I2O API function return values */ |
| |
| #define I2O_RTN_NO_ERROR 0 |
| #define I2O_RTN_NOT_INIT 1 |
| #define I2O_RTN_FREE_Q_EMPTY 2 |
| #define I2O_RTN_TCB_ERROR 3 |
| #define I2O_RTN_TRANSACTION_ERROR 4 |
| #define I2O_RTN_ADAPTER_ALREADY_INIT 5 |
| #define I2O_RTN_MALLOC_ERROR 6 |
| #define I2O_RTN_ADPTR_NOT_REGISTERED 7 |
| #define I2O_RTN_MSG_REPLY_TIMEOUT 8 |
| #define I2O_RTN_NO_STATUS 9 |
| #define I2O_RTN_NO_FIRM_VER 10 |
| #define I2O_RTN_NO_LINK_SPEED 11 |
| |
| /* Reply message status defines for all messages */ |
| |
| #define I2O_REPLY_STATUS_SUCCESS 0x00 |
| #define I2O_REPLY_STATUS_ABORT_DIRTY 0x01 |
| #define I2O_REPLY_STATUS_ABORT_NO_DATA_TRANSFER 0x02 |
| #define I2O_REPLY_STATUS_ABORT_PARTIAL_TRANSFER 0x03 |
| #define I2O_REPLY_STATUS_ERROR_DIRTY 0x04 |
| #define I2O_REPLY_STATUS_ERROR_NO_DATA_TRANSFER 0x05 |
| #define I2O_REPLY_STATUS_ERROR_PARTIAL_TRANSFER 0x06 |
| #define I2O_REPLY_STATUS_PROCESS_ABORT_DIRTY 0x08 |
| #define I2O_REPLY_STATUS_PROCESS_ABORT_NO_DATA_TRANSFER 0x09 |
| #define I2O_REPLY_STATUS_PROCESS_ABORT_PARTIAL_TRANSFER 0x0A |
| #define I2O_REPLY_STATUS_TRANSACTION_ERROR 0x0B |
| #define I2O_REPLY_STATUS_PROGRESS_REPORT 0x80 |
| |
| /* Status codes and Error Information for Parameter functions */ |
| |
| #define I2O_PARAMS_STATUS_SUCCESS 0x00 |
| #define I2O_PARAMS_STATUS_BAD_KEY_ABORT 0x01 |
| #define I2O_PARAMS_STATUS_BAD_KEY_CONTINUE 0x02 |
| #define I2O_PARAMS_STATUS_BUFFER_FULL 0x03 |
| #define I2O_PARAMS_STATUS_BUFFER_TOO_SMALL 0x04 |
| #define I2O_PARAMS_STATUS_FIELD_UNREADABLE 0x05 |
| #define I2O_PARAMS_STATUS_FIELD_UNWRITEABLE 0x06 |
| #define I2O_PARAMS_STATUS_INSUFFICIENT_FIELDS 0x07 |
| #define I2O_PARAMS_STATUS_INVALID_GROUP_ID 0x08 |
| #define I2O_PARAMS_STATUS_INVALID_OPERATION 0x09 |
| #define I2O_PARAMS_STATUS_NO_KEY_FIELD 0x0A |
| #define I2O_PARAMS_STATUS_NO_SUCH_FIELD 0x0B |
| #define I2O_PARAMS_STATUS_NON_DYNAMIC_GROUP 0x0C |
| #define I2O_PARAMS_STATUS_OPERATION_ERROR 0x0D |
| #define I2O_PARAMS_STATUS_SCALAR_ERROR 0x0E |
| #define I2O_PARAMS_STATUS_TABLE_ERROR 0x0F |
| #define I2O_PARAMS_STATUS_WRONG_GROUP_TYPE 0x10 |
| |
| /* DetailedStatusCode defines for Executive, DDM, Util and Transaction error |
| * messages: Table 3-2 Detailed Status Codes.*/ |
| |
| #define I2O_DSC_SUCCESS 0x0000 |
| #define I2O_DSC_BAD_KEY 0x0002 |
| #define I2O_DSC_TCL_ERROR 0x0003 |
| #define I2O_DSC_REPLY_BUFFER_FULL 0x0004 |
| #define I2O_DSC_NO_SUCH_PAGE 0x0005 |
| #define I2O_DSC_INSUFFICIENT_RESOURCE_SOFT 0x0006 |
| #define I2O_DSC_INSUFFICIENT_RESOURCE_HARD 0x0007 |
| #define I2O_DSC_CHAIN_BUFFER_TOO_LARGE 0x0009 |
| #define I2O_DSC_UNSUPPORTED_FUNCTION 0x000A |
| #define I2O_DSC_DEVICE_LOCKED 0x000B |
| #define I2O_DSC_DEVICE_RESET 0x000C |
| #define I2O_DSC_INAPPROPRIATE_FUNCTION 0x000D |
| #define I2O_DSC_INVALID_INITIATOR_ADDRESS 0x000E |
| #define I2O_DSC_INVALID_MESSAGE_FLAGS 0x000F |
| #define I2O_DSC_INVALID_OFFSET 0x0010 |
| #define I2O_DSC_INVALID_PARAMETER 0x0011 |
| #define I2O_DSC_INVALID_REQUEST 0x0012 |
| #define I2O_DSC_INVALID_TARGET_ADDRESS 0x0013 |
| #define I2O_DSC_MESSAGE_TOO_LARGE 0x0014 |
| #define I2O_DSC_MESSAGE_TOO_SMALL 0x0015 |
| #define I2O_DSC_MISSING_PARAMETER 0x0016 |
| #define I2O_DSC_TIMEOUT 0x0017 |
| #define I2O_DSC_UNKNOWN_ERROR 0x0018 |
| #define I2O_DSC_UNKNOWN_FUNCTION 0x0019 |
| #define I2O_DSC_UNSUPPORTED_VERSION 0x001A |
| #define I2O_DSC_DEVICE_BUSY 0x001B |
| #define I2O_DSC_DEVICE_NOT_AVAILABLE 0x001C |
| |
| /* Device Claim Types */ |
| #define I2O_CLAIM_PRIMARY 0x01000000 |
| #define I2O_CLAIM_MANAGEMENT 0x02000000 |
| #define I2O_CLAIM_AUTHORIZED 0x03000000 |
| #define I2O_CLAIM_SECONDARY 0x04000000 |
| |
| /* Message header defines for VersionOffset */ |
| #define I2OVER15 0x0001 |
| #define I2OVER20 0x0002 |
| /* Default is 1.5, FIXME: Need support for both 1.5 and 2.0 */ |
| #define I2OVERSION I2OVER15 |
| #define SGL_OFFSET_0 I2OVERSION |
| #define SGL_OFFSET_4 (0x0040 | I2OVERSION) |
| #define SGL_OFFSET_5 (0x0050 | I2OVERSION) |
| #define SGL_OFFSET_6 (0x0060 | I2OVERSION) |
| #define SGL_OFFSET_7 (0x0070 | I2OVERSION) |
| #define SGL_OFFSET_8 (0x0080 | I2OVERSION) |
| #define SGL_OFFSET_9 (0x0090 | I2OVERSION) |
| #define SGL_OFFSET_10 (0x00A0 | I2OVERSION) |
| #define SGL_OFFSET_12 (0x00C0 | I2OVERSION) |
| |
| #define TRL_OFFSET_5 (0x0050 | I2OVERSION) |
| #define TRL_OFFSET_6 (0x0060 | I2OVERSION) |
| |
| /* msg header defines for MsgFlags */ |
| #define MSG_STATIC 0x0100 |
| #define MSG_64BIT_CNTXT 0x0200 |
| #define MSG_MULTI_TRANS 0x1000 |
| #define MSG_FAIL 0x2000 |
| #define MSG_LAST 0x4000 |
| #define MSG_REPLY 0x8000 |
| |
| /* minimum size msg */ |
| #define THREE_WORD_MSG_SIZE 0x00030000 |
| #define FOUR_WORD_MSG_SIZE 0x00040000 |
| #define FIVE_WORD_MSG_SIZE 0x00050000 |
| #define SIX_WORD_MSG_SIZE 0x00060000 |
| #define SEVEN_WORD_MSG_SIZE 0x00070000 |
| #define EIGHT_WORD_MSG_SIZE 0x00080000 |
| #define NINE_WORD_MSG_SIZE 0x00090000 |
| #define TEN_WORD_MSG_SIZE 0x000A0000 |
| #define I2O_MESSAGE_SIZE(x) ((x)<<16) |
| |
| |
| /* Special TID Assignments */ |
| |
| #define ADAPTER_TID 0 |
| #define HOST_TID 1 |
| |
| #define MSG_FRAME_SIZE 128 |
| #define NMBR_MSG_FRAMES 128 |
| |
| #define MSG_POOL_SIZE 16384 |
| |
| #define I2O_POST_WAIT_OK 0 |
| #define I2O_POST_WAIT_TIMEOUT -ETIMEDOUT |
| |
| |
| #endif /* __KERNEL__ */ |
| |
| #endif /* _SCSI_I2O_H */ |
