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