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