xref: /wlan-driver/fw-api/hw/qcn6122/HALcomdef.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, 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_COMDEF_H
18*5113495bSYour Name #define HAL_COMDEF_H
19*5113495bSYour Name /*
20*5113495bSYour Name ==============================================================================
21*5113495bSYour Name 
22*5113495bSYour Name FILE:         HALcomdef.h
23*5113495bSYour Name 
24*5113495bSYour Name DESCRIPTION:
25*5113495bSYour Name 
26*5113495bSYour Name ==============================================================================
27*5113495bSYour Name 
28*5113495bSYour Name                              Edit History
29*5113495bSYour Name 
30*5113495bSYour Name $Header: //depot/prj/qca/lithium3/wcss/spruce_verif/native/register/include/HALcomdef.h#2 $
31*5113495bSYour Name 
32*5113495bSYour Name when       who     what, where, why
33*5113495bSYour Name --------   ---     -----------------------------------------------------------
34*5113495bSYour Name 06/17/10   sc      Included com_dtypes.h and cleaned up typedefs
35*5113495bSYour Name 05/15/08   gfr     Added HAL_ENUM_32BITS macro.
36*5113495bSYour Name 02/14/08   gfr     Added bool32 type.
37*5113495bSYour Name 11/13/07   gfr     Removed dependency on comdef.h
38*5113495bSYour Name 01/08/07   hxw     Created
39*5113495bSYour Name */
40*5113495bSYour Name 
41*5113495bSYour Name 
42*5113495bSYour Name /*
43*5113495bSYour Name  * Assembly wrapper
44*5113495bSYour Name  */
45*5113495bSYour Name #ifndef _ARM_ASM_
46*5113495bSYour Name 
47*5113495bSYour Name /*
48*5113495bSYour Name  * C++ wrapper
49*5113495bSYour Name  */
50*5113495bSYour Name #ifdef __cplusplus
51*5113495bSYour Name extern "C" {
52*5113495bSYour Name #endif
53*5113495bSYour Name 
54*5113495bSYour Name #include "com_dtypes.h"
55*5113495bSYour Name 
56*5113495bSYour Name /* -----------------------------------------------------------------------
57*5113495bSYour Name ** Types
58*5113495bSYour Name ** ----------------------------------------------------------------------- */
59*5113495bSYour Name 
60*5113495bSYour Name /*
61*5113495bSYour Name  * Standard integer types.
62*5113495bSYour Name  *
63*5113495bSYour Name  * bool32  - boolean, 32 bit (TRUE or FALSE)
64*5113495bSYour Name  */
65*5113495bSYour Name #ifndef _BOOL32_DEFINED
66*5113495bSYour Name typedef  unsigned long int  bool32;
67*5113495bSYour Name #define _BOOL32_DEFINED
68*5113495bSYour Name #endif
69*5113495bSYour Name 
70*5113495bSYour Name /*
71*5113495bSYour Name  * Macro to allow forcing an enum to 32 bits.  The argument should be
72*5113495bSYour Name  * an identifier in the namespace of the enumeration in question, i.e.
73*5113495bSYour Name  * for the clk HAL we might use HAL_ENUM_32BITS(CLK_xxx).
74*5113495bSYour Name  */
75*5113495bSYour Name #define HAL_ENUM_32BITS(x) HAL_##x##_FORCE32BITS = 0x7FFFFFFF
76*5113495bSYour Name 
77*5113495bSYour Name /*===========================================================================
78*5113495bSYour Name 
79*5113495bSYour Name FUNCTION inp, outp, inpw, outpw, inpdw, outpdw
80*5113495bSYour Name 
81*5113495bSYour Name DESCRIPTION
82*5113495bSYour Name   IN/OUT port macros for byte and word ports, typically inlined by compilers
83*5113495bSYour Name   which support these routines
84*5113495bSYour Name 
85*5113495bSYour Name PARAMETERS
86*5113495bSYour Name   inp(   xx_addr )
87*5113495bSYour Name   inpw(  xx_addr )
88*5113495bSYour Name   inpdw( xx_addr )
89*5113495bSYour Name   outp(   xx_addr, xx_byte_val  )
90*5113495bSYour Name   outpw(  xx_addr, xx_word_val  )
91*5113495bSYour Name   outpdw( xx_addr, xx_dword_val )
92*5113495bSYour Name       xx_addr      - Address of port to read or write (may be memory mapped)
93*5113495bSYour Name       xx_byte_val  - 8 bit value to write
94*5113495bSYour Name       xx_word_val  - 16 bit value to write
95*5113495bSYour Name       xx_dword_val - 32 bit value to write
96*5113495bSYour Name 
97*5113495bSYour Name DEPENDENCIES
98*5113495bSYour Name   None
99*5113495bSYour Name 
100*5113495bSYour Name RETURN VALUE
101*5113495bSYour Name   inp/inpw/inpdw: the byte, word or dword read from the given address
102*5113495bSYour Name   outp/outpw/outpdw: the byte, word or dword written to the given address
103*5113495bSYour Name 
104*5113495bSYour Name SIDE EFFECTS
105*5113495bSYour Name   None.
106*5113495bSYour Name 
107*5113495bSYour Name ===========================================================================*/
108*5113495bSYour Name 
109*5113495bSYour Name   /* ARM based targets use memory mapped i/o, so the inp/outp calls are
110*5113495bSYour Name   ** macroized to access memory directly
111*5113495bSYour Name   */
112*5113495bSYour Name 
113*5113495bSYour Name #if defined(VV_FEATURE_COMPILING_64BIT)
114*5113495bSYour Name   #define inp(port)         (*((volatile dword *) (port)))
115*5113495bSYour Name   #define inpw(port)        (*((volatile word *) (port)))
116*5113495bSYour Name   #define inpdw(port)       (*((volatile dword *)(port)))
117*5113495bSYour Name 
118*5113495bSYour Name   #define outp(port, val)   (*((volatile dword *) (port)) = ((dword) (val)))
119*5113495bSYour Name   #define outpw(port, val)  (*((volatile word *) (port)) = ((word) (val)))
120*5113495bSYour Name   #define outpdw(port, val) (*((volatile dword *) (port)) = ((dword) (val)))
121*5113495bSYour Name #endif
122*5113495bSYour Name 
123*5113495bSYour Name #ifdef __cplusplus
124*5113495bSYour Name }
125*5113495bSYour Name #endif
126*5113495bSYour Name 
127*5113495bSYour Name #endif /* !_ARM_ASM_ */
128*5113495bSYour Name 
129*5113495bSYour Name #endif /* HAL_COMDEF_H */
130*5113495bSYour Name 
131