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