xref: /wlan-driver/fw-api/hw/qca6290/v1/uniform_reo_cmd_header.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 // $ATH_LICENSE_HW_HDR_C$
20 //
21 // DO NOT EDIT!  This file is automatically generated
22 //               These definitions are tied to a particular hardware layout
23 
24 
25 #ifndef _UNIFORM_REO_CMD_HEADER_H_
26 #define _UNIFORM_REO_CMD_HEADER_H_
27 #if !defined(__ASSEMBLER__)
28 #endif
29 
30 
31 // ################ START SUMMARY #################
32 //
33 //	Dword	Fields
34 //	0	reo_cmd_number[15:0], reo_status_required[16], reserved_0a[31:17]
35 //
36 // ################ END SUMMARY #################
37 
38 #define NUM_OF_DWORDS_UNIFORM_REO_CMD_HEADER 1
39 
40 struct uniform_reo_cmd_header {
41              uint32_t reo_cmd_number                  : 16, //[15:0]
42                       reo_status_required             :  1, //[16]
43                       reserved_0a                     : 15; //[31:17]
44 };
45 
46 /*
47 
48 reo_cmd_number
49 
50 			Consumer: REO/SW/DEBUG
51 
52 			Producer: SW
53 
54 
55 
56 			This number can be used by SW to track, identify and
57 			link the created commands with the command statusses
58 
59 
60 
61 
62 
63 			<legal all>
64 
65 reo_status_required
66 
67 			Consumer: REO
68 
69 			Producer: SW
70 
71 
72 
73 			<enum 0 NoStatus> REO does not need to generate a status
74 			TLV for the execution of this command
75 
76 			<enum 1 StatusRequired> REO shall generate a status TLV
77 			for the execution of this command
78 
79 
80 
81 			<legal all>
82 
83 reserved_0a
84 
85 			<legal 0>
86 */
87 
88 
89 /* Description		UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER
90 
91 			Consumer: REO/SW/DEBUG
92 
93 			Producer: SW
94 
95 
96 
97 			This number can be used by SW to track, identify and
98 			link the created commands with the command statusses
99 
100 
101 
102 
103 
104 			<legal all>
105 */
106 #define UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER_OFFSET               0x00000000
107 #define UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER_LSB                  0
108 #define UNIFORM_REO_CMD_HEADER_0_REO_CMD_NUMBER_MASK                 0x0000ffff
109 
110 /* Description		UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED
111 
112 			Consumer: REO
113 
114 			Producer: SW
115 
116 
117 
118 			<enum 0 NoStatus> REO does not need to generate a status
119 			TLV for the execution of this command
120 
121 			<enum 1 StatusRequired> REO shall generate a status TLV
122 			for the execution of this command
123 
124 
125 
126 			<legal all>
127 */
128 #define UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED_OFFSET          0x00000000
129 #define UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED_LSB             16
130 #define UNIFORM_REO_CMD_HEADER_0_REO_STATUS_REQUIRED_MASK            0x00010000
131 
132 /* Description		UNIFORM_REO_CMD_HEADER_0_RESERVED_0A
133 
134 			<legal 0>
135 */
136 #define UNIFORM_REO_CMD_HEADER_0_RESERVED_0A_OFFSET                  0x00000000
137 #define UNIFORM_REO_CMD_HEADER_0_RESERVED_0A_LSB                     17
138 #define UNIFORM_REO_CMD_HEADER_0_RESERVED_0A_MASK                    0xfffe0000
139 
140 
141 #endif // _UNIFORM_REO_CMD_HEADER_H_
142