1 /* 2 * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for 5 * any purpose with or without fee is hereby granted, provided that the 6 * above copyright notice and this permission notice appear in all 7 * copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 10 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 11 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 12 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 13 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 14 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 15 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 16 * PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #ifndef HAL_HWIO_H 20 #define HAL_HWIO_H 21 /* 22 =========================================================================== 23 */ 24 /** 25 @file HALhwio.h 26 27 Public interface include file for accessing the HWIO HAL definitions. 28 29 The HALhwio.h file is the public API interface to the HW I/O (HWIO) 30 register access definitions. 31 */ 32 33 /*========================================================================= 34 Include Files 35 ==========================================================================*/ 36 37 38 /* 39 * Common types. 40 */ 41 #include "HALcomdef.h" 42 43 44 45 /* ----------------------------------------------------------------------- 46 ** Macros 47 ** ----------------------------------------------------------------------- */ 48 49 /** 50 @addtogroup macros 51 @{ 52 */ 53 54 /** 55 * Map a base name to the pointer to access the base. 56 * 57 * This macro maps a base name to the pointer to access the base. 58 * This is generally just used internally. 59 * 60 */ 61 #define HWIO_BASE_PTR(base) base##_BASE_PTR 62 63 64 /** 65 * Declare a HWIO base pointer. 66 * 67 * This macro will declare a HWIO base pointer data structure. The pointer 68 * will always be declared as a weak symbol so multiple declarations will 69 * resolve correctly to the same data at link-time. 70 */ 71 #ifdef __ARMCC_VERSION 72 #define DECLARE_HWIO_BASE_PTR(base) __weak uint8 *HWIO_BASE_PTR(base) 73 #else 74 #define DECLARE_HWIO_BASE_PTR(base) uint8 *HWIO_BASE_PTR(base) 75 #endif 76 77 /** 78 @} 79 */ 80 81 82 /** 83 @addtogroup hwio_macros 84 @{ 85 */ 86 87 /** 88 * @name Address Macros 89 * 90 * Macros for getting register addresses. 91 * These macros are used for retrieving the address of a register. 92 * HWIO_ADDR* will return the directly accessible address (virtual or physical based 93 * on environment), HWIO_PHYS* will always return the physical address. 94 * The offset from the base region can be retrieved using HWIO_OFFS*. 95 * The "X" extension is used for explicit addressing where the base address of 96 * the module in question is provided as an argument to the macro. 97 * 98 * @{ 99 */ 100 #define HWIO_ADDR(hwiosym) __msmhwio_addr(hwiosym) 101 #define HWIO_ADDRI(hwiosym, index) __msmhwio_addri(hwiosym, index) 102 #define HWIO_ADDRI2(hwiosym, index1, index2) __msmhwio_addri2(hwiosym, index1, index2) 103 #define HWIO_ADDRI3(hwiosym, index1, index2, index3) __msmhwio_addri3(hwiosym, index1, index2, index3) 104 105 #define HWIO_ADDRX(base, hwiosym) __msmhwio_addrx(base, hwiosym) 106 #define HWIO_ADDRXI(base, hwiosym, index) __msmhwio_addrxi(base, hwiosym, index) 107 #define HWIO_ADDRXI2(base, hwiosym, index1, index2) __msmhwio_addrxi2(base, hwiosym, index1, index2) 108 #define HWIO_ADDRXI3(base, hwiosym, index1, index2, index3) __msmhwio_addrxi3(base, hwiosym, index1, index2, index3) 109 110 #define HWIO_PHYS(hwiosym) __msmhwio_phys(hwiosym) 111 #define HWIO_PHYSI(hwiosym, index) __msmhwio_physi(hwiosym, index) 112 #define HWIO_PHYSI2(hwiosym, index1, index2) __msmhwio_physi2(hwiosym, index1, index2) 113 #define HWIO_PHYSI3(hwiosym, index1, index2, index3) __msmhwio_physi3(hwiosym, index1, index2, index3) 114 115 #define HWIO_PHYSX(base, hwiosym) __msmhwio_physx(base, hwiosym) 116 #define HWIO_PHYSXI(base, hwiosym, index) __msmhwio_physxi(base, hwiosym, index) 117 #define HWIO_PHYSXI2(base, hwiosym, index1, index2) __msmhwio_physxi2(base, hwiosym, index1, index2) 118 #define HWIO_PHYSXI3(base, hwiosym, index1, index2, index3) __msmhwio_physxi3(base, hwiosym, index1, index2, index3) 119 120 #define HWIO_OFFS(hwiosym) __msmhwio_offs(hwiosym) 121 #define HWIO_OFFSI(hwiosym, index) __msmhwio_offsi(hwiosym, index) 122 #define HWIO_OFFSI2(hwiosym, index1, index2) __msmhwio_offsi2(hwiosym, index1, index2) 123 #define HWIO_OFFSI3(hwiosym, index1, index2, index3) __msmhwio_offsi3(hwiosym, index1, index2, index3) 124 /** @} */ 125 126 /** 127 * @name Input Macros 128 * 129 * These macros are used for reading from a named hardware register. Register 130 * arrays ("indexed") use the macros with the "I" suffix. The "M" suffix 131 * indicates that the input will be masked with the supplied mask. The HWIO_INF* 132 * macros take a field name and will do the appropriate masking and shifting 133 * to return just the value of that field. 134 * The "X" extension is used for explicit addressing where the base address of 135 * the module in question is provided as an argument to the macro. 136 * 137 * Generally you want to use either HWIO_IN or HWIO_INF (with required indexing). 138 * 139 * @{ 140 */ 141 #define HWIO_IN(hwiosym) __msmhwio_in(hwiosym) 142 #define HWIO_INI(hwiosym, index) __msmhwio_ini(hwiosym, index) 143 #define HWIO_INI2(hwiosym, index1, index2) __msmhwio_ini2(hwiosym, index1, index2) 144 #define HWIO_INI3(hwiosym, index1, index2, index3) __msmhwio_ini3(hwiosym, index1, index2, index3) 145 146 #define HWIO_INM(hwiosym, mask) __msmhwio_inm(hwiosym, mask) 147 #define HWIO_INMI(hwiosym, index, mask) __msmhwio_inmi(hwiosym, index, mask) 148 #define HWIO_INMI2(hwiosym, index1, index2, mask) __msmhwio_inmi2(hwiosym, index1, index2, mask) 149 #define HWIO_INMI3(hwiosym, index1, index2, index3, mask) __msmhwio_inmi3(hwiosym, index1, index2, index3, mask) 150 151 #define HWIO_INF(io, field) (HWIO_INM(io, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 152 #define HWIO_INFI(io, index, field) (HWIO_INMI(io, index, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 153 #define HWIO_INFI2(io, index1, index2, field) (HWIO_INMI2(io, index1, index2, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 154 #define HWIO_INFI3(io, index1, index2, index3, field) (HWIO_INMI3(io, index1, index2, index3, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 155 156 #define HWIO_INX(base, hwiosym) __msmhwio_inx(base, hwiosym) 157 #define HWIO_INXI(base, hwiosym, index) __msmhwio_inxi(base, hwiosym, index) 158 #define HWIO_INXI2(base, hwiosym, index1, index2) __msmhwio_inxi2(base, hwiosym, index1, index2) 159 #define HWIO_INXI3(base, hwiosym, index1, index2, index3) __msmhwio_inxi3(base, hwiosym, index1, index2, index3) 160 161 #define HWIO_INXM(base, hwiosym, mask) __msmhwio_inxm(base, hwiosym, mask) 162 #define HWIO_INXMI(base, hwiosym, index, mask) __msmhwio_inxmi(base, hwiosym, index, mask) 163 #define HWIO_INXMI2(base, hwiosym, index1, index2, mask) __msmhwio_inxmi2(base, hwiosym, index1, index2, mask) 164 #define HWIO_INXMI3(base, hwiosym, index1, index2, index3, mask) __msmhwio_inxmi3(base, hwiosym, index1, index2, index3, mask) 165 166 #define HWIO_INXF(base, io, field) (HWIO_INXM(base, io, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 167 #define HWIO_INXFI(base, io, index, field) (HWIO_INXMI(base, io, index, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 168 #define HWIO_INXFI2(base, io, index1, index2, field) (HWIO_INXMI2(base, io, index1, index2, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 169 #define HWIO_INXFI3(base, io, index1, index2, index3, field) (HWIO_INXMI3(base, io, index1, index2, index3, HWIO_FMSK(io, field)) >> HWIO_SHFT(io, field)) 170 /** @} */ 171 172 /** 173 * @name Output Macros 174 * 175 * These macros are used for writing to a named hardware register. Register 176 * arrays ("indexed") use the macros with the "I" suffix. The "M" suffix 177 * indicates that the output will be masked with the supplied mask (meaning these 178 * macros do a read first, mask in the supplied data, then write it back). 179 * The "X" extension is used for explicit addressing where the base address of 180 * the module in question is provided as an argument to the macro. 181 * The HWIO_OUTF* macros take a field name and will do the appropriate masking 182 * and shifting to output just the value of that field. 183 * HWIO_OUTV* registers take a named value instead of a numeric value and 184 * do the same masking/shifting as HWIO_OUTF. 185 * 186 * Generally you want to use either HWIO_OUT or HWIO_OUTF (with required indexing). 187 * 188 * @{ 189 */ 190 #define HWIO_OUT(hwiosym, val) __msmhwio_out(hwiosym, val) 191 #define HWIO_OUTI(hwiosym, index, val) __msmhwio_outi(hwiosym, index, val) 192 #define HWIO_OUTI2(hwiosym, index1, index2, val) __msmhwio_outi2(hwiosym, index1, index2, val) 193 #define HWIO_OUTI3(hwiosym, index1, index2, index3, val) __msmhwio_outi3(hwiosym, index1, index2, index3, val) 194 195 #define HWIO_OUTM(hwiosym, mask, val) __msmhwio_outm(hwiosym, mask, val) 196 #define HWIO_OUTMI(hwiosym, index, mask, val) __msmhwio_outmi(hwiosym, index, mask, val) 197 #define HWIO_OUTMI2(hwiosym, index1, index2, mask, val) __msmhwio_outmi2(hwiosym, index1, index2, mask, val) 198 #define HWIO_OUTMI3(hwiosym, index1, index2, index3, mask, val) __msmhwio_outmi3(hwiosym, index1, index2, index3, mask, val) 199 200 #define HWIO_OUTF(io, field, val) HWIO_OUTM(io, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 201 #define HWIO_OUTFI(io, index, field, val) HWIO_OUTMI(io, index, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 202 #define HWIO_OUTFI2(io, index1, index2, field, val) HWIO_OUTMI2(io, index1, index2, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 203 #define HWIO_OUTFI3(io, index1, index2, index3, field, val) HWIO_OUTMI3(io, index1, index2, index3, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 204 205 #define HWIO_OUTV(io, field, val) HWIO_OUTM(io, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 206 #define HWIO_OUTVI(io, index, field, val) HWIO_OUTMI(io, index, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 207 #define HWIO_OUTVI2(io, index1, index2, field, val) HWIO_OUTMI2(io, index1, index2, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 208 #define HWIO_OUTVI3(io, index1, index2, index3, field, val) HWIO_OUTMI3(io, index1, index2, index3, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 209 210 #define HWIO_OUTX(base, hwiosym, val) __msmhwio_outx(base, hwiosym, val) 211 #define HWIO_OUTXI(base, hwiosym, index, val) __msmhwio_outxi(base, hwiosym, index, val) 212 #define HWIO_OUTXI2(base, hwiosym, index1, index2, val) __msmhwio_outxi2(base, hwiosym, index1, index2, val) 213 #define HWIO_OUTXI3(base, hwiosym, index1, index2, index3, val) __msmhwio_outxi3(base, hwiosym, index1, index2, index3, val) 214 215 #define HWIO_OUTXM(base, hwiosym, mask, val) __msmhwio_outxm(base, hwiosym, mask, val) 216 #define HWIO_OUTXM2(base, hwiosym, mask1, mask2, val1, val2) __msmhwio_outxm2(base, hwiosym, mask1, mask2, val1, val2) 217 #define HWIO_OUTXM3(base, hwiosym, mask1, mask2, mask3, val1, val2, val3) __msmhwio_outxm3(base, hwiosym, mask1, mask2, mask3, val1, val2, val3) 218 #define HWIO_OUTXM4(base, hwiosym, mask1, mask2, mask3, mask4, val1, val2, val3, val4) __msmhwio_outxm4(base, hwiosym, mask1, mask2, mask3, mask4, val1, val2, val3, val4) 219 #define HWIO_OUTXMI(base, hwiosym, index, mask, val) __msmhwio_outxmi(base, hwiosym, index, mask, val) 220 #define HWIO_OUTXMI2(base, hwiosym, index1, index2, mask, val) __msmhwio_outxmi2(base, hwiosym, index1, index2, mask, val) 221 #define HWIO_OUTXMI3(base, hwiosym, index1, index2, index3, mask, val) __msmhwio_outxmi3(base, hwiosym, index1, index2, index3, mask, val) 222 223 #define HWIO_OUTXF(base, io, field, val) HWIO_OUTXM(base, io, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 224 #define HWIO_OUTX2F(base, io, field1, field2, val1, val2) HWIO_OUTXM2(base, io, HWIO_FMSK(io, field1), HWIO_FMSK(io, field2), (uint32)(val1) << HWIO_SHFT(io, field1), (uint32)(val2) << HWIO_SHFT(io, field2)) 225 #define HWIO_OUTX3F(base, io, field1, field2, field3, val1, val2, val3) HWIO_OUTXM3(base, io, HWIO_FMSK(io, field1), HWIO_FMSK(io, field2), HWIO_FMSK(io, field3),(uint32)(val1) << HWIO_SHFT(io, field1), (uint32)(val2) << HWIO_SHFT(io, field2), (uint32)(val3) << HWIO_SHFT(io, field3) ) 226 #define HWIO_OUTX4F(base, io, field1, field2, field3, field4, val1, val2, val3, val4) HWIO_OUTXM4(base, io, HWIO_FMSK(io, field1), HWIO_FMSK(io, field2), HWIO_FMSK(io, field3), HWIO_FMSK(io, field4), (uint32)(val1) << HWIO_SHFT(io, field1) , (uint32)(val2) << HWIO_SHFT(io, field2), (uint32)(val3) << HWIO_SHFT(io, field3), (uint32)(val4) << HWIO_SHFT(io, field4) ) 227 228 #define HWIO_OUTXFI(base, io, index, field, val) HWIO_OUTXMI(base, io, index, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 229 #define HWIO_OUTXFI2(base, io, index1, index2, field, val) HWIO_OUTXMI2(base, io, index1, index2, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 230 #define HWIO_OUTXFI3(base, io, index1, index2, index3, field, val) HWIO_OUTXMI3(base, io, index1, index2, index3, HWIO_FMSK(io, field), (uint32)(val) << HWIO_SHFT(io, field)) 231 232 #define HWIO_OUTXV(base, io, field, val) HWIO_OUTXM(base, io, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 233 #define HWIO_OUTXVI(base, io, index, field, val) HWIO_OUTXMI(base, io, index, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 234 #define HWIO_OUTXVI2(base, io, index1, index2, field, val) HWIO_OUTXMI2(base, io, index1, index2, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 235 #define HWIO_OUTXVI3(base, io, index1, index2, index3, field, val) HWIO_OUTXMI3(base, io, index1, index2, index3, HWIO_FMSK(io, field), (uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) 236 /** @} */ 237 238 /** 239 * @name Shift and Mask Macros 240 * 241 * Macros for getting shift and mask values for fields and registers. 242 * HWIO_RMSK: The mask value for accessing an entire register. For example: 243 * @code 244 * HWIO_RMSK(REG) -> 0xFFFFFFFF 245 * @endcode 246 * HWIO_RSHFT: The right-shift value for an entire register (rarely necessary).\n 247 * HWIO_SHFT: The right-shift value for accessing a field in a register. For example: 248 * @code 249 * HWIO_SHFT(REG, FLD) -> 8 250 * @endcode 251 * HWIO_FMSK: The mask value for accessing a field in a register. For example: 252 * @code 253 * HWIO_FMSK(REG, FLD) -> 0xFF00 254 * @endcode 255 * HWIO_VAL: The value for a field in a register. For example: 256 * @code 257 * HWIO_VAL(REG, FLD, ON) -> 0x1 258 * @endcode 259 * HWIO_FVAL: This macro takes a numerical value and will shift and mask it into 260 * the given field position. For example: 261 * @code 262 * HWIO_FVAL(REG, FLD, 0x1) -> 0x100 263 * @endcode 264 * HWIO_FVALV: This macro takes a logical (named) value and will shift and mask it 265 * into the given field position. For example: 266 * @code 267 * HWIO_FVALV(REG, FLD, ON) -> 0x100 268 * @endcode 269 * 270 * @{ 271 */ 272 #define HWIO_RMSK(hwiosym) __msmhwio_rmsk(hwiosym) 273 #define HWIO_RMSKI(hwiosym, index) __msmhwio_rmski(hwiosym, index) 274 #define HWIO_RSHFT(hwiosym) __msmhwio_rshft(hwiosym) 275 #define HWIO_SHFT(hwio_regsym, hwio_fldsym) __msmhwio_shft(hwio_regsym, hwio_fldsym) 276 #define HWIO_FMSK(hwio_regsym, hwio_fldsym) __msmhwio_fmsk(hwio_regsym, hwio_fldsym) 277 #define HWIO_VAL(io, field, val) __msmhwio_val(io, field, val) 278 #define HWIO_FVAL(io, field, val) (((uint32)(val) << HWIO_SHFT(io, field)) & HWIO_FMSK(io, field)) 279 #define HWIO_FVALV(io, field, val) (((uint32)(HWIO_VAL(io, field, val)) << HWIO_SHFT(io, field)) & HWIO_FMSK(io, field)) 280 /** @} */ 281 282 /** 283 * @name Shadow Register Macros 284 * 285 * These macros are used for directly reading the value stored in a 286 * shadow register. 287 * Shadow registers are defined for write-only registers. Generally these 288 * macros should not be necessary as HWIO_OUTM* macros will automatically use 289 * the shadow values internally. 290 * 291 * @{ 292 */ 293 #define HWIO_SHDW(hwiosym) __msmhwio_shdw(hwiosym) 294 #define HWIO_SHDWI(hwiosym, index) __msmhwio_shdwi(hwiosym, index) 295 /** @} */ 296 297 /** 298 @} 299 */ /* end_group */ 300 301 302 /** @cond */ 303 304 /* 305 * Map to final symbols. This remapping is done to allow register 306 * redefinitions. If we just define HWIO_IN(xreg) as HWIO_##xreg##_IN 307 * then remappings like "#define xreg xregnew" do not work as expected. 308 */ 309 #define __msmhwio_in(hwiosym) HWIO_##hwiosym##_IN 310 #define __msmhwio_ini(hwiosym, index) HWIO_##hwiosym##_INI(index) 311 #define __msmhwio_ini2(hwiosym, index1, index2) HWIO_##hwiosym##_INI2(index1, index2) 312 #define __msmhwio_ini3(hwiosym, index1, index2, index3) HWIO_##hwiosym##_INI3(index1, index2, index3) 313 #define __msmhwio_inm(hwiosym, mask) HWIO_##hwiosym##_INM(mask) 314 #define __msmhwio_inmi(hwiosym, index, mask) HWIO_##hwiosym##_INMI(index, mask) 315 #define __msmhwio_inmi2(hwiosym, index1, index2, mask) HWIO_##hwiosym##_INMI2(index1, index2, mask) 316 #define __msmhwio_inmi3(hwiosym, index1, index2, index3, mask) HWIO_##hwiosym##_INMI3(index1, index2, index3, mask) 317 #define __msmhwio_out(hwiosym, val) HWIO_##hwiosym##_OUT(val) 318 #define __msmhwio_outi(hwiosym, index, val) HWIO_##hwiosym##_OUTI(index,val) 319 #define __msmhwio_outi2(hwiosym, index1, index2, val) HWIO_##hwiosym##_OUTI2(index1, index2, val) 320 #define __msmhwio_outi3(hwiosym, index1, index2, index3, val) HWIO_##hwiosym##_OUTI2(index1, index2, index3, val) 321 #define __msmhwio_outm(hwiosym, mask, val) HWIO_##hwiosym##_OUTM(mask, val) 322 #define __msmhwio_outmi(hwiosym, index, mask, val) HWIO_##hwiosym##_OUTMI(index, mask, val) 323 #define __msmhwio_outmi2(hwiosym, idx1, idx2, mask, val) HWIO_##hwiosym##_OUTMI2(idx1, idx2, mask, val) 324 #define __msmhwio_outmi3(hwiosym, idx1, idx2, idx3, mask, val) HWIO_##hwiosym##_OUTMI3(idx1, idx2, idx3, mask, val) 325 #define __msmhwio_addr(hwiosym) HWIO_##hwiosym##_ADDR 326 #define __msmhwio_addri(hwiosym, index) HWIO_##hwiosym##_ADDR(index) 327 #define __msmhwio_addri2(hwiosym, idx1, idx2) HWIO_##hwiosym##_ADDR(idx1, idx2) 328 #define __msmhwio_addri3(hwiosym, idx1, idx2, idx3) HWIO_##hwiosym##_ADDR(idx1, idx2, idx3) 329 #define __msmhwio_phys(hwiosym) HWIO_##hwiosym##_PHYS 330 #define __msmhwio_physi(hwiosym, index) HWIO_##hwiosym##_PHYS(index) 331 #define __msmhwio_physi2(hwiosym, idx1, idx2) HWIO_##hwiosym##_PHYS(idx1, idx2) 332 #define __msmhwio_physi3(hwiosym, idx1, idx2, idx3) HWIO_##hwiosym##_PHYS(idx1, idx2, idx3) 333 #define __msmhwio_offs(hwiosym) HWIO_##hwiosym##_OFFS 334 #define __msmhwio_offsi(hwiosym, index) HWIO_##hwiosym##_OFFS(index) 335 #define __msmhwio_offsi2(hwiosym, idx1, idx2) HWIO_##hwiosym##_OFFS(idx1, idx2) 336 #define __msmhwio_offsi3(hwiosym, idx1, idx2, idx3) HWIO_##hwiosym##_OFFS(idx1, idx2, idx3) 337 #define __msmhwio_rmsk(hwiosym) HWIO_##hwiosym##_RMSK 338 #define __msmhwio_rmski(hwiosym, index) HWIO_##hwiosym##_RMSK(index) 339 #define __msmhwio_fmsk(hwiosym, hwiofldsym) HWIO_##hwiosym##_##hwiofldsym##_BMSK 340 #define __msmhwio_rshft(hwiosym) HWIO_##hwiosym##_SHFT 341 #define __msmhwio_shft(hwiosym, hwiofldsym) HWIO_##hwiosym##_##hwiofldsym##_SHFT 342 #define __msmhwio_shdw(hwiosym) HWIO_##hwiosym##_shadow 343 #define __msmhwio_shdwi(hwiosym, index) HWIO_##hwiosym##_SHDW(index) 344 #define __msmhwio_val(hwiosym, hwiofld, hwioval) HWIO_##hwiosym##_##hwiofld##_##hwioval##_FVAL 345 346 #define __msmhwio_inx(base, hwiosym) HWIO_##hwiosym##_IN(base) 347 #define __msmhwio_inxi(base, hwiosym, index) HWIO_##hwiosym##_INI(base, index) 348 #define __msmhwio_inxi2(base, hwiosym, index1, index2) HWIO_##hwiosym##_INI2(base, index1, index2) 349 #define __msmhwio_inxi3(base, hwiosym, index1, index2, index3) HWIO_##hwiosym##_INI3(base, index1, index2, index3) 350 #define __msmhwio_inxm(base, hwiosym, mask) HWIO_##hwiosym##_INM(base, mask) 351 #define __msmhwio_inxmi(base, hwiosym, index, mask) HWIO_##hwiosym##_INMI(base, index, mask) 352 #define __msmhwio_inxmi2(base, hwiosym, index1, index2, mask) HWIO_##hwiosym##_INMI2(base, index1, index2, mask) 353 #define __msmhwio_inxmi3(base, hwiosym, index1, index2, index3, mask) HWIO_##hwiosym##_INMI3(base, index1, index2, index3, mask) 354 #define __msmhwio_outx(base, hwiosym, val) HWIO_##hwiosym##_OUT(base, val) 355 #define __msmhwio_outxi(base, hwiosym, index, val) HWIO_##hwiosym##_OUTI(base, index,val) 356 #define __msmhwio_outxi2(base, hwiosym, index1, index2, val) HWIO_##hwiosym##_OUTI2(base, index1, index2, val) 357 #define __msmhwio_outxi3(base, hwiosym, index1, index2, index3, val) HWIO_##hwiosym##_OUTI2(base, index1, index2, index3, val) 358 #define __msmhwio_outxm(base, hwiosym, mask, val) HWIO_##hwiosym##_OUTM(base, mask, val) 359 #define __msmhwio_outxm2(base, hwiosym, mask1, mask2, val1, val2) { \ 360 HWIO_##hwiosym##_OUTM(base, mask1, val1); \ 361 HWIO_##hwiosym##_OUTM(base, mask2, val2); \ 362 } 363 #define __msmhwio_outxm3(base, hwiosym, mask1, mask2, mask3, val1, val2, val3) { \ 364 HWIO_##hwiosym##_OUTM(base, mask1, val1); \ 365 HWIO_##hwiosym##_OUTM(base, mask2, val2); \ 366 HWIO_##hwiosym##_OUTM(base, mask3, val3); \ 367 } 368 #define __msmhwio_outxm4(base, hwiosym, mask1, mask2, mask3, mask4, val1, val2, val3, val4) { \ 369 HWIO_##hwiosym##_OUTM(base, mask1, val1); \ 370 HWIO_##hwiosym##_OUTM(base, mask2, val2); \ 371 HWIO_##hwiosym##_OUTM(base, mask3, val3); \ 372 HWIO_##hwiosym##_OUTM(base, mask4, val4); \ 373 } 374 375 376 #define __msmhwio_outxmi(base, hwiosym, index, mask, val) HWIO_##hwiosym##_OUTMI(base, index, mask, val) 377 #define __msmhwio_outxmi2(base, hwiosym, idx1, idx2, mask, val) HWIO_##hwiosym##_OUTMI2(base, idx1, idx2, mask, val) 378 #define __msmhwio_outxmi3(base, hwiosym, idx1, idx2, idx3, mask, val) HWIO_##hwiosym##_OUTMI3(base, idx1, idx2, idx3, mask, val) 379 #define __msmhwio_addrx(base, hwiosym) HWIO_##hwiosym##_ADDR(base) 380 #define __msmhwio_addrxi(base, hwiosym, index) HWIO_##hwiosym##_ADDR(base, index) 381 #define __msmhwio_addrxi2(base, hwiosym, idx1, idx2) HWIO_##hwiosym##_ADDR(base, idx1, idx2) 382 #define __msmhwio_addrxi3(base, hwiosym, idx1, idx2, idx3) HWIO_##hwiosym##_ADDR(base, idx1, idx2, idx3) 383 #define __msmhwio_physx(base, hwiosym) HWIO_##hwiosym##_PHYS(base) 384 #define __msmhwio_physxi(base, hwiosym, index) HWIO_##hwiosym##_PHYS(base, index) 385 #define __msmhwio_physxi2(base, hwiosym, idx1, idx2) HWIO_##hwiosym##_PHYS(base, idx1, idx2) 386 #define __msmhwio_physxi3(base, hwiosym, idx1, idx2, idx3) HWIO_##hwiosym##_PHYS(base, idx1, idx2, idx3) 387 388 389 /* 390 * HWIO_INTLOCK 391 * 392 * Macro used by autogenerated code for mutual exclusion around 393 * read-mask-write operations. This is not supported in HAL 394 * code but can be overridden by non-HAL code. 395 */ 396 #define HWIO_INTLOCK() 397 #define HWIO_INTFREE() 398 399 400 /* 401 * Input/output port macros for memory mapped IO. 402 */ 403 #define __inp(port) (*((volatile uint8 *) (port))) 404 #define __inpw(port) (*((volatile uint16 *) (port))) 405 #define __inpdw(port) (*((volatile uint32 *) (port))) 406 #define __outp(port, val) (*((volatile uint8 *) (port)) = ((uint8) (val))) 407 #define __outpw(port, val) (*((volatile uint16 *) (port)) = ((uint16) (val))) 408 #define __outpdw(port, val) (*((volatile uint32 *) (port)) = ((uint32) (val))) 409 410 411 #ifdef HAL_HWIO_EXTERNAL 412 413 /* 414 * Replace macros with externally supplied functions. 415 */ 416 #undef __inp 417 #undef __inpw 418 #undef __inpdw 419 #undef __outp 420 #undef __outpw 421 #undef __outpdw 422 423 #define __inp(port) __inp_extern(port) 424 #define __inpw(port) __inpw_extern(port) 425 #define __inpdw(port) __inpdw_extern(port) 426 #define __outp(port, val) __outp_extern(port, val) 427 #define __outpw(port, val) __outpw_extern(port, val) 428 #define __outpdw(port, val) __outpdw_extern(port, val) 429 430 extern uint8 __inp_extern ( uint32 nAddr ); 431 extern uint16 __inpw_extern ( uint32 nAddr ); 432 extern uint32 __inpdw_extern ( uint32 nAddr ); 433 extern void __outp_extern ( uint32 nAddr, uint8 nData ); 434 extern void __outpw_extern ( uint32 nAddr, uint16 nData ); 435 extern void __outpdw_extern ( uint32 nAddr, uint32 nData ); 436 437 #endif /* HAL_HWIO_EXTERNAL */ 438 439 440 /* 441 * Base 8-bit byte accessing macros. 442 */ 443 #define in_byte(addr) (__inp(addr)) 444 #define in_byte_masked(addr, mask) (__inp(addr) & (mask)) 445 #define out_byte(addr, val) __outp(addr,val) 446 #define out_byte_masked(io, mask, val, shadow) \ 447 HWIO_INTLOCK(); \ 448 out_byte( io, shadow); \ 449 shadow = (shadow & (uint16)(~(mask))) | ((uint16)((val) & (mask))); \ 450 HWIO_INTFREE() 451 #define out_byte_masked_ns(io, mask, val, current_reg_content) \ 452 out_byte( io, ((current_reg_content & (uint16)(~(mask))) | \ 453 ((uint16)((val) & (mask)))) ) 454 455 456 /* 457 * Base 16-bit word accessing macros. 458 */ 459 #define in_word(addr) (__inpw(addr)) 460 #define in_word_masked(addr, mask) (__inpw(addr) & (mask)) 461 #define out_word(addr, val) __outpw(addr,val) 462 #define out_word_masked(io, mask, val, shadow) \ 463 HWIO_INTLOCK( ); \ 464 shadow = (shadow & (uint16)(~(mask))) | ((uint16)((val) & (mask))); \ 465 out_word( io, shadow); \ 466 HWIO_INTFREE( ) 467 #define out_word_masked_ns(io, mask, val, current_reg_content) \ 468 out_word( io, ((current_reg_content & (uint16)(~(mask))) | \ 469 ((uint16)((val) & (mask)))) ) 470 471 472 /* 473 * Base 32-bit double-word accessing macros. 474 */ 475 #define in_dword(addr) (__inpdw(addr)) 476 #define in_dword_masked(addr, mask) (__inpdw(addr) & (mask)) 477 #define out_dword(addr, val) __outpdw(addr,val) 478 #define out_dword_masked(io, mask, val, shadow) \ 479 HWIO_INTLOCK(); \ 480 shadow = (shadow & (uint32)(~(mask))) | ((uint32)((val) & (mask))); \ 481 out_dword( io, shadow); \ 482 HWIO_INTFREE() 483 #define out_dword_masked_ns(io, mask, val, current_reg_content) \ 484 out_dword( io, ((current_reg_content & (uint32)(~(mask))) | \ 485 ((uint32)((val) & (mask)))) ) 486 487 /** @endcond */ 488 489 #endif /* HAL_HWIO_H */ 490 491