xref: /freebsd/sys/ofed/include/rdma/ib_hdrs.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3  *
4  * Copyright(c) 2016 Intel Corporation.
5  *
6  * This file is provided under a dual BSD/GPLv2 license.  When using or
7  * redistributing this file, you may do so under either license.
8  *
9  * GPL LICENSE SUMMARY
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of version 2 of the GNU General Public License as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * BSD LICENSE
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  *
26  *  - Redistributions of source code must retain the above copyright
27  *    notice, this list of conditions and the following disclaimer.
28  *  - Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in
30  *    the documentation and/or other materials provided with the
31  *    distribution.
32  *  - Neither the name of Intel Corporation nor the names of its
33  *    contributors may be used to endorse or promote products derived
34  *    from this software without specific prior written permission.
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
37  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
38  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
39  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
40  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
43  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
45  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
46  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  */
48 
49 #ifndef IB_HDRS_H
50 #define IB_HDRS_H
51 
52 #include <linux/types.h>
53 #include <asm/unaligned.h>
54 #include <rdma/ib_verbs.h>
55 
56 #define IB_SEQ_NAK	(3 << 29)
57 
58 /* AETH NAK opcode values */
59 #define IB_RNR_NAK                      0x20
60 #define IB_NAK_PSN_ERROR                0x60
61 #define IB_NAK_INVALID_REQUEST          0x61
62 #define IB_NAK_REMOTE_ACCESS_ERROR      0x62
63 #define IB_NAK_REMOTE_OPERATIONAL_ERROR 0x63
64 #define IB_NAK_INVALID_RD_REQUEST       0x64
65 
66 #define IB_BTH_REQ_ACK		BIT(31)
67 #define IB_BTH_SOLICITED	BIT(23)
68 #define IB_BTH_MIG_REQ		BIT(22)
69 
70 #define IB_GRH_VERSION		6
71 #define IB_GRH_VERSION_MASK	0xF
72 #define IB_GRH_VERSION_SHIFT	28
73 #define IB_GRH_TCLASS_MASK	0xFF
74 #define IB_GRH_TCLASS_SHIFT	20
75 #define IB_GRH_FLOW_MASK	0xFFFFF
76 #define IB_GRH_FLOW_SHIFT	0
77 #define IB_GRH_NEXT_HDR		0x1B
78 
79 struct ib_reth {
80 	__be64 vaddr;        /* potentially unaligned */
81 	__be32 rkey;
82 	__be32 length;
83 } __packed;
84 
85 struct ib_atomic_eth {
86 	__be64 vaddr;        /* potentially unaligned */
87 	__be32 rkey;
88 	__be64 swap_data;    /* potentially unaligned */
89 	__be64 compare_data; /* potentially unaligned */
90 } __packed;
91 
92 union ib_ehdrs {
93 	struct {
94 		__be32 deth[2];
95 		__be32 imm_data;
96 	} ud;
97 	struct {
98 		struct ib_reth reth;
99 		__be32 imm_data;
100 	} rc;
101 	struct {
102 		__be32 aeth;
103 		__be64 atomic_ack_eth; /* potentially unaligned */
104 	} __packed at;
105 	__be32 imm_data;
106 	__be32 aeth;
107 	__be32 ieth;
108 	struct ib_atomic_eth atomic_eth;
109 }  __packed;
110 
111 struct ib_other_headers {
112 	__be32 bth[3];
113 	union ib_ehdrs u;
114 } __packed;
115 
116 struct ib_header {
117 	__be16 lrh[4];
118 	union {
119 		struct {
120 			struct ib_grh grh;
121 			struct ib_other_headers oth;
122 		} l;
123 		struct ib_other_headers oth;
124 	} u;
125 } __packed;
126 
127 /* accessors for unaligned __be64 items */
128 
129 static inline u64 ib_u64_get(__be64 *p)
130 {
131 	return get_unaligned_be64(p);
132 }
133 
134 static inline void ib_u64_put(u64 val, __be64 *p)
135 {
136 	put_unaligned_be64(val, p);
137 }
138 
139 static inline u64 get_ib_reth_vaddr(struct ib_reth *reth)
140 {
141 	return ib_u64_get(&reth->vaddr);
142 }
143 
144 static inline void put_ib_reth_vaddr(u64 val, struct ib_reth *reth)
145 {
146 	ib_u64_put(val, &reth->vaddr);
147 }
148 
149 static inline u64 get_ib_ateth_vaddr(struct ib_atomic_eth *ateth)
150 {
151 	return ib_u64_get(&ateth->vaddr);
152 }
153 
154 static inline void put_ib_ateth_vaddr(u64 val, struct ib_atomic_eth *ateth)
155 {
156 	ib_u64_put(val, &ateth->vaddr);
157 }
158 
159 static inline u64 get_ib_ateth_swap(struct ib_atomic_eth *ateth)
160 {
161 	return ib_u64_get(&ateth->swap_data);
162 }
163 
164 static inline void put_ib_ateth_swap(u64 val, struct ib_atomic_eth *ateth)
165 {
166 	ib_u64_put(val, &ateth->swap_data);
167 }
168 
169 static inline u64 get_ib_ateth_compare(struct ib_atomic_eth *ateth)
170 {
171 	return ib_u64_get(&ateth->compare_data);
172 }
173 
174 static inline void put_ib_ateth_compare(u64 val, struct ib_atomic_eth *ateth)
175 {
176 	ib_u64_put(val, &ateth->compare_data);
177 }
178 
179 #endif                          /* IB_HDRS_H */
180