xref: /wlan-driver/fw-api/hw/qca6390/v1/uniform_reo_cmd_header.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018 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 _UNIFORM_REO_CMD_HEADER_H_
20*5113495bSYour Name #define _UNIFORM_REO_CMD_HEADER_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name // ################ START SUMMARY #################
26*5113495bSYour Name //
27*5113495bSYour Name //	Dword	Fields
28*5113495bSYour Name //	0	reo_cmd_number[15:0], reo_status_required[16], reserved_0a[31:17]
29*5113495bSYour Name //
30*5113495bSYour Name // ################ END SUMMARY #################
31*5113495bSYour Name 
32*5113495bSYour Name #define NUM_OF_DWORDS_UNIFORM_REO_CMD_HEADER 1
33*5113495bSYour Name 
34*5113495bSYour Name struct uniform_reo_cmd_header {
35*5113495bSYour Name              uint32_t reo_cmd_number                  : 16, //[15:0]
36*5113495bSYour Name                       reo_status_required             :  1, //[16]
37*5113495bSYour Name                       reserved_0a                     : 15; //[31:17]
38*5113495bSYour Name };
39*5113495bSYour Name 
40*5113495bSYour Name /*
41*5113495bSYour Name 
42*5113495bSYour Name reo_cmd_number
43*5113495bSYour Name 
44*5113495bSYour Name 			Consumer: REO/SW/DEBUG
45*5113495bSYour Name 
46*5113495bSYour Name 			Producer: SW
47*5113495bSYour Name 
48*5113495bSYour Name 
49*5113495bSYour Name 
50*5113495bSYour Name 			This number can be used by SW to track, identify and
51*5113495bSYour Name 			link the created commands with the command statusses
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name 
56*5113495bSYour Name 
57*5113495bSYour Name 			<legal all>
58*5113495bSYour Name 
59*5113495bSYour Name reo_status_required
60*5113495bSYour Name 
61*5113495bSYour Name 			Consumer: REO
62*5113495bSYour Name 
63*5113495bSYour Name 			Producer: SW
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name 
67*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
68*5113495bSYour Name 			TLV for the execution of this command
69*5113495bSYour Name 
70*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
71*5113495bSYour Name 			for the execution of this command
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 
75*5113495bSYour Name 			<legal all>
76*5113495bSYour Name 
77*5113495bSYour Name reserved_0a
78*5113495bSYour Name 
79*5113495bSYour Name 			<legal 0>
80*5113495bSYour Name */
81*5113495bSYour Name 
82*5113495bSYour Name 
83*5113495bSYour Name /* Description		UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER
84*5113495bSYour Name 
85*5113495bSYour Name 			Consumer: REO/SW/DEBUG
86*5113495bSYour Name 
87*5113495bSYour Name 			Producer: SW
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 			This number can be used by SW to track, identify and
92*5113495bSYour Name 			link the created commands with the command statusses
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name 			<legal all>
99*5113495bSYour Name */
100*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER_OFFSET               0x00000000
101*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER_LSB                  0
102*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER_MASK                 0x0000ffff
103*5113495bSYour Name 
104*5113495bSYour Name /* Description		UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED
105*5113495bSYour Name 
106*5113495bSYour Name 			Consumer: REO
107*5113495bSYour Name 
108*5113495bSYour Name 			Producer: SW
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
113*5113495bSYour Name 			TLV for the execution of this command
114*5113495bSYour Name 
115*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
116*5113495bSYour Name 			for the execution of this command
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 			<legal all>
121*5113495bSYour Name */
122*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED_OFFSET          0x00000000
123*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED_LSB             16
124*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED_MASK            0x00010000
125*5113495bSYour Name 
126*5113495bSYour Name /* Description		UNIFORM_REO_CMD_HEADER_0_RESERVED_0A
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal 0>
129*5113495bSYour Name */
130*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_RESERVED_0A_OFFSET                  0x00000000
131*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_RESERVED_0A_LSB                     17
132*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_0_RESERVED_0A_MASK                    0xfffe0000
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name #endif // _UNIFORM_REO_CMD_HEADER_H_
136