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
  41 union srp_iu {
  42         struct srp_login_req login_req;
  43         struct srp_login_rsp login_rsp;
  44         struct srp_login_rej login_rej;
  45         struct srp_i_logout i_logout;
  46         struct srp_t_logout t_logout;
  47         struct srp_tsk_mgmt tsk_mgmt;
  48         struct srp_cmd cmd;
  49         struct srp_rsp rsp;
  50         u8 reserved[SRP_MAX_IU_LEN];
  51 };
  52
  53 enum viosrp_crq_formats {
  54         VIOSRP_SRP_FORMAT = 0x01,
  55         VIOSRP_MAD_FORMAT = 0x02,
  56         VIOSRP_OS400_FORMAT = 0x03,
  57         VIOSRP_AIX_FORMAT = 0x04,
  58         VIOSRP_LINUX_FORMAT = 0x06,
  59         VIOSRP_INLINE_FORMAT = 0x07
  60 };
  61
  62 struct viosrp_crq {
  63         u8 valid;               /* used by RPA */
  64         u8 format;              /* SCSI vs out-of-band */
  65         u8 reserved;
  66         u8 status;              /* non-scsi failure? (e.g. DMA failure) */
  67         u16 timeout;            /* in seconds */
  68         u16 IU_length;          /* in bytes */
  69         u64 IU_data_ptr;        /* the TCE for transferring data */
  70 };
  71
  72 /* MADs are Management requests above and beyond the IUs defined in the SRP
  73  * standard.
  74  */
  75 enum viosrp_mad_types {
  76         VIOSRP_EMPTY_IU_TYPE = 0x01,
  77         VIOSRP_ERROR_LOG_TYPE = 0x02,
  78         VIOSRP_ADAPTER_INFO_TYPE = 0x03,
  79         VIOSRP_HOST_CONFIG_TYPE = 0x04
  80 };
  81
  82 /*
  83  * Common MAD header
  84  */
  85 struct mad_common {
  86         u32 type;
  87         u16 status;
  88         u16 length;
  89         u64 tag;
  90 };
  91
  92 /*
  93  * All SRP (and MAD) requests normally flow from the
  94  * client to the server.  There is no way for the server to send
  95  * an asynchronous message back to the client.  The Empty IU is used
  96  * to hang out a meaningless request to the server so that it can respond
  97  * asynchrouously with something like a SCSI AER
  98  */
  99 struct viosrp_empty_iu {
 100         struct mad_common common;
 101         u64 buffer;
 102         u32 port;
 103 };
 104
 105 struct viosrp_error_log {
 106         struct mad_common common;
 107         u64 buffer;
 108 };
 109
 110 struct viosrp_adapter_info {
 111         struct mad_common common;
 112         u64 buffer;
 113 };
 114
 115 struct viosrp_host_config {
 116         struct mad_common common;
 117         u64 buffer;
 118 };
 119
 120 union mad_iu {
 121         struct viosrp_empty_iu empty_iu;
 122         struct viosrp_error_log error_log;
 123         struct viosrp_adapter_info adapter_info;
 124         struct viosrp_host_config host_config;
 125 };
 126
 127 union viosrp_iu {
 128         union srp_iu srp;
 129         union mad_iu mad;
 130 };
 131
 132 struct mad_adapter_info_data {
 133         char srp_version[8];
 134         char partition_name[96];
 135         u32 partition_number;
 136         u32 mad_version;
 137         u32 os_type;
 138         u32 port_max_txu[8];    /* per-port maximum transfer */
 139 };
 140
 141 #endif