xref: /wlan-driver/fw-api/hw/peach/v2/wbm_release_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023-2024 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 #ifndef _WBM_RELEASE_RING_H_
19*5113495bSYour Name #define _WBM_RELEASE_RING_H_
20*5113495bSYour Name 
21*5113495bSYour Name #include "buffer_addr_info.h"
22*5113495bSYour Name #define NUM_OF_DWORDS_WBM_RELEASE_RING 8
23*5113495bSYour Name 
24*5113495bSYour Name struct wbm_release_ring {
25*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
26*5113495bSYour Name              struct   buffer_addr_info                                          released_buff_or_desc_addr_info;
27*5113495bSYour Name              uint32_t release_source_module                                   :  3,
28*5113495bSYour Name                       reserved_2a                                             :  3,
29*5113495bSYour Name                       buffer_or_desc_type                                     :  3,
30*5113495bSYour Name                       reserved_2b                                             : 22,
31*5113495bSYour Name                       wbm_internal_error                                      :  1;
32*5113495bSYour Name              uint32_t reserved_3a                                             : 32;
33*5113495bSYour Name              uint32_t reserved_4a                                             : 32;
34*5113495bSYour Name              uint32_t reserved_5a                                             : 32;
35*5113495bSYour Name              uint32_t reserved_6a                                             : 32;
36*5113495bSYour Name              uint32_t reserved_7a                                             : 28,
37*5113495bSYour Name                       looping_count                                           :  4;
38*5113495bSYour Name #else
39*5113495bSYour Name              struct   buffer_addr_info                                          released_buff_or_desc_addr_info;
40*5113495bSYour Name              uint32_t wbm_internal_error                                      :  1,
41*5113495bSYour Name                       reserved_2b                                             : 22,
42*5113495bSYour Name                       buffer_or_desc_type                                     :  3,
43*5113495bSYour Name                       reserved_2a                                             :  3,
44*5113495bSYour Name                       release_source_module                                   :  3;
45*5113495bSYour Name              uint32_t reserved_3a                                             : 32;
46*5113495bSYour Name              uint32_t reserved_4a                                             : 32;
47*5113495bSYour Name              uint32_t reserved_5a                                             : 32;
48*5113495bSYour Name              uint32_t reserved_6a                                             : 32;
49*5113495bSYour Name              uint32_t looping_count                                           :  4,
50*5113495bSYour Name                       reserved_7a                                             : 28;
51*5113495bSYour Name #endif
52*5113495bSYour Name };
53*5113495bSYour Name 
54*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET    0x00000000
55*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB       0
56*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MSB       31
57*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK      0xffffffff
58*5113495bSYour Name 
59*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET   0x00000004
60*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB      0
61*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MSB      7
62*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK     0x000000ff
63*5113495bSYour Name 
64*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
65*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB  8
66*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MSB  11
67*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000f00
68*5113495bSYour Name 
69*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET    0x00000004
70*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB       12
71*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MSB       31
72*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK      0xfffff000
73*5113495bSYour Name 
74*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_OFFSET                               0x00000008
75*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_LSB                                  0
76*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_MSB                                  2
77*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_MASK                                 0x00000007
78*5113495bSYour Name 
79*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_OFFSET                                         0x00000008
80*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_LSB                                            3
81*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_MSB                                            5
82*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_MASK                                           0x00000038
83*5113495bSYour Name 
84*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_OFFSET                                 0x00000008
85*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_LSB                                    6
86*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_MSB                                    8
87*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_MASK                                   0x000001c0
88*5113495bSYour Name 
89*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_OFFSET                                         0x00000008
90*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_LSB                                            9
91*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_MSB                                            30
92*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_MASK                                           0x7ffffe00
93*5113495bSYour Name 
94*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_OFFSET                                  0x00000008
95*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_LSB                                     31
96*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_MSB                                     31
97*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_MASK                                    0x80000000
98*5113495bSYour Name 
99*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_OFFSET                                         0x0000000c
100*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_LSB                                            0
101*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_MSB                                            31
102*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_MASK                                           0xffffffff
103*5113495bSYour Name 
104*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_OFFSET                                         0x00000010
105*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_LSB                                            0
106*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_MSB                                            31
107*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_MASK                                           0xffffffff
108*5113495bSYour Name 
109*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_OFFSET                                         0x00000014
110*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_LSB                                            0
111*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_MSB                                            31
112*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_MASK                                           0xffffffff
113*5113495bSYour Name 
114*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_OFFSET                                         0x00000018
115*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_LSB                                            0
116*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_MSB                                            31
117*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_MASK                                           0xffffffff
118*5113495bSYour Name 
119*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_OFFSET                                         0x0000001c
120*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_LSB                                            0
121*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_MSB                                            27
122*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_MASK                                           0x0fffffff
123*5113495bSYour Name 
124*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_OFFSET                                       0x0000001c
125*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_LSB                                          28
126*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_MSB                                          31
127*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_MASK                                         0xf0000000
128*5113495bSYour Name 
129*5113495bSYour Name #endif
130