[mirror_ubuntu-bionic-kernel.git] / include / rdma / ib_hdrs.h

/*
 * Copyright(c) 2016 Intel Corporation.
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * BSD LICENSE
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  - Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  - Neither the name of Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef IB_HDRS_H
#define IB_HDRS_H

#include <linux/types.h>
#include <asm/unaligned.h>
#include <rdma/ib_verbs.h>

#define IB_SEQ_NAK	(3 << 29)

/* AETH NAK opcode values */
#define IB_RNR_NAK                      0x20
#define IB_NAK_PSN_ERROR                0x60
#define IB_NAK_INVALID_REQUEST          0x61
#define IB_NAK_REMOTE_ACCESS_ERROR      0x62
#define IB_NAK_REMOTE_OPERATIONAL_ERROR 0x63
#define IB_NAK_INVALID_RD_REQUEST       0x64

#define IB_BTH_REQ_ACK		BIT(31)
#define IB_BTH_SOLICITED	BIT(23)
#define IB_BTH_MIG_REQ		BIT(22)

#define IB_GRH_VERSION		6
#define IB_GRH_VERSION_MASK	0xF
#define IB_GRH_VERSION_SHIFT	28
#define IB_GRH_TCLASS_MASK	0xFF
#define IB_GRH_TCLASS_SHIFT	20
#define IB_GRH_FLOW_MASK	0xFFFFF
#define IB_GRH_FLOW_SHIFT	0
#define IB_GRH_NEXT_HDR		0x1B

#define IB_AETH_CREDIT_SHIFT	24
#define IB_AETH_CREDIT_MASK	0x1F
#define IB_AETH_CREDIT_INVAL	0x1F
#define IB_AETH_NAK_SHIFT	29
#define IB_MSN_MASK		0xFFFFFF

struct ib_reth {
	__be64 vaddr;        /* potentially unaligned */
	__be32 rkey;
	__be32 length;
} __packed;

struct ib_atomic_eth {
	__be64 vaddr;        /* potentially unaligned */
	__be32 rkey;
	__be64 swap_data;    /* potentially unaligned */
	__be64 compare_data; /* potentially unaligned */
} __packed;

union ib_ehdrs {
	struct {
		__be32 deth[2];
		__be32 imm_data;
	} ud;
	struct {
		struct ib_reth reth;
		__be32 imm_data;
	} rc;
	struct {
		__be32 aeth;
		__be64 atomic_ack_eth; /* potentially unaligned */
	} __packed at;
	__be32 imm_data;
	__be32 aeth;
	__be32 ieth;
	struct ib_atomic_eth atomic_eth;
}  __packed;

struct ib_other_headers {
	__be32 bth[3];
	union ib_ehdrs u;
} __packed;

struct ib_header {
	__be16 lrh[4];
	union {
		struct {
			struct ib_grh grh;
			struct ib_other_headers oth;
		} l;
		struct ib_other_headers oth;
	} u;
} __packed;

/* accessors for unaligned __be64 items */

static inline u64 ib_u64_get(__be64 *p)
{
	return get_unaligned_be64(p);
}

static inline void ib_u64_put(u64 val, __be64 *p)
{
	put_unaligned_be64(val, p);
}

static inline u64 get_ib_reth_vaddr(struct ib_reth *reth)
{
	return ib_u64_get(&reth->vaddr);
}

static inline void put_ib_reth_vaddr(u64 val, struct ib_reth *reth)
{
	ib_u64_put(val, &reth->vaddr);
}

static inline u64 get_ib_ateth_vaddr(struct ib_atomic_eth *ateth)
{
	return ib_u64_get(&ateth->vaddr);
}

static inline void put_ib_ateth_vaddr(u64 val, struct ib_atomic_eth *ateth)
{
	ib_u64_put(val, &ateth->vaddr);
}

static inline u64 get_ib_ateth_swap(struct ib_atomic_eth *ateth)
{
	return ib_u64_get(&ateth->swap_data);
}

static inline void put_ib_ateth_swap(u64 val, struct ib_atomic_eth *ateth)
{
	ib_u64_put(val, &ateth->swap_data);
}

static inline u64 get_ib_ateth_compare(struct ib_atomic_eth *ateth)
{
	return ib_u64_get(&ateth->compare_data);
}

static inline void put_ib_ateth_compare(u64 val, struct ib_atomic_eth *ateth)
{
	ib_u64_put(val, &ateth->compare_data);
}

/*
 * 9B/IB Packet Format
 */
#define IB_LNH_MASK		3
#define IB_SC_MASK		0xf
#define IB_SC_SHIFT		12
#define IB_SL_MASK		0xf
#define IB_SL_SHIFT		4

static inline u8 ib_get_lnh(struct ib_header *hdr)
{
	return (be16_to_cpu(hdr->lrh[0]) & IB_LNH_MASK);
}

static inline u8 ib_get_sc(struct ib_header *hdr)
{
	return ((be16_to_cpu(hdr->lrh[0]) >> IB_SC_SHIFT) & IB_SC_MASK);
}

