| 1 |
/* |
| 2 |
* Copyright 2019 Red Hat Inc. |
| 3 |
* |
| 4 |
* Permission is hereby granted, free of charge, to any person obtaining a |
| 5 |
* copy of this software and associated documentation files (the "Software"), |
| 6 |
* to deal in the Software without restriction, including without limitation |
| 7 |
* the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 8 |
* and/or sell copies of the Software, and to permit persons to whom the |
| 9 |
* Software is furnished to do so, subject to the following conditions: |
| 10 |
* |
| 11 |
* The above copyright notice and this permission notice shall be included in |
| 12 |
* all copies or substantial portions of the Software. |
| 13 |
* |
| 14 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 15 |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 16 |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 17 |
* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 18 |
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 19 |
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 20 |
* OTHER DEALINGS IN THE SOFTWARE. |
| 21 |
*/ |
| 22 |
#ifndef __NVHW_DRF_H__ |
| 23 |
#define __NVHW_DRF_H__ |
| 24 |
|
| 25 |
#include <stdint.h> |
| 26 |
|
| 27 |
/* Helpers common to all DRF accessors. */ |
| 28 |
#define DRF_LO(drf) (0 ? drf) |
| 29 |
#define DRF_HI(drf) (1 ? drf) |
| 30 |
#define DRF_BITS(drf) (DRF_HI(drf) - DRF_LO(drf) + 1) |
| 31 |
#define DRF_MASK(drf) (~UINT64_C(0) >> (64 - DRF_BITS(drf))) |
| 32 |
#define DRF_SMASK(drf) (DRF_MASK(drf) << DRF_LO(drf)) |
| 33 |
|
| 34 |
/* Helpers for DRF-MW accessors. */ |
| 35 |
#define DRF_MX_MW(drf) drf |
| 36 |
#define DRF_MX(drf) DRF_MX_##drf |
| 37 |
#define DRF_MW(drf) DRF_MX(drf) |
| 38 |
#define DRF_MW_SPANS(o,drf) (DRF_LW_IDX((o),drf) != DRF_HW_IDX((o),drf)) |
| 39 |
#define DRF_MW_SIZE(o) (sizeof((o)[0]) * 8) |
| 40 |
|
| 41 |
#define DRF_LW_IDX(o,drf) (DRF_LO(DRF_MW(drf)) / DRF_MW_SIZE(o)) |
| 42 |
#define DRF_LW_LO(o,drf) (DRF_LO(DRF_MW(drf)) % DRF_MW_SIZE(o)) |
| 43 |
#define DRF_LW_HI(o,drf) (DRF_MW_SPANS((o),drf) ? (DRF_MW_SIZE(o) - 1) : DRF_HW_HI((o),drf)) |
| 44 |
#define DRF_LW_BITS(o,drf) (DRF_LW_HI((o),drf) - DRF_LW_LO((o),drf) + 1) |
| 45 |
#define DRF_LW_MASK(o,drf) (~UINT64_C(0) >> (64 - DRF_LW_BITS((o),drf))) |
| 46 |
#define DRF_LW_SMASK(o,drf) (DRF_LW_MASK((o),drf) << DRF_LW_LO((o),drf)) |
| 47 |
#define DRF_LW_GET(o,drf) (((o)[DRF_LW_IDX((o),drf)] >> DRF_LW_LO((o),drf)) & DRF_LW_MASK((o),drf)) |
| 48 |
#define DRF_LW_VAL(o,drf,v) (((v) & DRF_LW_MASK((o),drf)) << DRF_LW_LO((o),drf)) |
| 49 |
#define DRF_LW_CLR(o,drf) ((o)[DRF_LW_IDX((o),drf)] & ~DRF_LW_SMASK((o),drf)) |
| 50 |
#define DRF_LW_SET(o,drf,v) (DRF_LW_CLR((o),drf) | DRF_LW_VAL((o),drf,(v))) |
| 51 |
|
| 52 |
#define DRF_HW_IDX(o,drf) (DRF_HI(DRF_MW(drf)) / DRF_MW_SIZE(o)) |
| 53 |
#define DRF_HW_LO(o,drf) 0 |
| 54 |
#define DRF_HW_HI(o,drf) (DRF_HI(DRF_MW(drf)) % DRF_MW_SIZE(o)) |
| 55 |
#define DRF_HW_BITS(o,drf) (DRF_HW_HI((o),drf) - DRF_HW_LO((o),drf) + 1) |
| 56 |
#define DRF_HW_MASK(o,drf) (~UINT64_C(0) >> (64 - DRF_HW_BITS((o),drf))) |
| 57 |
#define DRF_HW_SMASK(o,drf) (DRF_HW_MASK((o),drf) << DRF_HW_LO((o),drf)) |
| 58 |
#define DRF_HW_GET(o,drf) ((o)[DRF_HW_IDX(o,drf)] & DRF_HW_SMASK((o),drf)) |
| 59 |
#define DRF_HW_VAL(o,drf,v) (((long long)(v) >> DRF_LW_BITS((o),drf)) & DRF_HW_SMASK((o),drf)) |
| 60 |
#define DRF_HW_CLR(o,drf) ((o)[DRF_HW_IDX((o),drf)] & ~DRF_HW_SMASK((o),drf)) |
| 61 |
#define DRF_HW_SET(o,drf,v) (DRF_HW_CLR((o),drf) | DRF_HW_VAL((o),drf,(v))) |
| 62 |
|
| 63 |
/* DRF accessors. */ |
| 64 |
#define NVVAL_X(drf,v) (((v) & DRF_MASK(drf)) << DRF_LO(drf)) |
| 65 |
#define NVVAL_N(X,d,r,f, v) NVVAL_X(d##_##r##_##f, (v)) |
| 66 |
#define NVVAL_I(X,d,r,f,i,v) NVVAL_X(d##_##r##_##f(i), (v)) |
| 67 |
#define NVVAL_(X,_1,_2,_3,_4,_5,IMPL,...) IMPL |
| 68 |
#define NVVAL(A...) NVVAL_(X, ##A, NVVAL_I, NVVAL_N)(X, ##A) |
| 69 |
|
| 70 |
#define NVDEF_N(X,d,r,f, v) NVVAL_X(d##_##r##_##f, d##_##r##_##f##_##v) |
| 71 |
#define NVDEF_I(X,d,r,f,i,v) NVVAL_X(d##_##r##_##f(i), d##_##r##_##f##_##v) |
| 72 |
#define NVDEF_(X,_1,_2,_3,_4,_5,IMPL,...) IMPL |
| 73 |
#define NVDEF(A...) NVDEF_(X, ##A, NVDEF_I, NVDEF_N)(X, ##A) |
| 74 |
|
| 75 |
#define NVVAL_GET_X(o,drf) (((o) >> DRF_LO(drf)) & DRF_MASK(drf)) |
| 76 |
#define NVVAL_GET_N(X,o,d,r,f ) NVVAL_GET_X(o, d##_##r##_##f) |
| 77 |
#define NVVAL_GET_I(X,o,d,r,f,i) NVVAL_GET_X(o, d##_##r##_##f(i)) |
| 78 |
#define NVVAL_GET_(X,_1,_2,_3,_4,_5,IMPL,...) IMPL |
| 79 |
#define NVVAL_GET(A...) NVVAL_GET_(X, ##A, NVVAL_GET_I, NVVAL_GET_N)(X, ##A) |
| 80 |
|
| 81 |
#define NVVAL_TEST_X(o,drf,cmp,drfv) (NVVAL_GET_X((o), drf) cmp drfv) |
| 82 |
#define NVVAL_TEST_N(X,o,d,r,f, cmp,v) NVVAL_TEST_X(o, d##_##r##_##f , cmp, (v)) |
| 83 |
#define NVVAL_TEST_I(X,o,d,r,f,i,cmp,v) NVVAL_TEST_X(o, d##_##r##_##f(i), cmp, (v)) |
| 84 |
#define NVVAL_TEST_(X,_1,_2,_3,_4,_5,_6,_7,IMPL,...) IMPL |
| 85 |
#define NVVAL_TEST(A...) NVVAL_TEST_(X, ##A, NVVAL_TEST_I, NVVAL_TEST_N)(X, ##A) |
| 86 |
|
| 87 |
#define NVDEF_TEST_N(X,o,d,r,f, cmp,v) NVVAL_TEST_X(o, d##_##r##_##f , cmp, d##_##r##_##f##_##v) |
| 88 |
#define NVDEF_TEST_I(X,o,d,r,f,i,cmp,v) NVVAL_TEST_X(o, d##_##r##_##f(i), cmp, d##_##r##_##f##_##v) |
| 89 |
#define NVDEF_TEST_(X,_1,_2,_3,_4,_5,_6,_7,IMPL,...) IMPL |
| 90 |
#define NVDEF_TEST(A...) NVDEF_TEST_(X, ##A, NVDEF_TEST_I, NVDEF_TEST_N)(X, ##A) |
| 91 |
|
| 92 |
#define NVVAL_SET_X(o,drf,v) (((o) & ~DRF_SMASK(drf)) | NVVAL_X(drf, (v))) |
| 93 |
#define NVVAL_SET_N(X,o,d,r,f, v) NVVAL_SET_X(o, d##_##r##_##f, (v)) |
| 94 |
#define NVVAL_SET_I(X,o,d,r,f,i,v) NVVAL_SET_X(o, d##_##r##_##f(i), (v)) |
| 95 |
#define NVVAL_SET_(X,_1,_2,_3,_4,_5,_6,IMPL,...) IMPL |
| 96 |
#define NVVAL_SET(A...) NVVAL_SET_(X, ##A, NVVAL_SET_I, NVVAL_SET_N)(X, ##A) |
| 97 |
|
| 98 |
#define NVDEF_SET_N(X,o,d,r,f, v) NVVAL_SET_X(o, d##_##r##_##f, d##_##r##_##f##_##v) |
| 99 |
#define NVDEF_SET_I(X,o,d,r,f,i,v) NVVAL_SET_X(o, d##_##r##_##f(i), d##_##r##_##f##_##v) |
| 100 |
#define NVDEF_SET_(X,_1,_2,_3,_4,_5,_6,IMPL,...) IMPL |
| 101 |
#define NVDEF_SET(A...) NVDEF_SET_(X, ##A, NVDEF_SET_I, NVDEF_SET_N)(X, ##A) |
| 102 |
|
| 103 |
/* DRF-MW accessors. */ |
| 104 |
#define NVVAL_MW_GET_X(o,drf) \ |
| 105 |
((DRF_MW_SPANS((o),drf) ? \ |
| 106 |
(DRF_HW_GET((o),drf) << DRF_LW_BITS((o),drf)) : 0) | DRF_LW_GET((o),drf)) |
| 107 |
#define NVVAL_MW_GET_N(X,o,d,r,f ) NVVAL_MW_GET_X((o), d##_##r##_##f) |
| 108 |
#define NVVAL_MW_GET_I(X,o,d,r,f,i) NVVAL_MW_GET_X((o), d##_##r##_##f(i)) |
| 109 |
#define NVVAL_MW_GET_(X,_1,_2,_3,_4,_5,IMPL,...) IMPL |
| 110 |
#define NVVAL_MW_GET(A...) NVVAL_MW_GET_(X, ##A, NVVAL_MW_GET_I, NVVAL_MW_GET_N)(X, ##A) |
| 111 |
|
| 112 |
#define NVVAL_MW_SET_X(o,drf,v) do { \ |
| 113 |
(o)[DRF_LW_IDX((o),drf)] = DRF_LW_SET((o),drf,(v)); \ |
| 114 |
if (DRF_MW_SPANS((o),drf)) \ |
| 115 |
(o)[DRF_HW_IDX((o),drf)] = DRF_HW_SET((o),drf,(v)); \ |
| 116 |
} while(0) |
| 117 |
#define NVVAL_MW_SET_N(X,o,d,r,f, v) NVVAL_MW_SET_X((o), d##_##r##_##f, (v)) |
| 118 |
#define NVVAL_MW_SET_I(X,o,d,r,f,i,v) NVVAL_MW_SET_X((o), d##_##r##_##f(i), (v)) |
| 119 |
#define NVVAL_MW_SET_(X,_1,_2,_3,_4,_5,_6,IMPL,...) IMPL |
| 120 |
#define NVVAL_MW_SET(A...) NVVAL_MW_SET_(X, ##A, NVVAL_MW_SET_I, NVVAL_MW_SET_N)(X, ##A) |
| 121 |
|
| 122 |
#define NVDEF_MW_SET_N(X,o,d,r,f, v) NVVAL_MW_SET_X(o, d##_##r##_##f, d##_##r##_##f##_##v) |
| 123 |
#define NVDEF_MW_SET_I(X,o,d,r,f,i,v) NVVAL_MW_SET_X(o, d##_##r##_##f(i), d##_##r##_##f##_##v) |
| 124 |
#define NVDEF_MW_SET_(X,_1,_2,_3,_4,_5,_6,IMPL,...) IMPL |
| 125 |
#define NVDEF_MW_SET(A...) NVDEF_MW_SET_(X, ##A, NVDEF_MW_SET_I, NVDEF_MW_SET_N)(X, ##A) |
| 126 |
|
| 127 |
/* Helper for reading an arbitrary object. */ |
| 128 |
#define DRF_RD_X(e,p,o,dr) e((p), (o), dr) |
| 129 |
#define DRF_RD_N(X,e,p,o,d,r ) DRF_RD_X(e, (p), (o), d##_##r) |
| 130 |
#define DRF_RD_I(X,e,p,o,d,r,i) DRF_RD_X(e, (p), (o), d##_##r(i)) |
| 131 |
#define DRF_RD_(X,_1,_2,_3,_4,_5,_6,IMPL,...) IMPL |
| 132 |
#define DRF_RD(A...) DRF_RD_(X, ##A, DRF_RD_I, DRF_RD_N)(X, ##A) |
| 133 |
|
| 134 |
/* Helper for writing an arbitrary object. */ |
| 135 |
#define DRF_WR_X(e,p,o,dr,v) e((p), (o), dr, (v)) |
| 136 |
#define DRF_WR_N(X,e,p,o,d,r, v) DRF_WR_X(e, (p), (o), d##_##r , (v)) |
| 137 |
#define DRF_WR_I(X,e,p,o,d,r,i,v) DRF_WR_X(e, (p), (o), d##_##r(i), (v)) |
| 138 |
#define DRF_WR_(X,_1,_2,_3,_4,_5,_6,_7,IMPL,...) IMPL |
| 139 |
#define DRF_WR(A...) DRF_WR_(X, ##A, DRF_WR_I, DRF_WR_N)(X, ##A) |
| 140 |
|
| 141 |
/* Helper for modifying an arbitrary object. */ |
| 142 |
#define DRF_MR_X(er,ew,ty,p,o,dr,m,v) ({ \ |
| 143 |
ty _t = DRF_RD_X(er, (p), (o), dr); \ |
| 144 |
DRF_WR_X(ew, (p), (o), dr, (_t & ~(m)) | (v)); \ |
| 145 |
_t; \ |
| 146 |
}) |
| 147 |
#define DRF_MR_N(X,er,ew,ty,p,o,d,r ,m,v) DRF_MR_X(er, ew, ty, (p), (o), d##_##r , (m), (v)) |
| 148 |
#define DRF_MR_I(X,er,ew,ty,p,o,d,r,i,m,v) DRF_MR_X(er, ew, ty, (p), (o), d##_##r(i), (m), (v)) |
| 149 |
#define DRF_MR_(X,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,IMPL,...) IMPL |
| 150 |
#define DRF_MR(A...) DRF_MR_(X, ##A, DRF_MR_I, DRF_MR_N)(X, ##A) |
| 151 |
|
| 152 |
/* Helper for extracting a field value from arbitrary object. */ |
| 153 |
#define DRF_RV_X(e,p,o,dr,drf) NVVAL_GET_X(DRF_RD_X(e, (p), (o), dr), drf) |
| 154 |
#define DRF_RV_N(X,e,p,o,d,r, f) DRF_RV_X(e, (p), (o), d##_##r , d##_##r##_##f) |
| 155 |
#define DRF_RV_I(X,e,p,o,d,r,i,f) DRF_RV_X(e, (p), (o), d##_##r(i), d##_##r##_##f) |
| 156 |
#define DRF_RV_(X,_1,_2,_3,_4,_5,_6,_7,IMPL,...) IMPL |
| 157 |
#define DRF_RV(A...) DRF_RV_(X, ##A, DRF_RV_I, DRF_RV_N)(X, ##A) |
| 158 |
|
| 159 |
/* Helper for writing field value to arbitrary object (all other bits cleared). */ |
| 160 |
#define DRF_WV_N(X,e,p,o,d,r, f,v) \ |
| 161 |
DRF_WR_X(e, (p), (o), d##_##r , NVVAL_X(d##_##r##_##f, (v))) |
| 162 |
#define DRF_WV_I(X,e,p,o,d,r,i,f,v) \ |
| 163 |
DRF_WR_X(e, (p), (o), d##_##r(i), NVVAL_X(d##_##r##_##f, (v))) |
| 164 |
#define DRF_WV_(X,_1,_2,_3,_4,_5,_6,_7,_8,IMPL,...) IMPL |
| 165 |
#define DRF_WV(A...) DRF_WV_(X, ##A, DRF_WV_I, DRF_WV_N)(X, ##A) |
| 166 |
|
| 167 |
/* Helper for writing field definition to arbitrary object (all other bits cleared). */ |
| 168 |
#define DRF_WD_N(X,e,p,o,d,r, f,v) \ |
| 169 |
DRF_WR_X(e, (p), (o), d##_##r , NVVAL_X(d##_##r##_##f, d##_##r##_##f##_##v)) |
| 170 |
#define DRF_WD_I(X,e,p,o,d,r,i,f,v) \ |
| 171 |
DRF_WR_X(e, (p), (o), d##_##r(i), NVVAL_X(d##_##r##_##f, d##_##r##_##f##_##v)) |
| 172 |
#define DRF_WD_(X,_1,_2,_3,_4,_5,_6,_7,_8,IMPL,...) IMPL |
| 173 |
#define DRF_WD(A...) DRF_WD_(X, ##A, DRF_WD_I, DRF_WD_N)(X, ##A) |
| 174 |
|
| 175 |
/* Helper for modifying field value in arbitrary object. */ |
| 176 |
#define DRF_MV_N(X,er,ew,ty,p,o,d,r, f,v) \ |
| 177 |
NVVAL_GET_X(DRF_MR_X(er, ew, ty, (p), (o), d##_##r , DRF_SMASK(d##_##r##_##f), \ |
| 178 |
NVVAL_X(d##_##r##_##f, (v))), d##_##r##_##f) |
| 179 |
#define DRF_MV_I(X,er,ew,ty,p,o,d,r,i,f,v) \ |
| 180 |
NVVAL_GET_X(DRF_MR_X(er, ew, ty, (p), (o), d##_##r(i), DRF_SMASK(d##_##r##_##f), \ |
| 181 |
NVVAL_X(d##_##r##_##f, (v))), d##_##r##_##f) |
| 182 |
#define DRF_MV_(X,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,IMPL,...) IMPL |
| 183 |
#define DRF_MV(A...) DRF_MV_(X, ##A, DRF_MV_I, DRF_MV_N)(X, ##A) |
| 184 |
|
| 185 |
/* Helper for modifying field definition in arbitrary object. */ |
| 186 |
#define DRF_MD_N(X,er,ew,ty,p,o,d,r, f,v) \ |
| 187 |
NVVAL_GET_X(DRF_MR_X(er, ew, ty, (p), (o), d##_##r , DRF_SMASK(d##_##r##_##f), \ |
| 188 |
NVVAL_X(d##_##r##_##f, d##_##r##_##f##_##v)), d##_##r##_##f) |
| 189 |
#define DRF_MD_I(X,er,ew,ty,p,o,d,r,i,f,v) \ |
| 190 |
NVVAL_GET_X(DRF_MR_X(er, ew, ty, (p), (o), d##_##r(i), DRF_SMASK(d##_##r##_##f), \ |
| 191 |
NVVAL_X(d##_##r##_##f, d##_##r##_##f##_##v)), d##_##r##_##f) |
| 192 |
#define DRF_MD_(X,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,IMPL,...) IMPL |
| 193 |
#define DRF_MD(A...) DRF_MD_(X, ##A, DRF_MD_I, DRF_MD_N)(X, ##A) |
| 194 |
|
| 195 |
/* Helper for testing against field value in aribtrary object */ |
| 196 |
#define DRF_TV_N(X,e,p,o,d,r, f,cmp,v) \ |
| 197 |
NVVAL_TEST_X(DRF_RD_X(e, (p), (o), d##_##r ), d##_##r##_##f, cmp, (v)) |
| 198 |
#define DRF_TV_I(X,e,p,o,d,r,i,f,cmp,v) \ |
| 199 |
NVVAL_TEST_X(DRF_RD_X(e, (p), (o), d##_##r(i)), d##_##r##_##f, cmp, (v)) |
| 200 |
#define DRF_TV_(X,_1,_2,_3,_4,_5,_6,_7,_8,_9,IMPL,...) IMPL |
| 201 |
#define DRF_TV(A...) DRF_TV_(X, ##A, DRF_TV_I, DRF_TV_N)(X, ##A) |
| 202 |
|
| 203 |
/* Helper for testing against field definition in aribtrary object */ |
| 204 |
#define DRF_TD_N(X,e,p,o,d,r, f,cmp,v) \ |
| 205 |
NVVAL_TEST_X(DRF_RD_X(e, (p), (o), d##_##r ), d##_##r##_##f, cmp, d##_##r##_##f##_##v) |
| 206 |
#define DRF_TD_I(X,e,p,o,d,r,i,f,cmp,v) \ |
| 207 |
NVVAL_TEST_X(DRF_RD_X(e, (p), (o), d##_##r(i)), d##_##r##_##f, cmp, d##_##r##_##f##_##v) |
| 208 |
#define DRF_TD_(X,_1,_2,_3,_4,_5,_6,_7,_8,_9,IMPL,...) IMPL |
| 209 |
#define DRF_TD(A...) DRF_TD_(X, ##A, DRF_TD_I, DRF_TD_N)(X, ##A) |
| 210 |
#endif |