xref: /wlan-driver/fw-api/hw/qcn9000/seq_hwio.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019, 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 /*********************************************************************************
18*5113495bSYour Name  *
19*5113495bSYour Name  * DESCRIPTION
20*5113495bSYour Name  * - This is an extension of standard msmhwio.h to support relative addressing
21*5113495bSYour Name  *   scheme used in SCALe auto-generated sequences.
22*5113495bSYour Name  * - The objective of this new addressing scheme is enable the same C function
23*5113495bSYour Name  *   definition to be applicable to multiple baseances of the same block.
24*5113495bSYour Name  * - Such code reuse is not feasible with the standard HWIO macros that use a
25*5113495bSYour Name  *   absolute addressing scheme.
26*5113495bSYour Name  * - Compared to the standard HWIO macros, the new macros defined here take an
27*5113495bSYour Name  *   additional parameter 'baseance offset'.  So are the C functions generated
28*5113495bSYour Name  *   by SCALe Autoseq from .seq inputs.
29*5113495bSYour Name  * - As such, macros defined in this file must be used with 'seq_msmhwiobase.h',
30*5113495bSYour Name  *   'seq_msmhwioreg.h', and the C codes generated from SCALe Autoseq.
31*5113495bSYour Name  * - Macros defined in this file leverage the lower-level macros from the
32*5113495bSYour Name  *   standard 'msmhwio.h', and the two sets of macros are compatible.
33*5113495bSYour Name  *
34*5113495bSYour Name  ********************************************************************************/
35*5113495bSYour Name 
36*5113495bSYour Name #ifndef __SEQ_H__
37*5113495bSYour Name #define __SEQ_H__
38*5113495bSYour Name 
39*5113495bSYour Name #include "HALhwio.h"
40*5113495bSYour Name 
41*5113495bSYour Name 
42*5113495bSYour Name 
43*5113495bSYour Name /**** Register Ref Read ****/
44*5113495bSYour Name #define SEQ_INH(base, regtype, reg) \
45*5113495bSYour Name         SEQ_##regtype##_INH(base, reg)
46*5113495bSYour Name 
47*5113495bSYour Name /**** Masked Register Read ****/
48*5113495bSYour Name #define SEQ_INMH(base, regtype, reg, mask) \
49*5113495bSYour Name         SEQ_##regtype##_INMH(base, reg, mask)
50*5113495bSYour Name 
51*5113495bSYour Name 
52*5113495bSYour Name /**** Ref Reg Field Read ****/
53*5113495bSYour Name #define SEQ_INFH(base, regtype, reg, fld) \
54*5113495bSYour Name         (SEQ_##regtype##_INMH(base, reg, HWIO_FMSK(regtype, fld)) >> HWIO_SHFT(regtype, fld))
55*5113495bSYour Name 
56*5113495bSYour Name 
57*5113495bSYour Name /**** Ref Register  Write ****/
58*5113495bSYour Name #define SEQ_OUTH(base, regtype, reg, val) \
59*5113495bSYour Name         SEQ_##regtype##_OUTH(base, reg, val)
60*5113495bSYour Name 
61*5113495bSYour Name /**** Ref Register Masked Write ****/
62*5113495bSYour Name #define SEQ_OUTMH(base, regtype, reg, mask, val) \
63*5113495bSYour Name         SEQ_##regtype##_OUTMH(base, reg, mask, val)
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name /**** Ref Register Field Write ****/
67*5113495bSYour Name #define SEQ_OUTFH(base, regtype, reg, fld, val) \
68*5113495bSYour Name         SEQ_##regtype##_OUTMH(base, reg, HWIO_FMSK(regtype, fld), val << HWIO_SHFT(regtype, fld))
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name /**** seq_msg() ****
72*5113495bSYour Name 
73*5113495bSYour Name typedef enum {
74*5113495bSYour Name 	DEBUG,
75*5113495bSYour Name 	INFO,
76*5113495bSYour Name 	WARNING,
77*5113495bSYour Name 	ERROR,
78*5113495bSYour Name 	FATAL
79*5113495bSYour Name } SeverityLevel ;
80*5113495bSYour Name 
81*5113495bSYour Name void seq_msg(SeverityLevel severity, unsigned int msg_id, const char *format_str, ... );
82*5113495bSYour Name 
83*5113495bSYour Name */
84*5113495bSYour Name 
85*5113495bSYour Name /************ seq_wait() ************/
86*5113495bSYour Name 
87*5113495bSYour Name typedef enum {
88*5113495bSYour Name     SEC,
89*5113495bSYour Name     MS,
90*5113495bSYour Name     US,
91*5113495bSYour Name     NS
92*5113495bSYour Name } SEQ_TimeUnit;
93*5113495bSYour Name 
94*5113495bSYour Name void seq_wait(uint32_t time_value, SEQ_TimeUnit time_unit);
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name /************ seq_poll() ************/
98*5113495bSYour Name uint32_t seq_poll(uint32_t reg_offset, uint32_t expect_value, uint32_t value_mask, uint32_t value_shift, uint32_t max_poll_cnt);
99*5113495bSYour Name 
100*5113495bSYour Name #endif /* __SEQ_H__ */
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120