static inline u8 ib_get_sl(struct ib_header *hdr)
{
	return ((be16_to_cpu(hdr->lrh[0]) >> IB_SL_SHIFT) & IB_SL_MASK);
}

static inline u16 ib_get_dlid(struct ib_header *hdr)
{
	return (be16_to_cpu(hdr->lrh[1]));
}

static inline u16 ib_get_slid(struct ib_header *hdr)
{
	return (be16_to_cpu(hdr->lrh[3]));
}

/*
 * BTH
 */
#define IB_BTH_OPCODE_MASK	0xff
#define IB_BTH_OPCODE_SHIFT	24
#define IB_BTH_PAD_MASK	3
#define IB_BTH_PKEY_MASK	0xffff
#define IB_BTH_PAD_SHIFT	20

static inline u8 ib_bth_get_pad(struct ib_other_headers *ohdr)
{
	return ((be32_to_cpu(ohdr->bth[0]) >> IB_BTH_PAD_SHIFT) &
		   IB_BTH_PAD_MASK);
}

static inline u16 ib_bth_get_pkey(struct ib_other_headers *ohdr)
{
	return (be32_to_cpu(ohdr->bth[0]) & IB_BTH_PKEY_MASK);
}

static inline u8 ib_bth_get_opcode(struct ib_other_headers *ohdr)
{
	return ((be32_to_cpu(ohdr->bth[0]) >> IB_BTH_OPCODE_SHIFT) &
		   IB_BTH_OPCODE_MASK);
}

#endif                          /* IB_HDRS_H */
Commit	Line	Data
7368ef02 MM	1	/*
	2	* Copyright(c) 2016 Intel Corporation.
	3	*
	4	* This file is provided under a dual BSD/GPLv2 license. When using or
	5	* redistributing this file, you may do so under either license.
	6	*
	7	* GPL LICENSE SUMMARY
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of version 2 of the GNU General Public License as
	11	* published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* BSD LICENSE
	19	*
	20	* Redistribution and use in source and binary forms, with or without
	21	* modification, are permitted provided that the following conditions
	22	* are met:
	23	*
	24	* - Redistributions of source code must retain the above copyright
	25	* notice, this list of conditions and the following disclaimer.
	26	* - Redistributions in binary form must reproduce the above copyright
	27	* notice, this list of conditions and the following disclaimer in
	28	* the documentation and/or other materials provided with the
	29	* distribution.
	30	* - Neither the name of Intel Corporation nor the names of its
	31	* contributors may be used to endorse or promote products derived
	32	* from this software without specific prior written permission.
	33	*
	34	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	35	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	36	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	37	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	38	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	39	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	40	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	41	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	42	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	43	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	44	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	45	*
	46	*/
	47
	48	#ifndef IB_HDRS_H
	49	#define IB_HDRS_H
	50
	51	#include <linux/types.h>
	52	#include <asm/unaligned.h>
	53	#include <rdma/ib_verbs.h>
	54
	55	#define IB_SEQ_NAK (3 << 29)
	56
	57	/* AETH NAK opcode values */
	58	#define IB_RNR_NAK 0x20
	59	#define IB_NAK_PSN_ERROR 0x60
	60	#define IB_NAK_INVALID_REQUEST 0x61
	61	#define IB_NAK_REMOTE_ACCESS_ERROR 0x62
	62	#define IB_NAK_REMOTE_OPERATIONAL_ERROR 0x63
	63	#define IB_NAK_INVALID_RD_REQUEST 0x64
	64
65	#define IB_BTH_REQ_ACK BIT(31)
66	#define IB_BTH_SOLICITED BIT(23)
67	#define IB_BTH_MIG_REQ BIT(22)
68
69	#define IB_GRH_VERSION 6
70	#define IB_GRH_VERSION_MASK 0xF
71	#define IB_GRH_VERSION_SHIFT 28
72	#define IB_GRH_TCLASS_MASK 0xFF
73	#define IB_GRH_TCLASS_SHIFT 20
74	#define IB_GRH_FLOW_MASK 0xFFFFF
75	#define IB_GRH_FLOW_SHIFT 0
76	#define IB_GRH_NEXT_HDR 0x1B
77
832666c1 DH	78	#define IB_AETH_CREDIT_SHIFT 24
	79	#define IB_AETH_CREDIT_MASK 0x1F
	80	#define IB_AETH_CREDIT_INVAL 0x1F
	81	#define IB_AETH_NAK_SHIFT 29
	82	#define IB_MSN_MASK 0xFFFFFF
	83
