Orange Pi5 kernel

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