xref: /wlan-driver/fw-api/hw/peach/v1/rx_frame_bitmap_req.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 
18 #ifndef _RX_FRAME_BITMAP_REQ_H_
19 #define _RX_FRAME_BITMAP_REQ_H_
20 
21 #define NUM_OF_DWORDS_RX_FRAME_BITMAP_REQ 1
22 
23 struct rx_frame_bitmap_req {
24 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
25              uint32_t explicit_user_request                                   :  1,
26                       user_request_type                                       :  1,
27                       user_number                                             :  6,
28                       sw_peer_id                                              : 16,
29                       tid_specific_request                                    :  1,
30                       requested_tid                                           :  4,
31                       reserved_0                                              :  3;
32 #else
33              uint32_t reserved_0                                              :  3,
34                       requested_tid                                           :  4,
35                       tid_specific_request                                    :  1,
36                       sw_peer_id                                              : 16,
37                       user_number                                             :  6,
38                       user_request_type                                       :  1,
39                       explicit_user_request                                   :  1;
40 #endif
41 };
42 
43 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_OFFSET                            0x00000000
44 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_LSB                               0
45 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_MSB                               0
46 #define RX_FRAME_BITMAP_REQ_EXPLICIT_USER_REQUEST_MASK                              0x00000001
47 
48 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_OFFSET                                0x00000000
49 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_LSB                                   1
50 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_MSB                                   1
51 #define RX_FRAME_BITMAP_REQ_USER_REQUEST_TYPE_MASK                                  0x00000002
52 
53 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_OFFSET                                      0x00000000
54 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_LSB                                         2
55 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_MSB                                         7
56 #define RX_FRAME_BITMAP_REQ_USER_NUMBER_MASK                                        0x000000fc
57 
58 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_OFFSET                                       0x00000000
59 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_LSB                                          8
60 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_MSB                                          23
61 #define RX_FRAME_BITMAP_REQ_SW_PEER_ID_MASK                                         0x00ffff00
62 
63 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_OFFSET                             0x00000000
64 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_LSB                                24
65 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_MSB                                24
66 #define RX_FRAME_BITMAP_REQ_TID_SPECIFIC_REQUEST_MASK                               0x01000000
67 
68 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_OFFSET                                    0x00000000
69 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_LSB                                       25
70 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_MSB                                       28
71 #define RX_FRAME_BITMAP_REQ_REQUESTED_TID_MASK                                      0x1e000000
72 
73 #define RX_FRAME_BITMAP_REQ_RESERVED_0_OFFSET                                       0x00000000
74 #define RX_FRAME_BITMAP_REQ_RESERVED_0_LSB                                          29
75 #define RX_FRAME_BITMAP_REQ_RESERVED_0_MSB                                          31
76 #define RX_FRAME_BITMAP_REQ_RESERVED_0_MASK                                         0xe0000000
77 
78 #endif
79