1aef9ec39SRoland Dreier /* 2aef9ec39SRoland Dreier * Copyright (c) 2005 Cisco Systems. All rights reserved. 3aef9ec39SRoland Dreier * 4aef9ec39SRoland Dreier * This software is available to you under a choice of one of two 5aef9ec39SRoland Dreier * licenses. You may choose to be licensed under the terms of the GNU 6aef9ec39SRoland Dreier * General Public License (GPL) Version 2, available from the file 7aef9ec39SRoland Dreier * COPYING in the main directory of this source tree, or the 8aef9ec39SRoland Dreier * OpenIB.org BSD license below: 9aef9ec39SRoland Dreier * 10aef9ec39SRoland Dreier * Redistribution and use in source and binary forms, with or 11aef9ec39SRoland Dreier * without modification, are permitted provided that the following 12aef9ec39SRoland Dreier * conditions are met: 13aef9ec39SRoland Dreier * 14aef9ec39SRoland Dreier * - Redistributions of source code must retain the above 15aef9ec39SRoland Dreier * copyright notice, this list of conditions and the following 16aef9ec39SRoland Dreier * disclaimer. 17aef9ec39SRoland Dreier * 18aef9ec39SRoland Dreier * - Redistributions in binary form must reproduce the above 19aef9ec39SRoland Dreier * copyright notice, this list of conditions and the following 20aef9ec39SRoland Dreier * disclaimer in the documentation and/or other materials 21aef9ec39SRoland Dreier * provided with the distribution. 22aef9ec39SRoland Dreier * 23aef9ec39SRoland Dreier * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 24aef9ec39SRoland Dreier * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 25aef9ec39SRoland Dreier * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 26aef9ec39SRoland Dreier * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 27aef9ec39SRoland Dreier * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 28aef9ec39SRoland Dreier * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 29aef9ec39SRoland Dreier * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 30aef9ec39SRoland Dreier * SOFTWARE. 31aef9ec39SRoland Dreier * 32aef9ec39SRoland Dreier * $Id$ 33aef9ec39SRoland Dreier */ 34aef9ec39SRoland Dreier 35aef9ec39SRoland Dreier #ifndef SCSI_SRP_H 36aef9ec39SRoland Dreier #define SCSI_SRP_H 37aef9ec39SRoland Dreier 38aef9ec39SRoland Dreier /* 39aef9ec39SRoland Dreier * Structures and constants for the SCSI RDMA Protocol (SRP) as 40aef9ec39SRoland Dreier * defined by the INCITS T10 committee. This file was written using 41aef9ec39SRoland Dreier * draft Revision 16a of the SRP standard. 42aef9ec39SRoland Dreier */ 43aef9ec39SRoland Dreier 44aef9ec39SRoland Dreier #include <linux/types.h> 45985aa495SBart Van Assche #include <scsi/scsi.h> 46aef9ec39SRoland Dreier 47aef9ec39SRoland Dreier enum { 48aef9ec39SRoland Dreier SRP_LOGIN_REQ = 0x00, 49aef9ec39SRoland Dreier SRP_TSK_MGMT = 0x01, 50aef9ec39SRoland Dreier SRP_CMD = 0x02, 51aef9ec39SRoland Dreier SRP_I_LOGOUT = 0x03, 52aef9ec39SRoland Dreier SRP_LOGIN_RSP = 0xc0, 53aef9ec39SRoland Dreier SRP_RSP = 0xc1, 54aef9ec39SRoland Dreier SRP_LOGIN_REJ = 0xc2, 55aef9ec39SRoland Dreier SRP_T_LOGOUT = 0x80, 56aef9ec39SRoland Dreier SRP_CRED_REQ = 0x81, 57aef9ec39SRoland Dreier SRP_AER_REQ = 0x82, 58aef9ec39SRoland Dreier SRP_CRED_RSP = 0x41, 59aef9ec39SRoland Dreier SRP_AER_RSP = 0x42 60aef9ec39SRoland Dreier }; 61aef9ec39SRoland Dreier 62aef9ec39SRoland Dreier enum { 63aef9ec39SRoland Dreier SRP_BUF_FORMAT_DIRECT = 1 << 1, 64aef9ec39SRoland Dreier SRP_BUF_FORMAT_INDIRECT = 1 << 2 65aef9ec39SRoland Dreier }; 66aef9ec39SRoland Dreier 67aef9ec39SRoland Dreier enum { 68aef9ec39SRoland Dreier SRP_NO_DATA_DESC = 0, 69aef9ec39SRoland Dreier SRP_DATA_DESC_DIRECT = 1, 70aef9ec39SRoland Dreier SRP_DATA_DESC_INDIRECT = 2 71aef9ec39SRoland Dreier }; 72aef9ec39SRoland Dreier 73aef9ec39SRoland Dreier enum { 74aef9ec39SRoland Dreier SRP_TSK_ABORT_TASK = 0x01, 75aef9ec39SRoland Dreier SRP_TSK_ABORT_TASK_SET = 0x02, 76aef9ec39SRoland Dreier SRP_TSK_CLEAR_TASK_SET = 0x04, 77aef9ec39SRoland Dreier SRP_TSK_LUN_RESET = 0x08, 78aef9ec39SRoland Dreier SRP_TSK_CLEAR_ACA = 0x40 79aef9ec39SRoland Dreier }; 80aef9ec39SRoland Dreier 81aef9ec39SRoland Dreier enum srp_login_rej_reason { 82aef9ec39SRoland Dreier SRP_LOGIN_REJ_UNABLE_ESTABLISH_CHANNEL = 0x00010000, 83aef9ec39SRoland Dreier SRP_LOGIN_REJ_INSUFFICIENT_RESOURCES = 0x00010001, 84aef9ec39SRoland Dreier SRP_LOGIN_REJ_REQ_IT_IU_LENGTH_TOO_LARGE = 0x00010002, 85aef9ec39SRoland Dreier SRP_LOGIN_REJ_UNABLE_ASSOCIATE_CHANNEL = 0x00010003, 86aef9ec39SRoland Dreier SRP_LOGIN_REJ_UNSUPPORTED_DESCRIPTOR_FMT = 0x00010004, 87aef9ec39SRoland Dreier SRP_LOGIN_REJ_MULTI_CHANNEL_UNSUPPORTED = 0x00010005, 88aef9ec39SRoland Dreier SRP_LOGIN_REJ_CHANNEL_LIMIT_REACHED = 0x00010006 89aef9ec39SRoland Dreier }; 90aef9ec39SRoland Dreier 9173c0996bSRamachandra K enum { 9273c0996bSRamachandra K SRP_REV10_IB_IO_CLASS = 0xff00, 9373c0996bSRamachandra K SRP_REV16A_IB_IO_CLASS = 0x0100 9473c0996bSRamachandra K }; 9573c0996bSRamachandra K 96aef9ec39SRoland Dreier struct srp_direct_buf { 97aef9ec39SRoland Dreier __be64 va; 98aef9ec39SRoland Dreier __be32 key; 99aef9ec39SRoland Dreier __be32 len; 100aef9ec39SRoland Dreier }; 101aef9ec39SRoland Dreier 102aef9ec39SRoland Dreier /* 103aef9ec39SRoland Dreier * We need the packed attribute because the SRP spec puts the list of 104ec448a0aSRoland Dreier * descriptors at an offset of 20, which is not aligned to the size of 105ec448a0aSRoland Dreier * struct srp_direct_buf. The whole structure must be packed to avoid 106ec448a0aSRoland Dreier * having the 20-byte structure padded to 24 bytes on 64-bit architectures. 107aef9ec39SRoland Dreier */ 108aef9ec39SRoland Dreier struct srp_indirect_buf { 109aef9ec39SRoland Dreier struct srp_direct_buf table_desc; 110aef9ec39SRoland Dreier __be32 len; 111ec448a0aSRoland Dreier struct srp_direct_buf desc_list[0]; 112ec448a0aSRoland Dreier } __attribute__((packed)); 113aef9ec39SRoland Dreier 114aef9ec39SRoland Dreier enum { 115aef9ec39SRoland Dreier SRP_MULTICHAN_SINGLE = 0, 116aef9ec39SRoland Dreier SRP_MULTICHAN_MULTI = 1 117aef9ec39SRoland Dreier }; 118aef9ec39SRoland Dreier 119aef9ec39SRoland Dreier struct srp_login_req { 120aef9ec39SRoland Dreier u8 opcode; 121aef9ec39SRoland Dreier u8 reserved1[7]; 122aef9ec39SRoland Dreier u64 tag; 123aef9ec39SRoland Dreier __be32 req_it_iu_len; 124aef9ec39SRoland Dreier u8 reserved2[4]; 125aef9ec39SRoland Dreier __be16 req_buf_fmt; 126aef9ec39SRoland Dreier u8 req_flags; 127aef9ec39SRoland Dreier u8 reserved3[5]; 128aef9ec39SRoland Dreier u8 initiator_port_id[16]; 129aef9ec39SRoland Dreier u8 target_port_id[16]; 130aef9ec39SRoland Dreier }; 131aef9ec39SRoland Dreier 132*19f31343SBart Van Assche /** 133*19f31343SBart Van Assche * struct srp_login_req_rdma - RDMA/CM login parameters. 134*19f31343SBart Van Assche * 135*19f31343SBart Van Assche * RDMA/CM over InfiniBand can only carry 92 - 36 = 56 bytes of private 136*19f31343SBart Van Assche * data. The %srp_login_req_rdma structure contains the same information as 137*19f31343SBart Van Assche * %srp_login_req but with the reserved data removed. 138*19f31343SBart Van Assche */ 139*19f31343SBart Van Assche struct srp_login_req_rdma { 140*19f31343SBart Van Assche u64 tag; 141*19f31343SBart Van Assche __be16 req_buf_fmt; 142*19f31343SBart Van Assche u8 req_flags; 143*19f31343SBart Van Assche u8 opcode; 144*19f31343SBart Van Assche __be32 req_it_iu_len; 145*19f31343SBart Van Assche u8 initiator_port_id[16]; 146*19f31343SBart Van Assche u8 target_port_id[16]; 147*19f31343SBart Van Assche }; 148*19f31343SBart Van Assche 149ec448a0aSRoland Dreier /* 150ec448a0aSRoland Dreier * The SRP spec defines the size of the LOGIN_RSP structure to be 52 151ec448a0aSRoland Dreier * bytes, so it needs to be packed to avoid having it padded to 56 152ec448a0aSRoland Dreier * bytes on 64-bit architectures. 153ec448a0aSRoland Dreier */ 154aef9ec39SRoland Dreier struct srp_login_rsp { 155aef9ec39SRoland Dreier u8 opcode; 156aef9ec39SRoland Dreier u8 reserved1[3]; 157aef9ec39SRoland Dreier __be32 req_lim_delta; 158aef9ec39SRoland Dreier u64 tag; 159aef9ec39SRoland Dreier __be32 max_it_iu_len; 160aef9ec39SRoland Dreier __be32 max_ti_iu_len; 161aef9ec39SRoland Dreier __be16 buf_fmt; 162aef9ec39SRoland Dreier u8 rsp_flags; 163aef9ec39SRoland Dreier u8 reserved2[25]; 164ec448a0aSRoland Dreier } __attribute__((packed)); 165aef9ec39SRoland Dreier 166aef9ec39SRoland Dreier struct srp_login_rej { 167aef9ec39SRoland Dreier u8 opcode; 168aef9ec39SRoland Dreier u8 reserved1[3]; 169aef9ec39SRoland Dreier __be32 reason; 170aef9ec39SRoland Dreier u64 tag; 171aef9ec39SRoland Dreier u8 reserved2[8]; 172aef9ec39SRoland Dreier __be16 buf_fmt; 173aef9ec39SRoland Dreier u8 reserved3[6]; 174aef9ec39SRoland Dreier }; 175aef9ec39SRoland Dreier 176aef9ec39SRoland Dreier struct srp_i_logout { 177aef9ec39SRoland Dreier u8 opcode; 178aef9ec39SRoland Dreier u8 reserved[7]; 179aef9ec39SRoland Dreier u64 tag; 180aef9ec39SRoland Dreier }; 181aef9ec39SRoland Dreier 182aef9ec39SRoland Dreier struct srp_t_logout { 183aef9ec39SRoland Dreier u8 opcode; 184aef9ec39SRoland Dreier u8 sol_not; 185aef9ec39SRoland Dreier u8 reserved[2]; 186aef9ec39SRoland Dreier __be32 reason; 187aef9ec39SRoland Dreier u64 tag; 188aef9ec39SRoland Dreier }; 189aef9ec39SRoland Dreier 190aef9ec39SRoland Dreier /* 191aef9ec39SRoland Dreier * We need the packed attribute because the SRP spec only aligns the 192aef9ec39SRoland Dreier * 8-byte LUN field to 4 bytes. 193aef9ec39SRoland Dreier */ 194aef9ec39SRoland Dreier struct srp_tsk_mgmt { 195aef9ec39SRoland Dreier u8 opcode; 196aef9ec39SRoland Dreier u8 sol_not; 197aef9ec39SRoland Dreier u8 reserved1[6]; 198aef9ec39SRoland Dreier u64 tag; 199aef9ec39SRoland Dreier u8 reserved2[4]; 200985aa495SBart Van Assche struct scsi_lun lun; 201aef9ec39SRoland Dreier u8 reserved3[2]; 202aef9ec39SRoland Dreier u8 tsk_mgmt_func; 203aef9ec39SRoland Dreier u8 reserved4; 204aef9ec39SRoland Dreier u64 task_tag; 205aef9ec39SRoland Dreier u8 reserved5[8]; 206aef9ec39SRoland Dreier }; 207aef9ec39SRoland Dreier 208aef9ec39SRoland Dreier /* 209aef9ec39SRoland Dreier * We need the packed attribute because the SRP spec only aligns the 210aef9ec39SRoland Dreier * 8-byte LUN field to 4 bytes. 211aef9ec39SRoland Dreier */ 212aef9ec39SRoland Dreier struct srp_cmd { 213aef9ec39SRoland Dreier u8 opcode; 214aef9ec39SRoland Dreier u8 sol_not; 215aef9ec39SRoland Dreier u8 reserved1[3]; 216aef9ec39SRoland Dreier u8 buf_fmt; 217aef9ec39SRoland Dreier u8 data_out_desc_cnt; 218aef9ec39SRoland Dreier u8 data_in_desc_cnt; 219aef9ec39SRoland Dreier u64 tag; 220aef9ec39SRoland Dreier u8 reserved2[4]; 221985aa495SBart Van Assche struct scsi_lun lun; 222aef9ec39SRoland Dreier u8 reserved3; 223aef9ec39SRoland Dreier u8 task_attr; 224aef9ec39SRoland Dreier u8 reserved4; 225aef9ec39SRoland Dreier u8 add_cdb_len; 226aef9ec39SRoland Dreier u8 cdb[16]; 227aef9ec39SRoland Dreier u8 add_data[0]; 228aef9ec39SRoland Dreier }; 229aef9ec39SRoland Dreier 230aef9ec39SRoland Dreier enum { 231aef9ec39SRoland Dreier SRP_RSP_FLAG_RSPVALID = 1 << 0, 232aef9ec39SRoland Dreier SRP_RSP_FLAG_SNSVALID = 1 << 1, 233aef9ec39SRoland Dreier SRP_RSP_FLAG_DOOVER = 1 << 2, 234aef9ec39SRoland Dreier SRP_RSP_FLAG_DOUNDER = 1 << 3, 235aef9ec39SRoland Dreier SRP_RSP_FLAG_DIOVER = 1 << 4, 236aef9ec39SRoland Dreier SRP_RSP_FLAG_DIUNDER = 1 << 5 237aef9ec39SRoland Dreier }; 238aef9ec39SRoland Dreier 239ec448a0aSRoland Dreier /* 240ec448a0aSRoland Dreier * The SRP spec defines the size of the RSP structure to be 36 bytes, 241ec448a0aSRoland Dreier * so it needs to be packed to avoid having it padded to 40 bytes on 242ec448a0aSRoland Dreier * 64-bit architectures. 243ec448a0aSRoland Dreier */ 244aef9ec39SRoland Dreier struct srp_rsp { 245aef9ec39SRoland Dreier u8 opcode; 246aef9ec39SRoland Dreier u8 sol_not; 247aef9ec39SRoland Dreier u8 reserved1[2]; 248aef9ec39SRoland Dreier __be32 req_lim_delta; 249aef9ec39SRoland Dreier u64 tag; 250aef9ec39SRoland Dreier u8 reserved2[2]; 251aef9ec39SRoland Dreier u8 flags; 252aef9ec39SRoland Dreier u8 status; 253aef9ec39SRoland Dreier __be32 data_out_res_cnt; 254aef9ec39SRoland Dreier __be32 data_in_res_cnt; 255aef9ec39SRoland Dreier __be32 sense_data_len; 256aef9ec39SRoland Dreier __be32 resp_data_len; 257aef9ec39SRoland Dreier u8 data[0]; 258ec448a0aSRoland Dreier } __attribute__((packed)); 259aef9ec39SRoland Dreier 260bb12588aSDavid Dillow struct srp_cred_req { 261bb12588aSDavid Dillow u8 opcode; 262bb12588aSDavid Dillow u8 sol_not; 263bb12588aSDavid Dillow u8 reserved[2]; 264bb12588aSDavid Dillow __be32 req_lim_delta; 265bb12588aSDavid Dillow u64 tag; 266bb12588aSDavid Dillow }; 267bb12588aSDavid Dillow 268bb12588aSDavid Dillow struct srp_cred_rsp { 269bb12588aSDavid Dillow u8 opcode; 270bb12588aSDavid Dillow u8 reserved[7]; 271bb12588aSDavid Dillow u64 tag; 272bb12588aSDavid Dillow }; 273bb12588aSDavid Dillow 274bb12588aSDavid Dillow /* 275bb12588aSDavid Dillow * The SRP spec defines the fixed portion of the AER_REQ structure to be 276bb12588aSDavid Dillow * 36 bytes, so it needs to be packed to avoid having it padded to 40 bytes 277bb12588aSDavid Dillow * on 64-bit architectures. 278bb12588aSDavid Dillow */ 279bb12588aSDavid Dillow struct srp_aer_req { 280bb12588aSDavid Dillow u8 opcode; 281bb12588aSDavid Dillow u8 sol_not; 282bb12588aSDavid Dillow u8 reserved[2]; 283bb12588aSDavid Dillow __be32 req_lim_delta; 284bb12588aSDavid Dillow u64 tag; 285bb12588aSDavid Dillow u32 reserved2; 286985aa495SBart Van Assche struct scsi_lun lun; 287bb12588aSDavid Dillow __be32 sense_data_len; 288bb12588aSDavid Dillow u32 reserved3; 289bb12588aSDavid Dillow u8 sense_data[0]; 290bb12588aSDavid Dillow } __attribute__((packed)); 291bb12588aSDavid Dillow 292bb12588aSDavid Dillow struct srp_aer_rsp { 293bb12588aSDavid Dillow u8 opcode; 294bb12588aSDavid Dillow u8 reserved[7]; 295bb12588aSDavid Dillow u64 tag; 296bb12588aSDavid Dillow }; 297bb12588aSDavid Dillow 298aef9ec39SRoland Dreier #endif /* SCSI_SRP_H */ 299