7368ef02 MM	84	struct ib_reth {
	85	__be64 vaddr; /* potentially unaligned */
	86	__be32 rkey;
	87	__be32 length;
	88	} __packed;
	89
	90	struct ib_atomic_eth {
	91	__be64 vaddr; /* potentially unaligned */
	92	__be32 rkey;
	93	__be64 swap_data; /* potentially unaligned */
	94	__be64 compare_data; /* potentially unaligned */
	95	} __packed;
	96
	97	union ib_ehdrs {
	98	struct {
	99	__be32 deth[2];
	100	__be32 imm_data;
	101	} ud;
	102	struct {
	103	struct ib_reth reth;
	104	__be32 imm_data;
	105	} rc;
	106	struct {
	107	__be32 aeth;
	108	__be64 atomic_ack_eth; /* potentially unaligned */
	109	} __packed at;
	110	__be32 imm_data;
	111	__be32 aeth;
	112	__be32 ieth;
	113	struct ib_atomic_eth atomic_eth;
	114	} __packed;
	115
	116	struct ib_other_headers {
	117	__be32 bth[3];
	118	union ib_ehdrs u;
	119	} __packed;
	120
	121	struct ib_header {
	122	__be16 lrh[4];
	123	union {
	124	struct {
	125	struct ib_grh grh;
	126	struct ib_other_headers oth;
	127	} l;
	128	struct ib_other_headers oth;
	129	} u;
	130	} __packed;
	131
	132	/* accessors for unaligned __be64 items */
	133
	134	static inline u64 ib_u64_get(__be64 *p)
	135	{
	136	return get_unaligned_be64(p);
	137	}
	138
	139	static inline void ib_u64_put(u64 val, __be64 *p)
	140	{
	141	put_unaligned_be64(val, p);
	142	}
	143
	144	static inline u64 get_ib_reth_vaddr(struct ib_reth *reth)
	145	{
	146	return ib_u64_get(&reth->vaddr);
	147	}
148
149	static inline void put_ib_reth_vaddr(u64 val, struct ib_reth *reth)
150	{
151	ib_u64_put(val, &reth->vaddr);
152	}
153
154	static inline u64 get_ib_ateth_vaddr(struct ib_atomic_eth *ateth)
155	{
156	return ib_u64_get(&ateth->vaddr);
157	}
158
159	static inline void put_ib_ateth_vaddr(u64 val, struct ib_atomic_eth *ateth)
160	{
161	ib_u64_put(val, &ateth->vaddr);
162	}
163
164	static inline u64 get_ib_ateth_swap(struct ib_atomic_eth *ateth)
165	{
166	return ib_u64_get(&ateth->swap_data);
167	}
168
169	static inline void put_ib_ateth_swap(u64 val, struct ib_atomic_eth *ateth)
170	{
171	ib_u64_put(val, &ateth->swap_data);
172	}
173
174	static inline u64 get_ib_ateth_compare(struct ib_atomic_eth *ateth)
175	{
176	return ib_u64_get(&ateth->compare_data);
177	}
178
179	static inline void put_ib_ateth_compare(u64 val, struct ib_atomic_eth *ateth)
180	{
181	ib_u64_put(val, &ateth->compare_data);
182	}
183
cb427057 DH	184	/*
	185	* 9B/IB Packet Format
	186	*/
	187	#define IB_LNH_MASK 3
	188	#define IB_SC_MASK 0xf
	189	#define IB_SC_SHIFT 12
	190	#define IB_SL_MASK 0xf
	191	#define IB_SL_SHIFT 4
	192
	193	static inline u8 ib_get_lnh(struct ib_header *hdr)
	194	{
	195	return (be16_to_cpu(hdr->lrh[0]) & IB_LNH_MASK);
	196	}
	197
	198	static inline u8 ib_get_sc(struct ib_header *hdr)
	199	{
	200	return ((be16_to_cpu(hdr->lrh[0]) >> IB_SC_SHIFT) & IB_SC_MASK);
	201	}
	202
	203	static inline u8 ib_get_sl(struct ib_header *hdr)
	204	{
	205	return ((be16_to_cpu(hdr->lrh[0]) >> IB_SL_SHIFT) & IB_SL_MASK);
	206	}
	207
	208	static inline u16 ib_get_dlid(struct ib_header *hdr)
	209	{
	210	return (be16_to_cpu(hdr->lrh[1]));
	211	}
	212
	213	static inline u16 ib_get_slid(struct ib_header *hdr)
	214	{
	215	return (be16_to_cpu(hdr->lrh[3]));
	216	}
	217
	218	/*
	219	* BTH
	220	*/
	221	#define IB_BTH_OPCODE_MASK 0xff
	222	#define IB_BTH_OPCODE_SHIFT 24
	223	#define IB_BTH_PAD_MASK 3
	224	#define IB_BTH_PKEY_MASK 0xffff
	225	#define IB_BTH_PAD_SHIFT 20
	226
	227	static inline u8 ib_bth_get_pad(struct ib_other_headers *ohdr)
	228	{
	229	return ((be32_to_cpu(ohdr->bth[0]) >> IB_BTH_PAD_SHIFT) &
	230	IB_BTH_PAD_MASK);
	231	}
	232
	233	static inline u16 ib_bth_get_pkey(struct ib_other_headers *ohdr)
	234	{
	235	return (be32_to_cpu(ohdr->bth[0]) & IB_BTH_PKEY_MASK);
	236	}
	237
	238	static inline u8 ib_bth_get_opcode(struct ib_other_headers *ohdr)
	239	{
	240	return ((be32_to_cpu(ohdr->bth[0]) >> IB_BTH_OPCODE_SHIFT) &
	241	IB_BTH_OPCODE_MASK);
	242	}
	243
7368ef02	244	#endif /* IB_HDRS_H */