xref: /wlan-driver/fw-api/hw/kiwi/v2/wbm_release_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name 
2*5113495bSYour Name /*
3*5113495bSYour Name  * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name #ifndef _WBM_RELEASE_RING_H_
23*5113495bSYour Name #define _WBM_RELEASE_RING_H_
24*5113495bSYour Name #if !defined(__ASSEMBLER__)
25*5113495bSYour Name #endif
26*5113495bSYour Name 
27*5113495bSYour Name #include "buffer_addr_info.h"
28*5113495bSYour Name #define NUM_OF_DWORDS_WBM_RELEASE_RING 8
29*5113495bSYour Name 
30*5113495bSYour Name struct wbm_release_ring {
31*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
32*5113495bSYour Name              struct   buffer_addr_info                                          released_buff_or_desc_addr_info;
33*5113495bSYour Name              uint32_t release_source_module                                   :  3,
34*5113495bSYour Name                       reserved_2a                                             :  3,
35*5113495bSYour Name                       buffer_or_desc_type                                     :  3,
36*5113495bSYour Name                       reserved_2b                                             : 22,
37*5113495bSYour Name                       wbm_internal_error                                      :  1;
38*5113495bSYour Name              uint32_t reserved_3a                                             : 32;
39*5113495bSYour Name              uint32_t reserved_4a                                             : 32;
40*5113495bSYour Name              uint32_t reserved_5a                                             : 32;
41*5113495bSYour Name              uint32_t reserved_6a                                             : 32;
42*5113495bSYour Name              uint32_t reserved_7a                                             : 28,
43*5113495bSYour Name                       looping_count                                           :  4;
44*5113495bSYour Name #else
45*5113495bSYour Name              struct   buffer_addr_info                                          released_buff_or_desc_addr_info;
46*5113495bSYour Name              uint32_t wbm_internal_error                                      :  1,
47*5113495bSYour Name                       reserved_2b                                             : 22,
48*5113495bSYour Name                       buffer_or_desc_type                                     :  3,
49*5113495bSYour Name                       reserved_2a                                             :  3,
50*5113495bSYour Name                       release_source_module                                   :  3;
51*5113495bSYour Name              uint32_t reserved_3a                                             : 32;
52*5113495bSYour Name              uint32_t reserved_4a                                             : 32;
53*5113495bSYour Name              uint32_t reserved_5a                                             : 32;
54*5113495bSYour Name              uint32_t reserved_6a                                             : 32;
55*5113495bSYour Name              uint32_t looping_count                                           :  4,
56*5113495bSYour Name                       reserved_7a                                             : 28;
57*5113495bSYour Name #endif
58*5113495bSYour Name };
59*5113495bSYour Name 
60*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET    0x00000000
61*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB       0
62*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MSB       31
63*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK      0xffffffff
64*5113495bSYour Name 
65*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET   0x00000004
66*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB      0
67*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MSB      7
68*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK     0x000000ff
69*5113495bSYour Name 
70*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
71*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB  8
72*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MSB  11
73*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000f00
74*5113495bSYour Name 
75*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET    0x00000004
76*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB       12
77*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MSB       31
78*5113495bSYour Name #define WBM_RELEASE_RING_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK      0xfffff000
79*5113495bSYour Name 
80*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_OFFSET                               0x00000008
81*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_LSB                                  0
82*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_MSB                                  2
83*5113495bSYour Name #define WBM_RELEASE_RING_RELEASE_SOURCE_MODULE_MASK                                 0x00000007
84*5113495bSYour Name 
85*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_OFFSET                                         0x00000008
86*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_LSB                                            3
87*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_MSB                                            5
88*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2A_MASK                                           0x00000038
89*5113495bSYour Name 
90*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_OFFSET                                 0x00000008
91*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_LSB                                    6
92*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_MSB                                    8
93*5113495bSYour Name #define WBM_RELEASE_RING_BUFFER_OR_DESC_TYPE_MASK                                   0x000001c0
94*5113495bSYour Name 
95*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_OFFSET                                         0x00000008
96*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_LSB                                            9
97*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_MSB                                            30
98*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_2B_MASK                                           0x7ffffe00
99*5113495bSYour Name 
100*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_OFFSET                                  0x00000008
101*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_LSB                                     31
102*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_MSB                                     31
103*5113495bSYour Name #define WBM_RELEASE_RING_WBM_INTERNAL_ERROR_MASK                                    0x80000000
104*5113495bSYour Name 
105*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_OFFSET                                         0x0000000c
106*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_LSB                                            0
107*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_MSB                                            31
108*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_3A_MASK                                           0xffffffff
109*5113495bSYour Name 
110*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_OFFSET                                         0x00000010
111*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_LSB                                            0
112*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_MSB                                            31
113*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_4A_MASK                                           0xffffffff
114*5113495bSYour Name 
115*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_OFFSET                                         0x00000014
116*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_LSB                                            0
117*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_MSB                                            31
118*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_5A_MASK                                           0xffffffff
119*5113495bSYour Name 
120*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_OFFSET                                         0x00000018
121*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_LSB                                            0
122*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_MSB                                            31
123*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_6A_MASK                                           0xffffffff
124*5113495bSYour Name 
125*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_OFFSET                                         0x0000001c
126*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_LSB                                            0
127*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_MSB                                            27
128*5113495bSYour Name #define WBM_RELEASE_RING_RESERVED_7A_MASK                                           0x0fffffff
129*5113495bSYour Name 
130*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_OFFSET                                       0x0000001c
131*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_LSB                                          28
132*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_MSB                                          31
133*5113495bSYour Name #define WBM_RELEASE_RING_LOOPING_COUNT_MASK                                         0xf0000000
134*5113495bSYour Name 
135*5113495bSYour Name #endif
136