1 /*****************************************************************************/
2 /* srp.h -- SCSI RDMA Protocol definitions */
4 /* Written By: Colin Devilbis, IBM Corporation */
6 /* Copyright (C) 2003 IBM Corporation */
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. */
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. */
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 */
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. */
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 /*****************************************************************************/
38 #define SRP_VERSION "16.a"
39 #define SRP_MAX_IU_LEN 256
40 #define SRP_MAX_LOC_LEN 32
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
;
51 u8 reserved
[SRP_MAX_IU_LEN
];
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
61 enum viosrp_crq_init_formats
{
62 VIOSRP_CRQ_INIT
= 0x01,
63 VIOSRP_CRQ_INIT_COMPLETE
= 0x02
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
75 enum viosrp_crq_status
{
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,
86 u8 valid
; /* used by RPA */
87 u8 format
; /* SCSI vs out-of-band */
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 */
95 /* MADs are Management requests above and beyond the IUs defined in the SRP
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_HOST_CONFIG_TYPE
= 0x04,
103 VIOSRP_CAPABILITIES_TYPE
= 0x05,
104 VIOSRP_ENABLE_FAST_FAIL
= 0x08,
107 enum viosrp_mad_status
{
108 VIOSRP_MAD_SUCCESS
= 0x00,
109 VIOSRP_MAD_NOT_SUPPORTED
= 0xF1,
110 VIOSRP_MAD_FAILED
= 0xF7,
113 enum viosrp_capability_type
{
114 MIGRATION_CAPABILITIES
= 0x01,
115 RESERVATION_CAPABILITIES
= 0x02,
118 enum viosrp_capability_support
{
119 SERVER_DOES_NOT_SUPPORTS_CAP
= 0x0,
120 SERVER_SUPPORTS_CAP
= 0x01,
121 SERVER_CAP_DATA
= 0x02,
124 enum viosrp_reserve_type
{
125 CLIENT_RESERVE_SCSI_2
= 0x01,
128 enum viosrp_capability_flag
{
129 CLIENT_MIGRATED
= 0x01,
130 CLIENT_RECONNECT
= 0x02,
131 CAP_LIST_SUPPORTED
= 0x04,
132 CAP_LIST_DATA
= 0x08,
146 * All SRP (and MAD) requests normally flow from the
147 * client to the server. There is no way for the server to send
148 * an asynchronous message back to the client. The Empty IU is used
149 * to hang out a meaningless request to the server so that it can respond
150 * asynchrouously with something like a SCSI AER
152 struct viosrp_empty_iu
{
153 struct mad_common common
;
158 struct viosrp_error_log
{
159 struct mad_common common
;
163 struct viosrp_adapter_info
{
164 struct mad_common common
;
168 struct viosrp_host_config
{
169 struct mad_common common
;
173 struct viosrp_fast_fail
{
174 struct mad_common common
;
177 struct viosrp_capabilities
{
178 struct mad_common common
;
182 struct mad_capability_common
{
185 __be16 server_support
;
188 struct mad_reserve_cap
{
189 struct mad_capability_common common
;
193 struct mad_migration_cap
{
194 struct mad_capability_common common
;
200 char name
[SRP_MAX_LOC_LEN
];
201 char loc
[SRP_MAX_LOC_LEN
];
202 struct mad_migration_cap migration
;
203 struct mad_reserve_cap reserve
;
207 struct viosrp_empty_iu empty_iu
;
208 struct viosrp_error_log error_log
;
209 struct viosrp_adapter_info adapter_info
;
210 struct viosrp_host_config host_config
;
211 struct viosrp_fast_fail fast_fail
;
212 struct viosrp_capabilities capabilities
;
220 struct mad_adapter_info_data
{
222 char partition_name
[96];
223 __be32 partition_number
;
226 __be32 port_max_txu
[8]; /* per-port maximum transfer */