linux/include/rdma/iba.h

/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
/*
 * Copyright (c) 2020, Mellanox Technologies inc.  All rights reserved.
 */
#ifndef _IBA_DEFS_H_
#define _IBA_DEFS_H_

#include <linux/kernel.h>
#include <linux/bitfield.h>
#include <linux/unaligned.h>

static inline u32 _iba_get8(const u8 *ptr)
{ … }

static inline void _iba_set8(u8 *ptr, u32 mask, u32 prep_value)
{ … }

static inline u16 _iba_get16(const __be16 *ptr)
{ … }

static inline void _iba_set16(__be16 *ptr, u16 mask, u16 prep_value)
{ … }

static inline u32 _iba_get32(const __be32 *ptr)
{ … }

static inline void _iba_set32(__be32 *ptr, u32 mask, u32 prep_value)
{ … }

static inline u64 _iba_get64(const __be64 *ptr)
{ … }

static inline void _iba_set64(__be64 *ptr, u64 mask, u64 prep_value)
{ … }

#define _IBA_SET(field_struct, field_offset, field_mask, num_bits, ptr, value) …
#define IBA_SET(field, ptr, value) …

#define _IBA_GET_MEM_PTR(field_struct, field_offset, type, num_bits, ptr) …
#define IBA_GET_MEM_PTR(field, ptr) …

/* FIXME: A set should always set the entire field, meaning we should zero the trailing bytes */
#define _IBA_SET_MEM(field_struct, field_offset, type, num_bits, ptr, in,      \
		     bytes) …
#define IBA_SET_MEM(field, ptr, in, bytes) …

#define _IBA_GET(field_struct, field_offset, field_mask, num_bits, ptr) …
#define IBA_GET(field, ptr) …

#define _IBA_GET_MEM(field_struct, field_offset, type, num_bits, ptr, out,     \
		     bytes) …
#define IBA_GET_MEM(field, ptr, out, bytes) …

/*
 * The generated list becomes the parameters to the macros, the order is:
 *  - struct this applies to
 *  - starting offset of the max
 *  - GENMASK or GENMASK_ULL in CPU order
 *  - The width of data the mask operations should work on, in bits
 */

/*
 * Extraction using a tabular description like table 106. bit_offset is from
 * the Byte[Bit] notation.
 */
#define IBA_FIELD_BLOC(field_struct, byte_offset, bit_offset, num_bits) …
#define IBA_FIELD8_LOC(field_struct, byte_offset, num_bits) …

#define IBA_FIELD16_LOC(field_struct, byte_offset, num_bits) …

#define IBA_FIELD32_LOC(field_struct, byte_offset, num_bits) …

#define IBA_FIELD64_LOC(field_struct, byte_offset) …
/*
 * In IBTA spec, everything that is more than 64bits is multiple
 * of bytes without leftover bits.
 */
#define IBA_FIELD_MLOC(field_struct, byte_offset, num_bits, type) …

#endif /* _IBA_DEFS_H_ */