1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2010-2012 Freescale Semiconductor, Inc.
5 * Copyright 2019-2020 NXP
15 #include <rte_ethdev_driver.h>
16 #include <rte_ether.h>
19 #include <dpaa_list.h>
21 #ifndef FMAN_DEVICE_PATH
22 #define FMAN_DEVICE_PATH "/dev/mem"
25 #define MEMAC_NUM_OF_PADDRS 7 /* Num of additional exact match MAC adr regs */
27 /* Control and Configuration Register (COMMAND_CONFIG) for MEMAC */
28 #define CMD_CFG_LOOPBACK_EN 0x00000400
29 /**< 21 XGMII/GMII loopback enable */
30 #define CMD_CFG_PROMIS_EN 0x00000010
31 /**< 27 Promiscuous operation enable */
32 #define CMD_CFG_PAUSE_IGNORE 0x00000100
33 /**< 23 Ignore Pause frame quanta */
35 /* Statistics Configuration Register (STATN_CONFIG) */
36 #define STATS_CFG_CLR 0x00000004
37 /**< 29 Reset all counters */
38 #define STATS_CFG_CLR_ON_RD 0x00000002
39 /**< 30 Clear on read */
40 #define STATS_CFG_SATURATE 0x00000001
41 /**< 31 Saturate at the maximum val */
43 /**< Max receive frame length mask */
44 #define MAXFRM_SIZE_MEMAC 0x00007fe0
45 #define MAXFRM_RX_MASK 0x0000ffff
47 /**< Interface Mode Register Register for MEMAC */
48 #define IF_MODE_RLP 0x00000820
51 #define FMAN_PORT_MAX_EXT_POOLS_NUM 8
52 #define FMAN_PORT_OBS_EXT_POOLS_NUM 2
54 #define FMAN_PORT_CG_MAP_NUM 8
55 #define FMAN_PORT_PRS_RESULT_WORDS_NUM 8
56 #define FMAN_PORT_BMI_FIFO_UNITS 0x100
57 #define FMAN_PORT_IC_OFFSET_UNITS 0x10
59 #define FMAN_ENABLE_BPOOL_DEPLETION 0xF00000F0
61 #define HASH_CTRL_MCAST_EN 0x00000100
62 #define GROUP_ADDRESS 0x0000010000000000LL
63 #define HASH_CTRL_ADDR_MASK 0x0000003F
65 /* Pre definitions of FMAN interface and Bpool structures */
68 /* Lists of fman interfaces and bpools */
69 TAILQ_HEAD(rte_fman_if_list, __fman_if);
71 /* Represents the different flavour of network interface */
80 uint32_t mac_addr_l; /**< Lower 32 bits of 48-bit MAC address */
81 uint32_t mac_addr_u; /**< Upper 16 bits of 48-bit MAC address */
85 /* General Control and Status */
87 uint32_t command_config; /**< 0x008 Ctrl and cfg */
88 struct mac_addr mac_addr0; /**< 0x00C-0x010 MAC_ADDR_0...1 */
89 uint32_t maxfrm; /**< 0x014 Max frame length */
91 uint32_t hashtable_ctrl; /**< 0x02C Hash table control */
93 uint32_t ievent; /**< 0x040 Interrupt event */
94 uint32_t tx_ipg_length;
95 /**< 0x044 Transmitter inter-packet-gap */
97 uint32_t imask; /**< 0x04C Interrupt mask */
99 uint32_t pause_quanta[4]; /**< 0x054 Pause quanta */
100 uint32_t pause_thresh[4]; /**< 0x064 Pause quanta threshold */
101 uint32_t rx_pause_status; /**< 0x074 Receive pause status */
103 struct mac_addr mac_addr[MEMAC_NUM_OF_PADDRS];
104 /**< 0x80-0x0B4 mac padr */
105 uint32_t lpwake_timer;
106 /**< 0x0B8 Low Power Wakeup Timer */
107 uint32_t sleep_timer;
108 /**< 0x0BC Transmit EEE Low Power Timer */
110 uint32_t statn_config;
111 /**< 0x0E0 Statistics configuration */
113 /* Rx Statistics Counter */
114 uint32_t reoct_l; /**<Rx Eth Octets Counter */
116 uint32_t roct_l; /**<Rx Octet Counters */
118 uint32_t raln_l; /**<Rx Alignment Error Counter */
120 uint32_t rxpf_l; /**<Rx valid Pause Frame */
122 uint32_t rfrm_l; /**<Rx Frame counter */
124 uint32_t rfcs_l; /**<Rx frame check seq error */
126 uint32_t rvlan_l; /**<Rx Vlan Frame Counter */
128 uint32_t rerr_l; /**<Rx Frame error */
130 uint32_t ruca_l; /**<Rx Unicast */
132 uint32_t rmca_l; /**<Rx Multicast */
134 uint32_t rbca_l; /**<Rx Broadcast */
136 uint32_t rdrp_l; /**<Rx Dropper Packet */
138 uint32_t rpkt_l; /**<Rx packet */
140 uint32_t rund_l; /**<Rx undersized packets */
142 uint32_t r64_l; /**<Rx 64 byte */
156 uint32_t rovr_l; /**<Rx oversized but good */
158 uint32_t rjbr_l; /**<Rx oversized with bad csum */
160 uint32_t rfrg_l; /**<Rx fragment Packet */
162 uint32_t rcnp_l; /**<Rx control packets (0x8808 */
164 uint32_t rdrntp_l; /**<Rx dropped due to FIFO overflow */
166 uint32_t res01d0[12];
167 /* Tx Statistics Counter */
168 uint32_t teoct_l; /**<Tx eth octets */
170 uint32_t toct_l; /**<Tx Octets */
173 uint32_t txpf_l; /**<Tx valid pause frame */
175 uint32_t tfrm_l; /**<Tx frame counter */
177 uint32_t tfcs_l; /**<Tx FCS error */
179 uint32_t tvlan_l; /**<Tx Vlan Frame */
181 uint32_t terr_l; /**<Tx frame error */
183 uint32_t tuca_l; /**<Tx Unicast */
185 uint32_t tmca_l; /**<Tx Multicast */
187 uint32_t tbca_l; /**<Tx Broadcast */
190 uint32_t tpkt_l; /**<Tx Packet */
192 uint32_t tund_l; /**<Tx Undersized */
209 uint32_t tcnp_l; /**<Tx Control Packet type - 0x8808 */
211 uint32_t res02c8[14];
212 /* Line Interface Control */
213 uint32_t if_mode; /**< 0x300 Interface Mode Control */
214 uint32_t if_status; /**< 0x304 Interface Status */
215 uint32_t res0308[14];
217 uint32_t hg_config; /**< 0x340 Control and cfg */
219 uint32_t hg_pause_quanta; /**< 0x350 Pause quanta */
221 uint32_t hg_pause_thresh; /**< 0x360 Pause quanta threshold */
223 uint32_t hgrx_pause_status; /**< 0x370 Receive pause status */
224 uint32_t hg_fifos_status; /**< 0x374 fifos status */
225 uint32_t rhm; /**< 0x378 rx messages counter */
226 uint32_t thm; /**< 0x37C tx messages counter */
230 uint32_t fmbm_rcfg; /**< Rx Configuration */
231 uint32_t fmbm_rst; /**< Rx Status */
232 uint32_t fmbm_rda; /**< Rx DMA attributes*/
233 uint32_t fmbm_rfp; /**< Rx FIFO Parameters*/
234 uint32_t fmbm_rfed; /**< Rx Frame End Data*/
235 uint32_t fmbm_ricp; /**< Rx Internal Context Parameters*/
236 uint32_t fmbm_rim; /**< Rx Internal Buffer Margins*/
237 uint32_t fmbm_rebm; /**< Rx External Buffer Margins*/
238 uint32_t fmbm_rfne; /**< Rx Frame Next Engine*/
239 uint32_t fmbm_rfca; /**< Rx Frame Command Attributes.*/
240 uint32_t fmbm_rfpne; /**< Rx Frame Parser Next Engine*/
241 uint32_t fmbm_rpso; /**< Rx Parse Start Offset*/
242 uint32_t fmbm_rpp; /**< Rx Policer Profile */
243 uint32_t fmbm_rccb; /**< Rx Coarse Classification Base */
244 uint32_t fmbm_reth; /**< Rx Excessive Threshold */
245 uint32_t reserved003c[1]; /**< (0x03C 0x03F) */
246 uint32_t fmbm_rprai[FMAN_PORT_PRS_RESULT_WORDS_NUM];
247 /**< Rx Parse Results Array Init*/
248 uint32_t fmbm_rfqid; /**< Rx Frame Queue ID*/
249 uint32_t fmbm_refqid; /**< Rx Error Frame Queue ID*/
250 uint32_t fmbm_rfsdm; /**< Rx Frame Status Discard Mask*/
251 uint32_t fmbm_rfsem; /**< Rx Frame Status Error Mask*/
252 uint32_t fmbm_rfene; /**< Rx Frame Enqueue Next Engine */
253 uint32_t reserved0074[0x2]; /**< (0x074-0x07C) */
255 /**< Rx Frame Continuous Mode Next Engine */
256 uint32_t reserved0080[0x20];/**< (0x080 0x0FF) */
257 uint32_t fmbm_ebmpi[FMAN_PORT_MAX_EXT_POOLS_NUM];
258 /**< Buffer Manager pool Information-*/
259 uint32_t fmbm_acnt[FMAN_PORT_MAX_EXT_POOLS_NUM];
260 /**< Allocate Counter-*/
261 uint32_t reserved0130[8];
262 /**< 0x130/0x140 - 0x15F reserved -*/
263 uint32_t fmbm_rcgm[FMAN_PORT_CG_MAP_NUM];
264 /**< Congestion Group Map*/
265 uint32_t fmbm_mpd; /**< BM Pool Depletion */
266 uint32_t reserved0184[0x1F]; /**< (0x184 0x1FF) */
267 uint32_t fmbm_rstc; /**< Rx Statistics Counters*/
268 uint32_t fmbm_rfrc; /**< Rx Frame Counter*/
269 uint32_t fmbm_rfbc; /**< Rx Bad Frames Counter*/
270 uint32_t fmbm_rlfc; /**< Rx Large Frames Counter*/
271 uint32_t fmbm_rffc; /**< Rx Filter Frames Counter*/
272 uint32_t fmbm_rfdc; /**< Rx Frame Discard Counter*/
273 uint32_t fmbm_rfldec; /**< Rx Frames List DMA Error Counter*/
274 uint32_t fmbm_rodc; /**< Rx Out of Buffers Discard nntr*/
275 uint32_t fmbm_rbdc; /**< Rx Buffers Deallocate Counter*/
276 uint32_t reserved0224[0x17]; /**< (0x224 0x27F) */
277 uint32_t fmbm_rpc; /**< Rx Performance Counters*/
278 uint32_t fmbm_rpcp; /**< Rx Performance Count Parameters*/
279 uint32_t fmbm_rccn; /**< Rx Cycle Counter*/
280 uint32_t fmbm_rtuc; /**< Rx Tasks Utilization Counter*/
282 /**< Rx Receive Queue Utilization cntr*/
283 uint32_t fmbm_rduc; /**< Rx DMA Utilization Counter*/
284 uint32_t fmbm_rfuc; /**< Rx FIFO Utilization Counter*/
285 uint32_t fmbm_rpac; /**< Rx Pause Activation Counter*/
286 uint32_t reserved02a0[0x18]; /**< (0x2A0 0x2FF) */
287 uint32_t fmbm_rdbg; /**< Rx Debug-*/
290 struct fman_port_qmi_regs {
291 uint32_t fmqm_pnc; /**< PortID n Configuration Register */
292 uint32_t fmqm_pns; /**< PortID n Status Register */
293 uint32_t fmqm_pnts; /**< PortID n Task Status Register */
294 uint32_t reserved00c[4]; /**< 0xn00C - 0xn01B */
295 uint32_t fmqm_pnen; /**< PortID n Enqueue NIA Register */
296 uint32_t fmqm_pnetfc; /**< PortID n Enq Total Frame Counter */
297 uint32_t reserved024[2]; /**< 0xn024 - 0x02B */
298 uint32_t fmqm_pndn; /**< PortID n Dequeue NIA Register */
299 uint32_t fmqm_pndc; /**< PortID n Dequeue Config Register */
300 uint32_t fmqm_pndtfc; /**< PortID n Dequeue tot Frame cntr */
301 uint32_t fmqm_pndfdc; /**< PortID n Dequeue FQID Dflt Cntr */
302 uint32_t fmqm_pndcc; /**< PortID n Dequeue Confirm Counter */
305 /* This struct exports parameters about an Fman network interface, determined
306 * from the device-tree.
309 /* Which Fman this interface belongs to */
311 /* The type/speed of the interface */
312 enum fman_mac_type mac_type;
313 /* Boolean, set when mac type is memac */
315 /* Boolean, set when PHY is RGMII */
317 /* The index of this MAC (within the Fman it belongs to) */
319 /* The MAC address */
320 struct rte_ether_addr mac_addr;
321 /* The Qman channel to schedule Tx FQs to */
324 uint8_t base_profile_id;
325 uint8_t num_profiles;
327 uint8_t is_shared_mac;
328 /* The hard-coded FQIDs for this interface. Note: this doesn't cover
329 * the PCD nor the "Rx default" FQIDs, which are configured via FMC
330 * and its XML-based configuration.
332 uint32_t fqid_rx_def;
333 uint32_t fqid_rx_err;
334 uint32_t fqid_tx_err;
335 uint32_t fqid_tx_confirm;
337 struct list_head bpool_list;
338 /* The node for linking this interface into "fman_if_list" */
339 struct list_head node;
342 /* This struct exposes parameters for buffer pools, extracted from the network
343 * interface settings in the device tree.
345 struct fman_if_bpool {
350 /* The node for linking this bpool into fman_if::bpool_list */
351 struct list_head node;
354 /* Internal Context transfer params - FMBM_RICP*/
355 struct fman_if_ic_params {
356 /*IC offset in the packet buffer */
358 /*IC internal offset */
364 /* The exported "struct fman_if" type contains the subset of fields we want
365 * exposed. This struct is embedded in a larger "struct __fman_if" which
366 * contains the extra bits we *don't* want exposed.
370 char node_name[IF_NAME_MAX_LEN];
371 char node_path[PATH_MAX];
376 struct list_head node;
379 /* And this is the base list node that the interfaces are added to. (See
380 * fman_if_enable_all_rx() below for an example of its use.)
382 extern const struct list_head *fman_if_list;
384 extern int fman_ccsr_map_fd;
386 /* To iterate the "bpool_list" for an interface. Eg;
387 * struct fman_if *p = get_ptr_to_some_interface();
388 * struct fman_if_bpool *bp;
389 * printf("Interface uses following BPIDs;\n");
390 * fman_if_for_each_bpool(bp, p) {
391 * printf(" %d\n", bp->bpid);
395 #define fman_if_for_each_bpool(bp, __if) \
396 list_for_each_entry(bp, &(__if)->bpool_list, node)
398 #define FMAN_ERR(rc, fmt, args...) \
401 DPAA_BUS_LOG(ERR, fmt "(%d)", ##args, errno); \
404 #define FMAN_IP_REV_1 0xC30C4
405 #define FMAN_IP_REV_1_MAJOR_MASK 0x0000FF00
406 #define FMAN_IP_REV_1_MAJOR_SHIFT 8
408 #define FMAN_V3_CONTEXTA_EN_A2V 0x10000000
409 #define FMAN_V3_CONTEXTA_EN_OVOM 0x02000000
410 #define FMAN_V3_CONTEXTA_EN_EBD 0x80000000
411 #define FMAN_CONTEXTA_DIS_CHECKSUM 0x7ull
412 #define FMAN_CONTEXTA_SET_OPCODE11 0x2000000b00000000
413 extern u16 fman_ip_rev;
414 extern u32 fman_dealloc_bufs_mask_hi;
415 extern u32 fman_dealloc_bufs_mask_lo;
418 * Initialize the FMAN driver
422 * 0 for success; error OTHERWISE
427 * Teardown the FMAN driver
432 void fman_finish(void);
434 #endif /* __FMAN_H */