xref: /wlan-driver/fw-api/hw/kiwi/v2/ce_src_desc.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 
2 /*
3  * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 
21 
22 #ifndef _CE_SRC_DESC_H_
23 #define _CE_SRC_DESC_H_
24 #if !defined(__ASSEMBLER__)
25 #endif
26 
27 #define NUM_OF_DWORDS_CE_SRC_DESC 4
28 
29 struct ce_src_desc {
30 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
31              uint32_t src_buffer_low                                          : 32;
32              uint32_t src_buffer_high                                         :  8,
33                       toeplitz_en                                             :  1,
34                       src_swap                                                :  1,
35                       dest_swap                                               :  1,
36                       gather                                                  :  1,
37                       ce_res_0                                                :  1,
38                       barrier_read                                            :  1,
39                       ce_res_1                                                :  2,
40                       length                                                  : 16;
41              uint32_t fw_metadata                                             : 16,
42                       ce_res_2                                                : 16;
43              uint32_t ce_res_3                                                : 20,
44                       ring_id                                                 :  8,
45                       looping_count                                           :  4;
46 #else
47              uint32_t src_buffer_low                                          : 32;
48              uint32_t length                                                  : 16,
49                       ce_res_1                                                :  2,
50                       barrier_read                                            :  1,
51                       ce_res_0                                                :  1,
52                       gather                                                  :  1,
53                       dest_swap                                               :  1,
54                       src_swap                                                :  1,
55                       toeplitz_en                                             :  1,
56                       src_buffer_high                                         :  8;
57              uint32_t ce_res_2                                                : 16,
58                       fw_metadata                                             : 16;
59              uint32_t looping_count                                           :  4,
60                       ring_id                                                 :  8,
61                       ce_res_3                                                : 20;
62 #endif
63 };
64 
65 #define CE_SRC_DESC_SRC_BUFFER_LOW_OFFSET                                           0x00000000
66 #define CE_SRC_DESC_SRC_BUFFER_LOW_LSB                                              0
67 #define CE_SRC_DESC_SRC_BUFFER_LOW_MSB                                              31
68 #define CE_SRC_DESC_SRC_BUFFER_LOW_MASK                                             0xffffffff
69 
70 #define CE_SRC_DESC_SRC_BUFFER_HIGH_OFFSET                                          0x00000004
71 #define CE_SRC_DESC_SRC_BUFFER_HIGH_LSB                                             0
72 #define CE_SRC_DESC_SRC_BUFFER_HIGH_MSB                                             7
73 #define CE_SRC_DESC_SRC_BUFFER_HIGH_MASK                                            0x000000ff
74 
75 #define CE_SRC_DESC_TOEPLITZ_EN_OFFSET                                              0x00000004
76 #define CE_SRC_DESC_TOEPLITZ_EN_LSB                                                 8
77 #define CE_SRC_DESC_TOEPLITZ_EN_MSB                                                 8
78 #define CE_SRC_DESC_TOEPLITZ_EN_MASK                                                0x00000100
79 
80 #define CE_SRC_DESC_SRC_SWAP_OFFSET                                                 0x00000004
81 #define CE_SRC_DESC_SRC_SWAP_LSB                                                    9
82 #define CE_SRC_DESC_SRC_SWAP_MSB                                                    9
83 #define CE_SRC_DESC_SRC_SWAP_MASK                                                   0x00000200
84 
85 #define CE_SRC_DESC_DEST_SWAP_OFFSET                                                0x00000004
86 #define CE_SRC_DESC_DEST_SWAP_LSB                                                   10
87 #define CE_SRC_DESC_DEST_SWAP_MSB                                                   10
88 #define CE_SRC_DESC_DEST_SWAP_MASK                                                  0x00000400
89 
90 #define CE_SRC_DESC_GATHER_OFFSET                                                   0x00000004
91 #define CE_SRC_DESC_GATHER_LSB                                                      11
92 #define CE_SRC_DESC_GATHER_MSB                                                      11
93 #define CE_SRC_DESC_GATHER_MASK                                                     0x00000800
94 
95 #define CE_SRC_DESC_CE_RES_0_OFFSET                                                 0x00000004
96 #define CE_SRC_DESC_CE_RES_0_LSB                                                    12
97 #define CE_SRC_DESC_CE_RES_0_MSB                                                    12
98 #define CE_SRC_DESC_CE_RES_0_MASK                                                   0x00001000
99 
100 #define CE_SRC_DESC_BARRIER_READ_OFFSET                                             0x00000004
101 #define CE_SRC_DESC_BARRIER_READ_LSB                                                13
102 #define CE_SRC_DESC_BARRIER_READ_MSB                                                13
103 #define CE_SRC_DESC_BARRIER_READ_MASK                                               0x00002000
104 
105 #define CE_SRC_DESC_CE_RES_1_OFFSET                                                 0x00000004
106 #define CE_SRC_DESC_CE_RES_1_LSB                                                    14
107 #define CE_SRC_DESC_CE_RES_1_MSB                                                    15
108 #define CE_SRC_DESC_CE_RES_1_MASK                                                   0x0000c000
109 
110 #define CE_SRC_DESC_LENGTH_OFFSET                                                   0x00000004
111 #define CE_SRC_DESC_LENGTH_LSB                                                      16
112 #define CE_SRC_DESC_LENGTH_MSB                                                      31
113 #define CE_SRC_DESC_LENGTH_MASK                                                     0xffff0000
114 
115 #define CE_SRC_DESC_FW_METADATA_OFFSET                                              0x00000008
116 #define CE_SRC_DESC_FW_METADATA_LSB                                                 0
117 #define CE_SRC_DESC_FW_METADATA_MSB                                                 15
118 #define CE_SRC_DESC_FW_METADATA_MASK                                                0x0000ffff
119 
120 #define CE_SRC_DESC_CE_RES_2_OFFSET                                                 0x00000008
121 #define CE_SRC_DESC_CE_RES_2_LSB                                                    16
122 #define CE_SRC_DESC_CE_RES_2_MSB                                                    31
123 #define CE_SRC_DESC_CE_RES_2_MASK                                                   0xffff0000
124 
125 #define CE_SRC_DESC_CE_RES_3_OFFSET                                                 0x0000000c
126 #define CE_SRC_DESC_CE_RES_3_LSB                                                    0
127 #define CE_SRC_DESC_CE_RES_3_MSB                                                    19
128 #define CE_SRC_DESC_CE_RES_3_MASK                                                   0x000fffff
129 
130 #define CE_SRC_DESC_RING_ID_OFFSET                                                  0x0000000c
131 #define CE_SRC_DESC_RING_ID_LSB                                                     20
132 #define CE_SRC_DESC_RING_ID_MSB                                                     27
133 #define CE_SRC_DESC_RING_ID_MASK                                                    0x0ff00000
134 
135 #define CE_SRC_DESC_LOOPING_COUNT_OFFSET                                            0x0000000c
136 #define CE_SRC_DESC_LOOPING_COUNT_LSB                                               28
137 #define CE_SRC_DESC_LOOPING_COUNT_MSB                                               31
138 #define CE_SRC_DESC_LOOPING_COUNT_MASK                                              0xf0000000
139 
140 #endif
141