xref: /wlan-driver/fw-api/hw/qca6290/v1/HALcomdef.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef HAL_COMDEF_H
20*5113495bSYour Name #define HAL_COMDEF_H
21*5113495bSYour Name /*
22*5113495bSYour Name ==============================================================================
23*5113495bSYour Name 
24*5113495bSYour Name FILE:         HALcomdef.h
25*5113495bSYour Name 
26*5113495bSYour Name DESCRIPTION:
27*5113495bSYour Name 
28*5113495bSYour Name ==============================================================================
29*5113495bSYour Name 
30*5113495bSYour Name                              Edit History
31*5113495bSYour Name 
32*5113495bSYour Name $Header: //depot/prj/qca/lithium/wcss/verif/native/register/include/HALcomdef.h#6 $
33*5113495bSYour Name 
34*5113495bSYour Name when       who     what, where, why
35*5113495bSYour Name --------   ---     -----------------------------------------------------------
36*5113495bSYour Name 06/17/10   sc      Included com_dtypes.h and cleaned up typedefs
37*5113495bSYour Name 05/15/08   gfr     Added HAL_ENUM_32BITS macro.
38*5113495bSYour Name 02/14/08   gfr     Added bool32 type.
39*5113495bSYour Name 11/13/07   gfr     Removed dependency on comdef.h
40*5113495bSYour Name 01/08/07   hxw     Created
41*5113495bSYour Name 
42*5113495bSYour Name */
43*5113495bSYour Name 
44*5113495bSYour Name 
45*5113495bSYour Name /*
46*5113495bSYour Name  * Assembly wrapper
47*5113495bSYour Name  */
48*5113495bSYour Name #ifndef _ARM_ASM_
49*5113495bSYour Name 
50*5113495bSYour Name /*
51*5113495bSYour Name  * C++ wrapper
52*5113495bSYour Name  */
53*5113495bSYour Name #ifdef __cplusplus
54*5113495bSYour Name extern "C" {
55*5113495bSYour Name #endif
56*5113495bSYour Name 
57*5113495bSYour Name #include "com_dtypes.h"
58*5113495bSYour Name 
59*5113495bSYour Name /* -----------------------------------------------------------------------
60*5113495bSYour Name ** Types
61*5113495bSYour Name ** ----------------------------------------------------------------------- */
62*5113495bSYour Name 
63*5113495bSYour Name /*
64*5113495bSYour Name  * Standard integer types.
65*5113495bSYour Name  *
66*5113495bSYour Name  * bool32  - boolean, 32 bit (TRUE or FALSE)
67*5113495bSYour Name  */
68*5113495bSYour Name #ifndef _BOOL32_DEFINED
69*5113495bSYour Name typedef  unsigned long int  bool32;
70*5113495bSYour Name #define _BOOL32_DEFINED
71*5113495bSYour Name #endif
72*5113495bSYour Name 
73*5113495bSYour Name /*
74*5113495bSYour Name  * Macro to allow forcing an enum to 32 bits.  The argument should be
75*5113495bSYour Name  * an identifier in the namespace of the enumeration in question, i.e.
76*5113495bSYour Name  * for the clk HAL we might use HAL_ENUM_32BITS(CLK_xxx).
77*5113495bSYour Name  */
78*5113495bSYour Name #define HAL_ENUM_32BITS(x) HAL_##x##_FORCE32BITS = 0x7FFFFFFF
79*5113495bSYour Name 
80*5113495bSYour Name /*===========================================================================
81*5113495bSYour Name 
82*5113495bSYour Name FUNCTION inp, outp, inpw, outpw, inpdw, outpdw
83*5113495bSYour Name 
84*5113495bSYour Name DESCRIPTION
85*5113495bSYour Name   IN/OUT port macros for byte and word ports, typically inlined by compilers
86*5113495bSYour Name   which support these routines
87*5113495bSYour Name 
88*5113495bSYour Name PARAMETERS
89*5113495bSYour Name   inp(   xx_addr )
90*5113495bSYour Name   inpw(  xx_addr )
91*5113495bSYour Name   inpdw( xx_addr )
92*5113495bSYour Name   outp(   xx_addr, xx_byte_val  )
93*5113495bSYour Name   outpw(  xx_addr, xx_word_val  )
94*5113495bSYour Name   outpdw( xx_addr, xx_dword_val )
95*5113495bSYour Name       xx_addr      - Address of port to read or write (may be memory mapped)
96*5113495bSYour Name       xx_byte_val  - 8 bit value to write
97*5113495bSYour Name       xx_word_val  - 16 bit value to write
98*5113495bSYour Name       xx_dword_val - 32 bit value to write
99*5113495bSYour Name 
100*5113495bSYour Name DEPENDENCIES
101*5113495bSYour Name   None
102*5113495bSYour Name 
103*5113495bSYour Name RETURN VALUE
104*5113495bSYour Name   inp/inpw/inpdw: the byte, word or dword read from the given address
105*5113495bSYour Name   outp/outpw/outpdw: the byte, word or dword written to the given address
106*5113495bSYour Name 
107*5113495bSYour Name SIDE EFFECTS
108*5113495bSYour Name   None.
109*5113495bSYour Name 
110*5113495bSYour Name ===========================================================================*/
111*5113495bSYour Name 
112*5113495bSYour Name   /* ARM based targets use memory mapped i/o, so the inp/outp calls are
113*5113495bSYour Name   ** macroized to access memory directly
114*5113495bSYour Name   */
115*5113495bSYour Name 
116*5113495bSYour Name   #define inp(port)         (*((volatile byte *) (port)))
117*5113495bSYour Name   #define inpw(port)        (*((volatile word *) (port)))
118*5113495bSYour Name   #define inpdw(port)       (*((volatile dword *)(port)))
119*5113495bSYour Name 
120*5113495bSYour Name   #define outp(port, val)   (*((volatile byte *) (port)) = ((byte) (val)))
121*5113495bSYour Name   #define outpw(port, val)  (*((volatile word *) (port)) = ((word) (val)))
122*5113495bSYour Name   #define outpdw(port, val) (*((volatile dword *) (port)) = ((dword) (val)))
123*5113495bSYour Name 
124*5113495bSYour Name #ifdef __cplusplus
125*5113495bSYour Name }
126*5113495bSYour Name #endif
127*5113495bSYour Name 
128*5113495bSYour Name #endif /* !_ARM_ASM_ */
129*5113495bSYour Name 
130*5113495bSYour Name #endif /* HAL_COMDEF_H */
131*5113495bSYour Name 
132