xref: /wlan-driver/fw-api/hw/qca5332/uniform_reo_cmd_header.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for any
5*5113495bSYour Name  * purpose with or without fee is hereby granted, provided that the above
6*5113495bSYour Name  * copyright notice and this permission notice appear in all copies.
7*5113495bSYour Name  *
8*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9*5113495bSYour Name  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10*5113495bSYour Name  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11*5113495bSYour Name  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12*5113495bSYour Name  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13*5113495bSYour Name  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14*5113495bSYour Name  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*5113495bSYour Name  */
16*5113495bSYour Name 
17*5113495bSYour Name 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _UNIFORM_REO_CMD_HEADER_H_
27*5113495bSYour Name #define _UNIFORM_REO_CMD_HEADER_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_UNIFORM_REO_CMD_HEADER 1
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct uniform_reo_cmd_header {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t reo_cmd_number                                          : 16, // [15:0]
37*5113495bSYour Name                       reo_status_required                                     :  1, // [16:16]
38*5113495bSYour Name                       reserved_0a                                             : 15; // [31:17]
39*5113495bSYour Name #else
40*5113495bSYour Name              uint32_t reserved_0a                                             : 15, // [31:17]
41*5113495bSYour Name                       reo_status_required                                     :  1, // [16:16]
42*5113495bSYour Name                       reo_cmd_number                                          : 16; // [15:0]
43*5113495bSYour Name #endif
44*5113495bSYour Name };
45*5113495bSYour Name 
46*5113495bSYour Name 
47*5113495bSYour Name /* Description		REO_CMD_NUMBER
48*5113495bSYour Name 
49*5113495bSYour Name 			Consumer: REO/SW/DEBUG
50*5113495bSYour Name 			Producer: SW
51*5113495bSYour Name 
52*5113495bSYour Name 			This number can be used by SW to track, identify and link
53*5113495bSYour Name 			 the created commands with the command statusses
54*5113495bSYour Name 
55*5113495bSYour Name 
56*5113495bSYour Name 			<legal all>
57*5113495bSYour Name */
58*5113495bSYour Name 
59*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_OFFSET                                0x00000000
60*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_LSB                                   0
61*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_MSB                                   15
62*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_CMD_NUMBER_MASK                                  0x0000ffff
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name /* Description		REO_STATUS_REQUIRED
66*5113495bSYour Name 
67*5113495bSYour Name 			Consumer: REO
68*5113495bSYour Name 			Producer: SW
69*5113495bSYour Name 
70*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
71*5113495bSYour Name 			 TLV for the execution of this command
72*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
73*5113495bSYour Name 			for the execution of this command
74*5113495bSYour Name 
75*5113495bSYour Name 			<legal all>
76*5113495bSYour Name */
77*5113495bSYour Name 
78*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET                           0x00000000
79*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_LSB                              16
80*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_MSB                              16
81*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_REO_STATUS_REQUIRED_MASK                             0x00010000
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name /* Description		RESERVED_0A
85*5113495bSYour Name 
86*5113495bSYour Name 			<legal 0>
87*5113495bSYour Name */
88*5113495bSYour Name 
89*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_OFFSET                                   0x00000000
90*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_LSB                                      17
91*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_MSB                                      31
92*5113495bSYour Name #define UNIFORM_REO_CMD_HEADER_RESERVED_0A_MASK                                     0xfffe0000
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name #endif   // UNIFORM_REO_CMD_HEADER
97