xref: /openbmc/linux/net/smc/smc_clc.h (revision dea54fba)
1 /*
2  *  Shared Memory Communications over RDMA (SMC-R) and RoCE
3  *
4  *  CLC (connection layer control) handshake over initial TCP socket to
5  *  prepare for RDMA traffic
6  *
7  *  Copyright IBM Corp. 2016
8  *
9  *  Author(s):  Ursula Braun <ubraun@linux.vnet.ibm.com>
10  */
11 
12 #ifndef _SMC_CLC_H
13 #define _SMC_CLC_H
14 
15 #include <rdma/ib_verbs.h>
16 
17 #include "smc.h"
18 
19 #define SMC_CLC_PROPOSAL	0x01
20 #define SMC_CLC_ACCEPT		0x02
21 #define SMC_CLC_CONFIRM		0x03
22 #define SMC_CLC_DECLINE		0x04
23 
24 /* eye catcher "SMCR" EBCDIC for CLC messages */
25 static const char SMC_EYECATCHER[4] = {'\xe2', '\xd4', '\xc3', '\xd9'};
26 
27 #define SMC_CLC_V1		0x1		/* SMC version                */
28 #define CLC_WAIT_TIME		(6 * HZ)	/* max. wait time on clcsock  */
29 #define SMC_CLC_DECL_MEM	0x01010000  /* insufficient memory resources  */
30 #define SMC_CLC_DECL_TIMEOUT	0x02000000  /* timeout                        */
31 #define SMC_CLC_DECL_CNFERR	0x03000000  /* configuration error            */
32 #define SMC_CLC_DECL_IPSEC	0x03030000  /* IPsec usage                    */
33 #define SMC_CLC_DECL_SYNCERR	0x04000000  /* synchronization error          */
34 #define SMC_CLC_DECL_REPLY	0x06000000  /* reply to a received decline    */
35 #define SMC_CLC_DECL_INTERR	0x99990000  /* internal error                 */
36 #define SMC_CLC_DECL_TCL	0x02040000  /* timeout w4 QP confirm          */
37 #define SMC_CLC_DECL_SEND	0x07000000  /* sending problem                */
38 
39 struct smc_clc_msg_hdr {	/* header1 of clc messages */
40 	u8 eyecatcher[4];	/* eye catcher */
41 	u8 type;		/* proposal / accept / confirm / decline */
42 	__be16 length;
43 #if defined(__BIG_ENDIAN_BITFIELD)
44 	u8 version : 4,
45 	   flag    : 1,
46 	   rsvd	   : 3;
47 #elif defined(__LITTLE_ENDIAN_BITFIELD)
48 	u8 rsvd    : 3,
49 	   flag    : 1,
50 	   version : 4;
51 #endif
52 } __packed;			/* format defined in RFC7609 */
53 
54 struct smc_clc_msg_trail {	/* trailer of clc messages */
55 	u8 eyecatcher[4];
56 };
57 
58 struct smc_clc_msg_local {	/* header2 of clc messages */
59 	u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */
60 	u8 gid[16];		/* gid of ib_device port */
61 	u8 mac[6];		/* mac of ib_device port */
62 };
63 
64 struct smc_clc_msg_proposal {	/* clc proposal message */
65 	struct smc_clc_msg_hdr hdr;
66 	struct smc_clc_msg_local lcl;
67 	__be16 iparea_offset;	/* offset to IP address information area */
68 	__be32 outgoing_subnet;	/* subnet mask */
69 	u8 prefix_len;		/* number of significant bits in mask */
70 	u8 reserved[2];
71 	u8 ipv6_prefixes_cnt;	/* number of IPv6 prefixes in prefix array */
72 	struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
73 } __aligned(4);
74 
75 struct smc_clc_msg_accept_confirm {	/* clc accept / confirm message */
76 	struct smc_clc_msg_hdr hdr;
77 	struct smc_clc_msg_local lcl;
78 	u8 qpn[3];		/* QP number */
79 	__be32 rmb_rkey;	/* RMB rkey */
80 	u8 conn_idx;		/* Connection index, which RMBE in RMB */
81 	__be32 rmbe_alert_token;/* unique connection id */
82 #if defined(__BIG_ENDIAN_BITFIELD)
83 	u8 rmbe_size : 4,	/* RMBE buf size (compressed notation) */
84 	   qp_mtu   : 4;	/* QP mtu */
85 #elif defined(__LITTLE_ENDIAN_BITFIELD)
86 	u8 qp_mtu   : 4,
87 	   rmbe_size : 4;
88 #endif
89 	u8 reserved;
90 	__be64 rmb_dma_addr;	/* RMB virtual address */
91 	u8 reserved2;
92 	u8 psn[3];		/* initial packet sequence number */
93 	struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
94 } __packed;			/* format defined in RFC7609 */
95 
96 struct smc_clc_msg_decline {	/* clc decline message */
97 	struct smc_clc_msg_hdr hdr;
98 	u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
99 	__be32 peer_diagnosis;	/* diagnosis information */
100 	u8 reserved2[4];
101 	struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
102 } __aligned(4);
103 
104 struct smc_sock;
105 struct smc_ib_device;
106 
107 int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen,
108 		     u8 expected_type);
109 int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info,
110 			 u8 out_of_sync);
111 int smc_clc_send_proposal(struct smc_sock *smc, struct smc_ib_device *smcibdev,
112 			  u8 ibport);
113 int smc_clc_send_confirm(struct smc_sock *smc);
114 int smc_clc_send_accept(struct smc_sock *smc, int srv_first_contact);
115 
116 #endif
117