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