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, 7016d14e01SBart Van Assche SRP_DATA_DESC_INDIRECT = 2, 7116d14e01SBart Van Assche SRP_DATA_DESC_IMM = 3, /* new in SRP2 */ 72aef9ec39SRoland Dreier }; 73aef9ec39SRoland Dreier 74aef9ec39SRoland Dreier enum { 75aef9ec39SRoland Dreier SRP_TSK_ABORT_TASK = 0x01, 76aef9ec39SRoland Dreier SRP_TSK_ABORT_TASK_SET = 0x02, 77aef9ec39SRoland Dreier SRP_TSK_CLEAR_TASK_SET = 0x04, 78aef9ec39SRoland Dreier SRP_TSK_LUN_RESET = 0x08, 79aef9ec39SRoland Dreier SRP_TSK_CLEAR_ACA = 0x40 80aef9ec39SRoland Dreier }; 81aef9ec39SRoland Dreier 82aef9ec39SRoland Dreier enum srp_login_rej_reason { 83aef9ec39SRoland Dreier SRP_LOGIN_REJ_UNABLE_ESTABLISH_CHANNEL = 0x00010000, 84aef9ec39SRoland Dreier SRP_LOGIN_REJ_INSUFFICIENT_RESOURCES = 0x00010001, 85aef9ec39SRoland Dreier SRP_LOGIN_REJ_REQ_IT_IU_LENGTH_TOO_LARGE = 0x00010002, 86aef9ec39SRoland Dreier SRP_LOGIN_REJ_UNABLE_ASSOCIATE_CHANNEL = 0x00010003, 87aef9ec39SRoland Dreier SRP_LOGIN_REJ_UNSUPPORTED_DESCRIPTOR_FMT = 0x00010004, 88aef9ec39SRoland Dreier SRP_LOGIN_REJ_MULTI_CHANNEL_UNSUPPORTED = 0x00010005, 89aef9ec39SRoland Dreier SRP_LOGIN_REJ_CHANNEL_LIMIT_REACHED = 0x00010006 90aef9ec39SRoland Dreier }; 91aef9ec39SRoland Dreier 9273c0996bSRamachandra K enum { 9373c0996bSRamachandra K SRP_REV10_IB_IO_CLASS = 0xff00, 9473c0996bSRamachandra K SRP_REV16A_IB_IO_CLASS = 0x0100 9573c0996bSRamachandra K }; 9673c0996bSRamachandra K 97aef9ec39SRoland Dreier struct srp_direct_buf { 98aef9ec39SRoland Dreier __be64 va; 99aef9ec39SRoland Dreier __be32 key; 100aef9ec39SRoland Dreier __be32 len; 101aef9ec39SRoland Dreier }; 102aef9ec39SRoland Dreier 103aef9ec39SRoland Dreier /* 104aef9ec39SRoland Dreier * We need the packed attribute because the SRP spec puts the list of 105ec448a0aSRoland Dreier * descriptors at an offset of 20, which is not aligned to the size of 106ec448a0aSRoland Dreier * struct srp_direct_buf. The whole structure must be packed to avoid 107ec448a0aSRoland Dreier * having the 20-byte structure padded to 24 bytes on 64-bit architectures. 108aef9ec39SRoland Dreier */ 109aef9ec39SRoland Dreier struct srp_indirect_buf { 110*6dc26498SBart Van Assche struct srp_direct_buf table_desc __packed __aligned(4); 111aef9ec39SRoland Dreier __be32 len; 112*6dc26498SBart Van Assche struct srp_direct_buf desc_list[] __packed __aligned(4); 113*6dc26498SBart Van Assche }; 114aef9ec39SRoland Dreier 11516d14e01SBart Van Assche /* Immediate data buffer descriptor as defined in SRP2. */ 11616d14e01SBart Van Assche struct srp_imm_buf { 11716d14e01SBart Van Assche __be32 len; 11816d14e01SBart Van Assche }; 11916d14e01SBart Van Assche 12016d14e01SBart Van Assche /* srp_login_req.flags */ 121aef9ec39SRoland Dreier enum { 122aef9ec39SRoland Dreier SRP_MULTICHAN_SINGLE = 0, 12316d14e01SBart Van Assche SRP_MULTICHAN_MULTI = 1, 12416d14e01SBart Van Assche SRP_IMMED_REQUESTED = 0x80, /* new in SRP2 */ 125aef9ec39SRoland Dreier }; 126aef9ec39SRoland Dreier 127aef9ec39SRoland Dreier struct srp_login_req { 128aef9ec39SRoland Dreier u8 opcode; 129aef9ec39SRoland Dreier u8 reserved1[7]; 130aef9ec39SRoland Dreier u64 tag; 131aef9ec39SRoland Dreier __be32 req_it_iu_len; 132aef9ec39SRoland Dreier u8 reserved2[4]; 133aef9ec39SRoland Dreier __be16 req_buf_fmt; 134aef9ec39SRoland Dreier u8 req_flags; 13516d14e01SBart Van Assche u8 reserved3[1]; 13616d14e01SBart Van Assche __be16 imm_data_offset; /* new in SRP2 */ 13716d14e01SBart Van Assche u8 reserved4[2]; 138aef9ec39SRoland Dreier u8 initiator_port_id[16]; 139aef9ec39SRoland Dreier u8 target_port_id[16]; 140aef9ec39SRoland Dreier }; 141aef9ec39SRoland Dreier 14219f31343SBart Van Assche /** 14319f31343SBart Van Assche * struct srp_login_req_rdma - RDMA/CM login parameters. 14419f31343SBart Van Assche * 14519f31343SBart Van Assche * RDMA/CM over InfiniBand can only carry 92 - 36 = 56 bytes of private 14619f31343SBart Van Assche * data. The %srp_login_req_rdma structure contains the same information as 14719f31343SBart Van Assche * %srp_login_req but with the reserved data removed. 14819f31343SBart Van Assche */ 14919f31343SBart Van Assche struct srp_login_req_rdma { 15019f31343SBart Van Assche u64 tag; 15119f31343SBart Van Assche __be16 req_buf_fmt; 15219f31343SBart Van Assche u8 req_flags; 15319f31343SBart Van Assche u8 opcode; 15419f31343SBart Van Assche __be32 req_it_iu_len; 15519f31343SBart Van Assche u8 initiator_port_id[16]; 15619f31343SBart Van Assche u8 target_port_id[16]; 15716d14e01SBart Van Assche __be16 imm_data_offset; 15816d14e01SBart Van Assche u8 reserved[6]; 15919f31343SBart Van Assche }; 16019f31343SBart Van Assche 161feafa204SBart Van Assche /* srp_login_rsp.rsp_flags */ 162feafa204SBart Van Assche enum { 163feafa204SBart Van Assche SRP_LOGIN_RSP_MULTICHAN_NO_CHAN = 0x0, 164feafa204SBart Van Assche SRP_LOGIN_RSP_MULTICHAN_TERMINATED = 0x1, 165feafa204SBart Van Assche SRP_LOGIN_RSP_MULTICHAN_MAINTAINED = 0x2, 16616d14e01SBart Van Assche SRP_LOGIN_RSP_IMMED_SUPP = 0x80, /* new in SRP2 */ 167feafa204SBart Van Assche }; 168feafa204SBart Van Assche 169ec448a0aSRoland Dreier /* 170ec448a0aSRoland Dreier * The SRP spec defines the size of the LOGIN_RSP structure to be 52 171ec448a0aSRoland Dreier * bytes, so it needs to be packed to avoid having it padded to 56 172ec448a0aSRoland Dreier * bytes on 64-bit architectures. 173ec448a0aSRoland Dreier */ 174aef9ec39SRoland Dreier struct srp_login_rsp { 175aef9ec39SRoland Dreier u8 opcode; 176aef9ec39SRoland Dreier u8 reserved1[3]; 177aef9ec39SRoland Dreier __be32 req_lim_delta; 178*6dc26498SBart Van Assche u64 tag __packed __aligned(4); 179aef9ec39SRoland Dreier __be32 max_it_iu_len; 180aef9ec39SRoland Dreier __be32 max_ti_iu_len; 181aef9ec39SRoland Dreier __be16 buf_fmt; 182aef9ec39SRoland Dreier u8 rsp_flags; 183aef9ec39SRoland Dreier u8 reserved2[25]; 184*6dc26498SBart Van Assche }; 185aef9ec39SRoland Dreier 186aef9ec39SRoland Dreier struct srp_login_rej { 187aef9ec39SRoland Dreier u8 opcode; 188aef9ec39SRoland Dreier u8 reserved1[3]; 189aef9ec39SRoland Dreier __be32 reason; 190aef9ec39SRoland Dreier u64 tag; 191aef9ec39SRoland Dreier u8 reserved2[8]; 192aef9ec39SRoland Dreier __be16 buf_fmt; 193aef9ec39SRoland Dreier u8 reserved3[6]; 194aef9ec39SRoland Dreier }; 195aef9ec39SRoland Dreier 196aef9ec39SRoland Dreier struct srp_i_logout { 197aef9ec39SRoland Dreier u8 opcode; 198aef9ec39SRoland Dreier u8 reserved[7]; 199aef9ec39SRoland Dreier u64 tag; 200aef9ec39SRoland Dreier }; 201aef9ec39SRoland Dreier 202aef9ec39SRoland Dreier struct srp_t_logout { 203aef9ec39SRoland Dreier u8 opcode; 204aef9ec39SRoland Dreier u8 sol_not; 205aef9ec39SRoland Dreier u8 reserved[2]; 206aef9ec39SRoland Dreier __be32 reason; 207aef9ec39SRoland Dreier u64 tag; 208aef9ec39SRoland Dreier }; 209aef9ec39SRoland Dreier 210aef9ec39SRoland Dreier struct srp_tsk_mgmt { 211aef9ec39SRoland Dreier u8 opcode; 212aef9ec39SRoland Dreier u8 sol_not; 213aef9ec39SRoland Dreier u8 reserved1[6]; 214aef9ec39SRoland Dreier u64 tag; 215aef9ec39SRoland Dreier u8 reserved2[4]; 216985aa495SBart Van Assche struct scsi_lun lun; 217aef9ec39SRoland Dreier u8 reserved3[2]; 218aef9ec39SRoland Dreier u8 tsk_mgmt_func; 219aef9ec39SRoland Dreier u8 reserved4; 220aef9ec39SRoland Dreier u64 task_tag; 221aef9ec39SRoland Dreier u8 reserved5[8]; 222aef9ec39SRoland Dreier }; 223aef9ec39SRoland Dreier 224aef9ec39SRoland Dreier struct srp_cmd { 225aef9ec39SRoland Dreier u8 opcode; 226aef9ec39SRoland Dreier u8 sol_not; 227aef9ec39SRoland Dreier u8 reserved1[3]; 228aef9ec39SRoland Dreier u8 buf_fmt; 229aef9ec39SRoland Dreier u8 data_out_desc_cnt; 230aef9ec39SRoland Dreier u8 data_in_desc_cnt; 231aef9ec39SRoland Dreier u64 tag; 232aef9ec39SRoland Dreier u8 reserved2[4]; 233985aa495SBart Van Assche struct scsi_lun lun; 234aef9ec39SRoland Dreier u8 reserved3; 235aef9ec39SRoland Dreier u8 task_attr; 236aef9ec39SRoland Dreier u8 reserved4; 237aef9ec39SRoland Dreier u8 add_cdb_len; 238aef9ec39SRoland Dreier u8 cdb[16]; 2395febf6d6SGustavo A. R. Silva u8 add_data[]; 240aef9ec39SRoland Dreier }; 241aef9ec39SRoland Dreier 242aef9ec39SRoland Dreier enum { 243aef9ec39SRoland Dreier SRP_RSP_FLAG_RSPVALID = 1 << 0, 244aef9ec39SRoland Dreier SRP_RSP_FLAG_SNSVALID = 1 << 1, 245aef9ec39SRoland Dreier SRP_RSP_FLAG_DOOVER = 1 << 2, 246aef9ec39SRoland Dreier SRP_RSP_FLAG_DOUNDER = 1 << 3, 247aef9ec39SRoland Dreier SRP_RSP_FLAG_DIOVER = 1 << 4, 248aef9ec39SRoland Dreier SRP_RSP_FLAG_DIUNDER = 1 << 5 249aef9ec39SRoland Dreier }; 250aef9ec39SRoland Dreier 251ec448a0aSRoland Dreier /* 252ec448a0aSRoland Dreier * The SRP spec defines the size of the RSP structure to be 36 bytes, 253ec448a0aSRoland Dreier * so it needs to be packed to avoid having it padded to 40 bytes on 254ec448a0aSRoland Dreier * 64-bit architectures. 255ec448a0aSRoland Dreier */ 256aef9ec39SRoland Dreier struct srp_rsp { 257aef9ec39SRoland Dreier u8 opcode; 258aef9ec39SRoland Dreier u8 sol_not; 259aef9ec39SRoland Dreier u8 reserved1[2]; 260aef9ec39SRoland Dreier __be32 req_lim_delta; 261*6dc26498SBart Van Assche u64 tag __packed __aligned(4); 262aef9ec39SRoland Dreier u8 reserved2[2]; 263aef9ec39SRoland Dreier u8 flags; 264aef9ec39SRoland Dreier u8 status; 265aef9ec39SRoland Dreier __be32 data_out_res_cnt; 266aef9ec39SRoland Dreier __be32 data_in_res_cnt; 267aef9ec39SRoland Dreier __be32 sense_data_len; 268aef9ec39SRoland Dreier __be32 resp_data_len; 2695febf6d6SGustavo A. R. Silva u8 data[]; 270*6dc26498SBart Van Assche }; 271aef9ec39SRoland Dreier 272bb12588aSDavid Dillow struct srp_cred_req { 273bb12588aSDavid Dillow u8 opcode; 274bb12588aSDavid Dillow u8 sol_not; 275bb12588aSDavid Dillow u8 reserved[2]; 276bb12588aSDavid Dillow __be32 req_lim_delta; 277bb12588aSDavid Dillow u64 tag; 278bb12588aSDavid Dillow }; 279bb12588aSDavid Dillow 280bb12588aSDavid Dillow struct srp_cred_rsp { 281bb12588aSDavid Dillow u8 opcode; 282bb12588aSDavid Dillow u8 reserved[7]; 283bb12588aSDavid Dillow u64 tag; 284bb12588aSDavid Dillow }; 285bb12588aSDavid Dillow 286bb12588aSDavid Dillow /* 287bb12588aSDavid Dillow * The SRP spec defines the fixed portion of the AER_REQ structure to be 288bb12588aSDavid Dillow * 36 bytes, so it needs to be packed to avoid having it padded to 40 bytes 289bb12588aSDavid Dillow * on 64-bit architectures. 290bb12588aSDavid Dillow */ 291bb12588aSDavid Dillow struct srp_aer_req { 292bb12588aSDavid Dillow u8 opcode; 293bb12588aSDavid Dillow u8 sol_not; 294bb12588aSDavid Dillow u8 reserved[2]; 295bb12588aSDavid Dillow __be32 req_lim_delta; 296*6dc26498SBart Van Assche u64 tag __packed __aligned(4); 297bb12588aSDavid Dillow u32 reserved2; 298985aa495SBart Van Assche struct scsi_lun lun; 299bb12588aSDavid Dillow __be32 sense_data_len; 300bb12588aSDavid Dillow u32 reserved3; 3015febf6d6SGustavo A. R. Silva u8 sense_data[]; 302*6dc26498SBart Van Assche }; 303bb12588aSDavid Dillow 304bb12588aSDavid Dillow struct srp_aer_rsp { 305bb12588aSDavid Dillow u8 opcode; 306bb12588aSDavid Dillow u8 reserved[7]; 307bb12588aSDavid Dillow u64 tag; 308bb12588aSDavid Dillow }; 309bb12588aSDavid Dillow 310aef9ec39SRoland Dreier #endif /* SCSI_SRP_H */ 311