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