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