1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/*
* Copyright 2008-2012 Freescale Semiconductor Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Freescale Semiconductor nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
*
* ALTERNATIVELY, this software may be distributed under the terms of the
* GNU General Public License ("GPL") as published by the Free Software
* Foundation, either version 2 of that License or (at your option) any
* later version.
*
* THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/******************************************************************************
@File fsl_fman.h
@Description Linux internal kernel API
*//***************************************************************************/
#ifndef __FSL_FMAN_H
#define __FSL_FMAN_H
#include <linux/types.h>
#include <linux/device.h> /* struct device */
#include <linux/fsl_qman.h> /* struct qman_fq */
#include "dpaa_integration_ext.h"
#include "fm_port_ext.h"
/**************************************************************************//**
@Group FM_LnxKern_grp Frame Manager Linux wrapper API
@Description FM API functions, definitions and enums.
@{
*//***************************************************************************/
/**************************************************************************//**
@Group FM_LnxKern_ctrl_grp Control Unit
@Description Control Unit
Internal Kernel Control Unit API
@{
*//***************************************************************************/
/*****************************************************************************/
/* Internal Linux kernel routines */
/*****************************************************************************/
/**************************************************************************//**
@Description A structure ..,
*//***************************************************************************/
struct fm;
/**************************************************************************//**
@Description A structure ..,
*//***************************************************************************/
struct fm_port;
typedef int (*alloc_pcd_fqids)(struct device *dev, uint32_t num,
uint8_t alignment, uint32_t *base_fqid);
typedef int (*free_pcd_fqids)(struct device *dev, uint32_t base_fqid);
struct fm_port_pcd_param {
alloc_pcd_fqids cba;
free_pcd_fqids cbf;
struct device *dev;
};
/**************************************************************************//**
@Description A structure of information about each of the external
buffer pools used by the port,
*//***************************************************************************/
struct fm_port_pool_param {
uint8_t id; /**< External buffer pool id */
uint16_t size; /**< External buffer pool buffer size */
};
/**************************************************************************//**
@Description structure for additional port parameters
*//***************************************************************************/
struct fm_port_params {
uint32_t errq; /**< Error Queue Id. */
uint32_t defq; /**< For Tx and HC - Default Confirmation queue,
0 means no Tx conf for processed frames.
For Rx and OP - default Rx queue. */
uint8_t num_pools; /**< Number of pools use by this port */
struct fm_port_pool_param pool_param[FM_PORT_MAX_NUM_OF_EXT_POOLS];
/**< Parameters for each pool */
uint16_t priv_data_size; /**< Area that user may save for his own
need (E.g. save the SKB) */
bool parse_results; /**< Put the parser-results in the Rx/Tx buffer */
bool hash_results; /**< Put the hash-results in the Rx/Tx buffer */
bool time_stamp; /**< Put the time-stamp in the Rx/Tx buffer */
bool frag_enable; /**< Fragmentation support, for OP only */
uint16_t data_align; /**< value for selecting a data alignment (must be a power of 2);
if write optimization is used, must be >= 16. */
uint8_t manip_extra_space; /**< Maximum extra size needed (insertion-size minus removal-size);
Note that this field impacts the size of the buffer-prefix
(i.e. it pushes the data offset); */
};
/**************************************************************************//**
@Function fm_bind
@Description Bind to a specific FM device.
@Param[in] fm_dev - the OF handle of the FM device.
@Return A handle of the FM device.
@Cautions Allowed only after the port was created.
*//***************************************************************************/
struct fm *fm_bind(struct device *fm_dev);
/**************************************************************************//**
@Function fm_unbind
@Description Un-bind from a specific FM device.
@Param[in] fm - A handle of the FM device.
@Cautions Allowed only after the port was created.
*//***************************************************************************/
void fm_unbind(struct fm *fm);
void *fm_get_handle(struct fm *fm);
void *fm_get_rtc_handle(struct fm *fm);
struct resource *fm_get_mem_region(struct fm *fm);
/**************************************************************************//**
@Function fm_port_bind
@Description Bind to a specific FM-port device (may be Rx or Tx port).
@Param[in] fm_port_dev - the OF handle of the FM port device.
@Return A handle of the FM port device.
@Cautions Allowed only after the port was created.
*//***************************************************************************/
struct fm_port *fm_port_bind(struct device *fm_port_dev);
/**************************************************************************//**
@Function fm_port_unbind
@Description Un-bind from a specific FM-port device (may be Rx or Tx port).
@Param[in] port - A handle of the FM port device.
@Cautions Allowed only after the port was created.
*//***************************************************************************/
void fm_port_unbind(struct fm_port *port);
/**************************************************************************//**
@Function fm_set_rx_port_params
@Description Configure parameters for a specific Rx FM-port device.
@Param[in] port - A handle of the FM port device.
@Param[in] params - Rx port parameters
@Cautions Allowed only after the port is binded.
*//***************************************************************************/
void fm_set_rx_port_params(struct fm_port *port,
struct fm_port_params *params);
/**************************************************************************//**
@Function fm_port_pcd_bind
@Description Bind as a listener on a port PCD.
@Param[in] port - A handle of the FM port device.
@Param[in] params - PCD port parameters
@Cautions Allowed only after the port is binded.
*//***************************************************************************/
void fm_port_pcd_bind (struct fm_port *port, struct fm_port_pcd_param *params);
/**************************************************************************//**
@Function fm_port_get_buff_layout_ext_params
@Description Get data_align and manip_extra_space from the device tree
chosen node if aplied.
This function will only update these two parameters.
When this port has no such parameters in the device tree
values will be set to 0.
@Param[in] port - A handle of the FM port device.
@Param[in] params - PCD port parameters
@Cautions Allowed only after the port is binded.
*//***************************************************************************/
void fm_port_get_buff_layout_ext_params(struct fm_port *port, struct fm_port_params *params);
/**************************************************************************//**
@Function fm_get_tx_port_channel
@Description Get qman-channel number for this Tx port.
@Param[in] port - A handle of the FM port device.
@Return qman-channel number for this Tx port.
@Cautions Allowed only after the port is binded.
*//***************************************************************************/
int fm_get_tx_port_channel(struct fm_port *port);
/**************************************************************************//**
@Function fm_set_tx_port_params
@Description Configure parameters for a specific Tx FM-port device
@Param[in] port - A handle of the FM port device.
@Param[in] params - Tx port parameters
@Cautions Allowed only after the port is binded.
*//***************************************************************************/
void fm_set_tx_port_params(struct fm_port *port, struct fm_port_params *params);
/**************************************************************************//**
@Function fm_mac_set_handle
@Description Set mac handle
@Param[in] h_lnx_wrp_fm_dev - A handle of the LnxWrp FM device.
@Param[in] h_fm_mac - A handle of the LnxWrp FM MAC device.
@Param[in] mac_id - MAC id.
*//***************************************************************************/
void fm_mac_set_handle(t_Handle h_lnx_wrp_fm_dev, t_Handle h_fm_mac,
int mac_id);
/**************************************************************************//**
@Function fm_port_enable
@Description Enable specific FM-port device (may be Rx or Tx port).
@Param[in] port - A handle of the FM port device.
@Cautions Allowed only after the port is initialized.
*//***************************************************************************/
int fm_port_enable(struct fm_port *port);
/**************************************************************************//**
@Function fm_port_disable
@Description Disable specific FM-port device (may be Rx or Tx port).
@Param[in] port - A handle of the FM port device.
@Cautions Allowed only after the port is initialized.
*//***************************************************************************/
void fm_port_disable(struct fm_port *port);
void *fm_port_get_handle(struct fm_port *port);
/**************************************************************************//**
@Function fm_port_get_base_address
@Description Get base address of this port. Useful for accessing
port-specific registers (i.e., not common ones).
@Param[in] port - A handle of the FM port device.
@Param[out] base_addr - The port's base addr (virtual address).
*//***************************************************************************/
void fm_port_get_base_addr(const struct fm_port *port, uint64_t *base_addr);
/**************************************************************************//**
@Function fm_mutex_lock
@Description Lock function required before any FMD/LLD call.
*//***************************************************************************/
void fm_mutex_lock(void);
/**************************************************************************//**
@Function fm_mutex_unlock
@Description Unlock function required after any FMD/LLD call.
*//***************************************************************************/
void fm_mutex_unlock(void);
/**************************************************************************//**
@Function fm_get_max_frm
@Description Get the maximum frame size
*//***************************************************************************/
int fm_get_max_frm(void);
/**************************************************************************//**
@Function fm_get_rx_extra_headroom
@Description Get the extra headroom size
*//***************************************************************************/
int fm_get_rx_extra_headroom(void);
/**************************************************************************//**
@Function fm_port_set_rate_limit
@Description Configure Shaper parameter on FM-port device (Tx port).
@Param[in] port - A handle of the FM port device.
@Param[in] max_burst_size - Value of maximum burst size allowed.
@Param[in] rate_limit - The required rate value.
@Cautions Allowed only after the port is initialized.
*//***************************************************************************/
int fm_port_set_rate_limit(struct fm_port *port,
uint16_t max_burst_size,
uint32_t rate_limit);
/**************************************************************************//**
@Function fm_port_set_rate_limit
@Description Delete Shaper configuration on FM-port device (Tx port).
@Param[in] port - A handle of the FM port device.
@Cautions Allowed only after the port is initialized.
*//***************************************************************************/
int fm_port_del_rate_limit(struct fm_port *port);
/** @} */ /* end of FM_LnxKern_ctrl_grp group */
/** @} */ /* end of FM_LnxKern_grp group */
#endif /* __FSL_FMAN_H */
|
