xref: /wlan-driver/fw-api/hw/qca5332/uniform_reo_cmd_header.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. 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 
18 
19 
20 
21 
22 
23 
24 
25 
26 #ifndef _UNIFORM_REO_CMD_HEADER_H_
27 #define _UNIFORM_REO_CMD_HEADER_H_
28 #if !defined(__ASSEMBLER__)
29 #endif
30 
31 #define NUM_OF_DWORDS_UNIFORM_REO_CMD_HEADER 1
32 
33 
34 struct uniform_reo_cmd_header {
35 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36              uint32_t reo_cmd_number                                          : 16, // [15:0]
37                       reo_status_required                                     :  1, // [16:16]
38                       reserved_0a                                             : 15; // [31:17]
39 #else
40              uint32_t reserved_0a                                             : 15, // [31:17]
41                       reo_status_required                                     :  1, // [16:16]
42                       reo_cmd_number                                          : 16; // [15:0]
43 #endif
44 };
45 
46 
47 /* Description		REO_CMD_NUMBER
48 
49 			Consumer: REO/SW/DEBUG
50 			Producer: SW
51 
52 			This number can be used by SW to track, identify and link
53 			 the created commands with the command statusses
54 
55 
56 			<legal all>
57 */
58 
59 #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_OFFSET                                0x00000000
60 #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_LSB                                   0
61 #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_MSB                                   15
62 #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_MASK                                  0x0000ffff
63 
64 
65 /* Description		REO_STATUS_REQUIRED
66 
67 			Consumer: REO
68 			Producer: SW
69 
70 			<enum 0 NoStatus> REO does not need to generate a status
71 			 TLV for the execution of this command
72 			<enum 1 StatusRequired> REO shall generate a status TLV
73 			for the execution of this command
74 
75 			<legal all>
76 */
77 
78 #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET                           0x00000000
79 #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_LSB                              16
80 #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_MSB                              16
81 #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_MASK                             0x00010000
82 
83 
84 /* Description		RESERVED_0A
85 
86 			<legal 0>
87 */
88 
89 #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_OFFSET                                   0x00000000
90 #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_LSB                                      17
91 #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_MSB                                      31
92 #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_MASK                                     0xfffe0000
93 
94 
95 
96 #endif   // UNIFORM_REO_CMD_HEADER
97