1*eb96b740SNipun Gupta /* SPDX-License-Identifier: GPL-2.0 2*eb96b740SNipun Gupta * 3*eb96b740SNipun Gupta * Copyright 2005-2006 Fen Systems Ltd. 4*eb96b740SNipun Gupta * Copyright 2006-2013 Solarflare Communications Inc. 5*eb96b740SNipun Gupta * Copyright (C) 2022-2023, Advanced Micro Devices, Inc. 6*eb96b740SNipun Gupta */ 7*eb96b740SNipun Gupta 8*eb96b740SNipun Gupta #ifndef CDX_BITFIELD_H 9*eb96b740SNipun Gupta #define CDX_BITFIELD_H 10*eb96b740SNipun Gupta 11*eb96b740SNipun Gupta #include <linux/bitfield.h> 12*eb96b740SNipun Gupta 13*eb96b740SNipun Gupta /* Lowest bit numbers and widths */ 14*eb96b740SNipun Gupta #define CDX_DWORD_LBN 0 15*eb96b740SNipun Gupta #define CDX_DWORD_WIDTH 32 16*eb96b740SNipun Gupta 17*eb96b740SNipun Gupta /* Specified attribute (e.g. LBN) of the specified field */ 18*eb96b740SNipun Gupta #define CDX_VAL(field, attribute) field ## _ ## attribute 19*eb96b740SNipun Gupta /* Low bit number of the specified field */ 20*eb96b740SNipun Gupta #define CDX_LOW_BIT(field) CDX_VAL(field, LBN) 21*eb96b740SNipun Gupta /* Bit width of the specified field */ 22*eb96b740SNipun Gupta #define CDX_WIDTH(field) CDX_VAL(field, WIDTH) 23*eb96b740SNipun Gupta /* High bit number of the specified field */ 24*eb96b740SNipun Gupta #define CDX_HIGH_BIT(field) (CDX_LOW_BIT(field) + CDX_WIDTH(field) - 1) 25*eb96b740SNipun Gupta 26*eb96b740SNipun Gupta /* A doubleword (i.e. 4 byte) datatype - little-endian in HW */ 27*eb96b740SNipun Gupta struct cdx_dword { 28*eb96b740SNipun Gupta __le32 cdx_u32; 29*eb96b740SNipun Gupta }; 30*eb96b740SNipun Gupta 31*eb96b740SNipun Gupta /* Value expanders for printk */ 32*eb96b740SNipun Gupta #define CDX_DWORD_VAL(dword) \ 33*eb96b740SNipun Gupta ((unsigned int)le32_to_cpu((dword).cdx_u32)) 34*eb96b740SNipun Gupta 35*eb96b740SNipun Gupta /* 36*eb96b740SNipun Gupta * Extract bit field portion [low,high) from the 32-bit little-endian 37*eb96b740SNipun Gupta * element which contains bits [min,max) 38*eb96b740SNipun Gupta */ 39*eb96b740SNipun Gupta #define CDX_DWORD_FIELD(dword, field) \ 40*eb96b740SNipun Gupta (FIELD_GET(GENMASK(CDX_HIGH_BIT(field), CDX_LOW_BIT(field)), \ 41*eb96b740SNipun Gupta le32_to_cpu((dword).cdx_u32))) 42*eb96b740SNipun Gupta 43*eb96b740SNipun Gupta /* 44*eb96b740SNipun Gupta * Creates the portion of the named bit field that lies within the 45*eb96b740SNipun Gupta * range [min,max). 46*eb96b740SNipun Gupta */ 47*eb96b740SNipun Gupta #define CDX_INSERT_FIELD(field, value) \ 48*eb96b740SNipun Gupta (FIELD_PREP(GENMASK(CDX_HIGH_BIT(field), \ 49*eb96b740SNipun Gupta CDX_LOW_BIT(field)), value)) 50*eb96b740SNipun Gupta 51*eb96b740SNipun Gupta /* 52*eb96b740SNipun Gupta * Creates the portion of the named bit fields that lie within the 53*eb96b740SNipun Gupta * range [min,max). 54*eb96b740SNipun Gupta */ 55*eb96b740SNipun Gupta #define CDX_INSERT_FIELDS(field1, value1, \ 56*eb96b740SNipun Gupta field2, value2, \ 57*eb96b740SNipun Gupta field3, value3, \ 58*eb96b740SNipun Gupta field4, value4, \ 59*eb96b740SNipun Gupta field5, value5, \ 60*eb96b740SNipun Gupta field6, value6, \ 61*eb96b740SNipun Gupta field7, value7) \ 62*eb96b740SNipun Gupta (CDX_INSERT_FIELD(field1, (value1)) | \ 63*eb96b740SNipun Gupta CDX_INSERT_FIELD(field2, (value2)) | \ 64*eb96b740SNipun Gupta CDX_INSERT_FIELD(field3, (value3)) | \ 65*eb96b740SNipun Gupta CDX_INSERT_FIELD(field4, (value4)) | \ 66*eb96b740SNipun Gupta CDX_INSERT_FIELD(field5, (value5)) | \ 67*eb96b740SNipun Gupta CDX_INSERT_FIELD(field6, (value6)) | \ 68*eb96b740SNipun Gupta CDX_INSERT_FIELD(field7, (value7))) 69*eb96b740SNipun Gupta 70*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD(dword, ...) \ 71*eb96b740SNipun Gupta (dword).cdx_u32 = cpu_to_le32(CDX_INSERT_FIELDS(__VA_ARGS__)) 72*eb96b740SNipun Gupta 73*eb96b740SNipun Gupta /* Populate a dword field with various numbers of arguments */ 74*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_7 CDX_POPULATE_DWORD 75*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_6(dword, ...) \ 76*eb96b740SNipun Gupta CDX_POPULATE_DWORD_7(dword, CDX_DWORD, 0, __VA_ARGS__) 77*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_5(dword, ...) \ 78*eb96b740SNipun Gupta CDX_POPULATE_DWORD_6(dword, CDX_DWORD, 0, __VA_ARGS__) 79*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_4(dword, ...) \ 80*eb96b740SNipun Gupta CDX_POPULATE_DWORD_5(dword, CDX_DWORD, 0, __VA_ARGS__) 81*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_3(dword, ...) \ 82*eb96b740SNipun Gupta CDX_POPULATE_DWORD_4(dword, CDX_DWORD, 0, __VA_ARGS__) 83*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_2(dword, ...) \ 84*eb96b740SNipun Gupta CDX_POPULATE_DWORD_3(dword, CDX_DWORD, 0, __VA_ARGS__) 85*eb96b740SNipun Gupta #define CDX_POPULATE_DWORD_1(dword, ...) \ 86*eb96b740SNipun Gupta CDX_POPULATE_DWORD_2(dword, CDX_DWORD, 0, __VA_ARGS__) 87*eb96b740SNipun Gupta #define CDX_SET_DWORD(dword) \ 88*eb96b740SNipun Gupta CDX_POPULATE_DWORD_1(dword, CDX_DWORD, 0xffffffff) 89*eb96b740SNipun Gupta 90*eb96b740SNipun Gupta #endif /* CDX_BITFIELD_H */ 91