1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef __LIBSRP_H__
3*4882a593Smuzhiyun #define __LIBSRP_H__
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun #include <linux/list.h>
6*4882a593Smuzhiyun #include <linux/kfifo.h>
7*4882a593Smuzhiyun #include <scsi/srp.h>
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun enum srp_valid {
10*4882a593Smuzhiyun INVALIDATE_CMD_RESP_EL = 0,
11*4882a593Smuzhiyun VALID_CMD_RESP_EL = 0x80,
12*4882a593Smuzhiyun VALID_INIT_MSG = 0xC0,
13*4882a593Smuzhiyun VALID_TRANS_EVENT = 0xFF
14*4882a593Smuzhiyun };
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun enum srp_format {
17*4882a593Smuzhiyun SRP_FORMAT = 1,
18*4882a593Smuzhiyun MAD_FORMAT = 2,
19*4882a593Smuzhiyun OS400_FORMAT = 3,
20*4882a593Smuzhiyun AIX_FORMAT = 4,
21*4882a593Smuzhiyun LINUX_FORMAT = 5,
22*4882a593Smuzhiyun MESSAGE_IN_CRQ = 6
23*4882a593Smuzhiyun };
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun enum srp_init_msg {
26*4882a593Smuzhiyun INIT_MSG = 1,
27*4882a593Smuzhiyun INIT_COMPLETE_MSG = 2
28*4882a593Smuzhiyun };
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun enum srp_trans_event {
31*4882a593Smuzhiyun UNUSED_FORMAT = 0,
32*4882a593Smuzhiyun PARTNER_FAILED = 1,
33*4882a593Smuzhiyun PARTNER_DEREGISTER = 2,
34*4882a593Smuzhiyun MIGRATED = 6,
35*4882a593Smuzhiyun PREPARE_FOR_SUSPEND = 9,
36*4882a593Smuzhiyun RESUME_FROM_SUSP = 0xA
37*4882a593Smuzhiyun };
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun enum srp_status {
40*4882a593Smuzhiyun CRQ_ENTRY_OVERWRITTEN = 0x20,
41*4882a593Smuzhiyun HEADER_DESCRIPTOR = 0xF1,
42*4882a593Smuzhiyun PING = 0xF5,
43*4882a593Smuzhiyun PING_RESPONSE = 0xF6
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun enum srp_mad_version {
47*4882a593Smuzhiyun MAD_VERSION_1 = 1
48*4882a593Smuzhiyun };
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun enum srp_os_type {
51*4882a593Smuzhiyun OS400 = 1,
52*4882a593Smuzhiyun LINUX = 2,
53*4882a593Smuzhiyun AIX = 3,
54*4882a593Smuzhiyun OFW = 4
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun enum srp_task_attributes {
58*4882a593Smuzhiyun SRP_SIMPLE_TASK = 0,
59*4882a593Smuzhiyun SRP_HEAD_TASK = 1,
60*4882a593Smuzhiyun SRP_ORDERED_TASK = 2,
61*4882a593Smuzhiyun SRP_ACA_TASK = 4
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun enum {
65*4882a593Smuzhiyun SRP_TASK_MANAGEMENT_FUNCTION_COMPLETE = 0,
66*4882a593Smuzhiyun SRP_REQUEST_FIELDS_INVALID = 2,
67*4882a593Smuzhiyun SRP_TASK_MANAGEMENT_FUNCTION_NOT_SUPPORTED = 4,
68*4882a593Smuzhiyun SRP_TASK_MANAGEMENT_FUNCTION_FAILED = 5
69*4882a593Smuzhiyun };
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun struct srp_buf {
72*4882a593Smuzhiyun dma_addr_t dma;
73*4882a593Smuzhiyun void *buf;
74*4882a593Smuzhiyun };
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun struct srp_queue {
77*4882a593Smuzhiyun void *pool;
78*4882a593Smuzhiyun void *items;
79*4882a593Smuzhiyun struct kfifo queue;
80*4882a593Smuzhiyun spinlock_t lock;
81*4882a593Smuzhiyun };
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun struct srp_target {
84*4882a593Smuzhiyun struct device *dev;
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun spinlock_t lock;
87*4882a593Smuzhiyun struct list_head cmd_queue;
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun size_t srp_iu_size;
90*4882a593Smuzhiyun struct srp_queue iu_queue;
91*4882a593Smuzhiyun size_t rx_ring_size;
92*4882a593Smuzhiyun struct srp_buf **rx_ring;
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun void *ldata;
95*4882a593Smuzhiyun };
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun struct iu_entry {
98*4882a593Smuzhiyun struct srp_target *target;
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun struct list_head ilist;
101*4882a593Smuzhiyun dma_addr_t remote_token;
102*4882a593Smuzhiyun unsigned long flags;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun struct srp_buf *sbuf;
105*4882a593Smuzhiyun u16 iu_len;
106*4882a593Smuzhiyun };
107*4882a593Smuzhiyun
108*4882a593Smuzhiyun struct ibmvscsis_cmd;
109*4882a593Smuzhiyun
110*4882a593Smuzhiyun typedef int (srp_rdma_t)(struct ibmvscsis_cmd *, struct scatterlist *, int,
111*4882a593Smuzhiyun struct srp_direct_buf *, int,
112*4882a593Smuzhiyun enum dma_data_direction, unsigned int);
113*4882a593Smuzhiyun int srp_target_alloc(struct srp_target *, struct device *, size_t, size_t);
114*4882a593Smuzhiyun void srp_target_free(struct srp_target *);
115*4882a593Smuzhiyun struct iu_entry *srp_iu_get(struct srp_target *);
116*4882a593Smuzhiyun void srp_iu_put(struct iu_entry *);
117*4882a593Smuzhiyun int srp_transfer_data(struct ibmvscsis_cmd *, struct srp_cmd *,
118*4882a593Smuzhiyun srp_rdma_t, int, int);
119*4882a593Smuzhiyun u64 srp_data_length(struct srp_cmd *cmd, enum dma_data_direction dir);
120*4882a593Smuzhiyun int srp_get_desc_table(struct srp_cmd *srp_cmd, enum dma_data_direction *dir,
121*4882a593Smuzhiyun u64 *data_len);
srp_cmd_direction(struct srp_cmd * cmd)122*4882a593Smuzhiyun static inline int srp_cmd_direction(struct srp_cmd *cmd)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun return (cmd->buf_fmt >> 4) ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun #endif
128