xref: /wlan-driver/fw-api/hw/qca6290/11ax/v1/wbm_buffer_ring.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _WBM_BUFFER_RING_H_
20*5113495bSYour Name #define _WBM_BUFFER_RING_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "buffer_addr_info.h"
25*5113495bSYour Name 
26*5113495bSYour Name // ################ START SUMMARY #################
27*5113495bSYour Name //
28*5113495bSYour Name //	Dword	Fields
29*5113495bSYour Name //	0-1	struct buffer_addr_info buf_addr_info;
30*5113495bSYour Name //
31*5113495bSYour Name // ################ END SUMMARY #################
32*5113495bSYour Name 
33*5113495bSYour Name #define NUM_OF_DWORDS_WBM_BUFFER_RING 2
34*5113495bSYour Name 
35*5113495bSYour Name struct wbm_buffer_ring {
36*5113495bSYour Name     struct            buffer_addr_info                       buf_addr_info;
37*5113495bSYour Name };
38*5113495bSYour Name 
39*5113495bSYour Name /*
40*5113495bSYour Name 
41*5113495bSYour Name struct buffer_addr_info buf_addr_info
42*5113495bSYour Name 
43*5113495bSYour Name 			Consumer: WBM
44*5113495bSYour Name 
45*5113495bSYour Name 			Producer: WBM
46*5113495bSYour Name 
47*5113495bSYour Name 
48*5113495bSYour Name 
49*5113495bSYour Name 			Details of the physical address of the buffer + source
50*5113495bSYour Name 			buffer owner +  some SW meta data.
51*5113495bSYour Name 
52*5113495bSYour Name 			All modules getting this buffer address info, shall keep
53*5113495bSYour Name 			all the 64 bits of info in this descriptor together and
54*5113495bSYour Name 			eventually all 64 bits shall be given back to WMB when the
55*5113495bSYour Name 			buffer is released.
56*5113495bSYour Name */
57*5113495bSYour Name 
58*5113495bSYour Name #define WBM_BUFFER_RING_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_OFFSET      0x00000000
59*5113495bSYour Name #define WBM_BUFFER_RING_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_LSB         0
60*5113495bSYour Name #define WBM_BUFFER_RING_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_MASK        0xffffffff
61*5113495bSYour Name #define WBM_BUFFER_RING_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_OFFSET      0x00000004
62*5113495bSYour Name #define WBM_BUFFER_RING_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_LSB         0
63*5113495bSYour Name #define WBM_BUFFER_RING_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_MASK        0xffffffff
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name #endif // _WBM_BUFFER_RING_H_
67