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