drivers/scsi/ibmvscsi/viosrp.h

   1 /*****************************************************************************/
   2 /* srp.h -- SCSI RDMA Protocol definitions                                   */
   3 /*                                                                           */
   4 /* Written By: Colin Devilbis, IBM Corporation                               */
   5 /*                                                                           */
   6 /* Copyright (C) 2003 IBM Corporation                                        */
   7 /*                                                                           */
   8 /* This program is free software; you can redistribute it and/or modify      */
   9 /* it under the terms of the GNU General Public License as published by      */
  10 /* the Free Software Foundation; either version 2 of the License, or         */
  11 /* (at your option) any later version.                                       */
  12 /*                                                                           */
  13 /* This program is distributed in the hope that it will be useful,           */
  14 /* but WITHOUT ANY WARRANTY; without even the implied warranty of            */
  15 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             */
  16 /* GNU General Public License for more details.                              */
  17 /*                                                                           */
  18 /* You should have received a copy of the GNU General Public License         */
  19 /* along with this program; if not, write to the Free Software               */
  20 /* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  21 /*                                                                           */
  22 /*                                                                           */
  23 /* This file contains structures and definitions for IBM RPA (RS/6000        */
  24 /* platform architecture) implementation of the SRP (SCSI RDMA Protocol)     */
  25 /* standard.  SRP is used on IBM iSeries and pSeries platforms to send SCSI  */
  26 /* commands between logical partitions.                                      */
  27 /*                                                                           */
  28 /* SRP Information Units (IUs) are sent on a "Command/Response Queue" (CRQ)  */
  29 /* between partitions.  The definitions in this file are architected,        */
  30 /* and cannot be changed without breaking compatibility with other versions  */
  31 /* of Linux and other operating systems (AIX, OS/400) that talk this protocol*/
  32 /* between logical partitions                                                */
  33 /*****************************************************************************/
  34 #ifndef VIOSRP_H
  35 #define VIOSRP_H
  36 #include <scsi/srp.h>
  37
  38 #define SRP_VERSION "16.a"
  39 #define SRP_MAX_IU_LEN  256
  40 #define SRP_MAX_LOC_LEN 32
  41
  42 union srp_iu {
  43         struct srp_login_req login_req;
  44         struct srp_login_rsp login_rsp;
  45         struct srp_login_rej login_rej;
  46         struct srp_i_logout i_logout;
  47         struct srp_t_logout t_logout;
  48         struct srp_tsk_mgmt tsk_mgmt;
  49         struct srp_cmd cmd;
  50         struct srp_rsp rsp;
  51         u8 reserved[SRP_MAX_IU_LEN];
  52 };
  53
  54 enum viosrp_crq_headers {
  55         VIOSRP_CRQ_FREE = 0x00,
  56         VIOSRP_CRQ_CMD_RSP = 0x80,
  57         VIOSRP_CRQ_INIT_RSP = 0xC0,
  58         VIOSRP_CRQ_XPORT_EVENT = 0xFF
  59 };
  60
  61 enum viosrp_crq_init_formats {
  62         VIOSRP_CRQ_INIT = 0x01,
  63         VIOSRP_CRQ_INIT_COMPLETE = 0x02
  64 };
  65
  66 enum viosrp_crq_formats {
  67         VIOSRP_SRP_FORMAT = 0x01,
  68         VIOSRP_MAD_FORMAT = 0x02,
  69         VIOSRP_OS400_FORMAT = 0x03,
  70         VIOSRP_AIX_FORMAT = 0x04,
  71         VIOSRP_LINUX_FORMAT = 0x05,
  72         VIOSRP_INLINE_FORMAT = 0x06
  73 };
  74
  75 enum viosrp_crq_status {
  76         VIOSRP_OK = 0x0,
  77         VIOSRP_NONRECOVERABLE_ERR = 0x1,
  78         VIOSRP_VIOLATES_MAX_XFER = 0x2,
  79         VIOSRP_PARTNER_PANIC = 0x3,
  80         VIOSRP_DEVICE_BUSY = 0x8,
  81         VIOSRP_ADAPTER_FAIL = 0x10,
  82         VIOSRP_OK2 = 0x99,
  83 };
  84
  85 struct viosrp_crq {
  86         u8 valid;               /* used by RPA */
  87         u8 format;              /* SCSI vs out-of-band */
  88         u8 reserved;
  89         u8 status;              /* non-scsi failure? (e.g. DMA failure) */
  90         __be16 timeout;         /* in seconds */
  91         __be16 IU_length;               /* in bytes */
  92         __be64 IU_data_ptr;     /* the TCE for transferring data */
  93 };
  94
  95 /* MADs are Management requests above and beyond the IUs defined in the SRP
  96  * standard.
  97  */
  98 enum viosrp_mad_types {
  99         VIOSRP_EMPTY_IU_TYPE = 0x01,
 100         VIOSRP_ERROR_LOG_TYPE = 0x02,
 101         VIOSRP_ADAPTER_INFO_TYPE = 0x03,
 102         VIOSRP_CAPABILITIES_TYPE = 0x05,
 103         VIOSRP_ENABLE_FAST_FAIL = 0x08,
 104 };
 105
 106 enum viosrp_mad_status {
 107         VIOSRP_MAD_SUCCESS = 0x00,
 108         VIOSRP_MAD_NOT_SUPPORTED = 0xF1,
 109         VIOSRP_MAD_FAILED = 0xF7,
 110 };
 111
 112 enum viosrp_capability_type {
 113         MIGRATION_CAPABILITIES = 0x01,
 114         RESERVATION_CAPABILITIES = 0x02,
 115 };
 116
 117 enum viosrp_capability_support {
 118         SERVER_DOES_NOT_SUPPORTS_CAP = 0x0,
 119         SERVER_SUPPORTS_CAP = 0x01,
 120         SERVER_CAP_DATA = 0x02,
 121 };
 122
 123 enum viosrp_reserve_type {
 124         CLIENT_RESERVE_SCSI_2 = 0x01,
 125 };
 126
 127 enum viosrp_capability_flag {
 128         CLIENT_MIGRATED = 0x01,
 129         CLIENT_RECONNECT = 0x02,
 130         CAP_LIST_SUPPORTED = 0x04,
 131         CAP_LIST_DATA = 0x08,
 132 };
 133
 134 /*
 135  * Common MAD header
 136  */
 137 struct mad_common {
 138         __be32 type;
 139         __be16 status;
 140         __be16 length;
 141         __be64 tag;
 142 };
 143
 144 /*
 145  * All SRP (and MAD) requests normally flow from the
 146  * client to the server.  There is no way for the server to send
 147  * an asynchronous message back to the client.  The Empty IU is used
 148  * to hang out a meaningless request to the server so that it can respond
 149  * asynchrouously with something like a SCSI AER
 150  */
 151 struct viosrp_empty_iu {
 152         struct mad_common common;
 153         __be64 buffer;
 154         __be32 port;
 155 };
 156
 157 struct viosrp_error_log {
 158         struct mad_common common;
 159         __be64 buffer;
 160 };
 161
 162 struct viosrp_adapter_info {
 163         struct mad_common common;
 164         __be64 buffer;
 165 };
 166
 167 struct viosrp_fast_fail {
 168         struct mad_common common;
 169 };
 170
 171 struct viosrp_capabilities {
 172         struct mad_common common;
 173         __be64 buffer;
 174 };
 175
 176 struct mad_capability_common {
 177         __be32 cap_type;
 178         __be16 length;
 179         __be16 server_support;
 180 };
 181
 182 struct mad_reserve_cap {
 183         struct mad_capability_common common;
 184         __be32 type;
 185 };
 186
 187 struct mad_migration_cap {
 188         struct mad_capability_common common;
 189         __be32 ecl;
 190 };
 191
 192 struct capabilities{
 193         __be32 flags;
 194         char name[SRP_MAX_LOC_LEN];
 195         char loc[SRP_MAX_LOC_LEN];
 196         struct mad_migration_cap migration;
 197         struct mad_reserve_cap reserve;
 198 };
 199
 200 union mad_iu {
 201         struct viosrp_empty_iu empty_iu;
 202         struct viosrp_error_log error_log;
 203         struct viosrp_adapter_info adapter_info;
 204         struct viosrp_fast_fail fast_fail;
 205         struct viosrp_capabilities capabilities;
 206 };
 207
 208 union viosrp_iu {
 209         union srp_iu srp;
 210         union mad_iu mad;
 211 };
 212
 213 struct mad_adapter_info_data {
 214         char srp_version[8];
 215         char partition_name[96];
 216         __be32 partition_number;
 217 #define SRP_MAD_VERSION_1 1
 218         __be32 mad_version;
 219 #define SRP_MAD_OS_LINUX 2
 220 #define SRP_MAD_OS_AIX 3
 221         __be32 os_type;
 222         __be32 port_max_txu[8]; /* per-port maximum transfer */
 223 };
 224
 225 #endif