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