xref: /dpdk/drivers/bus/dpaa/include/fsl_fman.h (revision 1785d9eb)
1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
2  *
3  * Copyright 2017 NXP
4  *
5  */
6 
7 #ifndef __FSL_FMAN_H
8 #define __FSL_FMAN_H
9 
10 #include <rte_compat.h>
11 
12 /* Status field in FD is updated on Rx side by FMAN with following information.
13  * Refer to field description in FM BG.
14  */
15 struct fm_status_t {
16 	unsigned int reserved0:3;
17 	unsigned int dcl4c:1; /* Don't Check L4 Checksum */
18 	unsigned int reserved1:1;
19 	unsigned int ufd:1; /* Unsupported Format */
20 	unsigned int lge:1; /* Length Error */
21 	unsigned int dme:1; /* DMA Error */
22 
23 	unsigned int reserved2:4;
24 	unsigned int fpe:1; /* Frame physical Error */
25 	unsigned int fse:1; /* Frame Size Error */
26 	unsigned int dis:1; /* Discard by Classification */
27 	unsigned int reserved3:1;
28 
29 	unsigned int eof:1; /* Key Extraction goes out of frame */
30 	unsigned int nss:1; /* No Scheme selected */
31 	unsigned int kso:1; /* Key Size Overflow */
32 	unsigned int reserved4:1;
33 	unsigned int fcl:2; /* Frame Color */
34 	unsigned int ipp:1; /* Illegal Policer Profile Selected */
35 	unsigned int flm:1; /* Frame Length Mismatch */
36 	unsigned int pte:1; /* Parser Timeout */
37 	unsigned int isp:1; /* Invalid Soft Parser Instruction */
38 	unsigned int phe:1; /* Header Error during parsing */
39 	unsigned int frdr:1; /* Frame Dropped by disabled port */
40 	unsigned int reserved5:4;
41 } __rte_packed;
42 
43 /* Set MAC address for a particular interface */
44 __rte_internal
45 int fman_if_add_mac_addr(struct fman_if *p, uint8_t *eth, uint8_t addr_num);
46 
47 /* Remove a MAC address for a particular interface */
48 __rte_internal
49 void fman_if_clear_mac_addr(struct fman_if *p, uint8_t addr_num);
50 
51 /* Get the FMAN statistics */
52 __rte_internal
53 void fman_if_stats_get(struct fman_if *p, struct rte_eth_stats *stats);
54 
55 /* Reset the FMAN statistics */
56 __rte_internal
57 void fman_if_stats_reset(struct fman_if *p);
58 
59 /* Get all of the FMAN statistics */
60 __rte_internal
61 void fman_if_stats_get_all(struct fman_if *p, uint64_t *value, int n);
62 
63 /* Set ignore pause option for a specific interface */
64 void fman_if_set_rx_ignore_pause_frames(struct fman_if *p, bool enable);
65 
66 /* Set max frame length */
67 void fman_if_conf_max_frame_len(struct fman_if *p, unsigned int max_frame_len);
68 
69 /* Enable/disable Rx promiscuous mode on specified interface */
70 __rte_internal
71 void fman_if_promiscuous_enable(struct fman_if *p);
72 __rte_internal
73 void fman_if_promiscuous_disable(struct fman_if *p);
74 
75 /* Enable/disable Rx on specific interfaces */
76 __rte_internal
77 void fman_if_enable_rx(struct fman_if *p);
78 __rte_internal
79 void fman_if_disable_rx(struct fman_if *p);
80 __rte_internal
81 int fman_if_get_rx_status(struct fman_if *p);
82 
83 /* Enable/disable loopback on specific interfaces */
84 __rte_internal
85 void fman_if_loopback_enable(struct fman_if *p);
86 __rte_internal
87 void fman_if_loopback_disable(struct fman_if *p);
88 
89 /* Set buffer pool on specific interface */
90 __rte_internal
91 void fman_if_set_bp(struct fman_if *fm_if, unsigned int num, int bpid,
92 		    size_t bufsize);
93 
94 /* Get Flow Control threshold parameters on specific interface */
95 __rte_internal
96 int fman_if_get_fc_threshold(struct fman_if *fm_if);
97 
98 /* Enable and Set Flow Control threshold parameters on specific interface */
99 __rte_internal
100 int fman_if_set_fc_threshold(struct fman_if *fm_if,
101 			u32 high_water, u32 low_water, u32 bpid);
102 
103 /* Get Flow Control pause quanta on specific interface */
104 __rte_internal
105 int fman_if_get_fc_quanta(struct fman_if *fm_if);
106 
107 /* Set Flow Control pause quanta on specific interface */
108 __rte_internal
109 int fman_if_set_fc_quanta(struct fman_if *fm_if, u16 pause_quanta);
110 
111 /* Set default error fqid on specific interface */
112 __rte_internal
113 void fman_if_set_err_fqid(struct fman_if *fm_if, uint32_t err_fqid);
114 
115 /* Get IC transfer params */
116 int fman_if_get_ic_params(struct fman_if *fm_if, struct fman_if_ic_params *icp);
117 
118 /* Set IC transfer params */
119 __rte_internal
120 int fman_if_set_ic_params(struct fman_if *fm_if,
121 			  const struct fman_if_ic_params *icp);
122 
123 /* Get interface fd->offset value */
124 __rte_internal
125 int fman_if_get_fdoff(struct fman_if *fm_if);
126 
127 /* Set interface fd->offset value */
128 __rte_internal
129 void fman_if_set_fdoff(struct fman_if *fm_if, uint32_t fd_offset);
130 
131 /* Get interface SG enable status value */
132 __rte_internal
133 int fman_if_get_sg_enable(struct fman_if *fm_if);
134 
135 /* Set interface SG support mode */
136 __rte_internal
137 void fman_if_set_sg(struct fman_if *fm_if, int enable);
138 
139 /* Get interface Max Frame length (MTU) */
140 __rte_internal
141 uint16_t fman_if_get_maxfrm(struct fman_if *fm_if);
142 
143 /* Set interface  Max Frame length (MTU) */
144 __rte_internal
145 void fman_if_set_maxfrm(struct fman_if *fm_if, uint16_t max_frm);
146 
147 /* Set interface next invoked action for dequeue operation */
148 void fman_if_set_dnia(struct fman_if *fm_if, uint32_t nia);
149 
150 /* discard error packets on rx */
151 __rte_internal
152 void fman_if_discard_rx_errors(struct fman_if *fm_if);
153 
154 __rte_internal
155 void fman_if_receive_rx_errors(struct fman_if *fm_if,
156 	unsigned int err_eq);
157 
158 __rte_internal
159 void fman_if_set_mcast_filter_table(struct fman_if *p);
160 
161 __rte_internal
162 void fman_if_reset_mcast_filter_table(struct fman_if *p);
163 
164 int fman_if_add_hash_mac_addr(struct fman_if *p, uint8_t *eth);
165 
166 int fman_if_get_primary_mac_addr(struct fman_if *p, uint8_t *eth);
167 
168 
169 /* Enable/disable Rx on all interfaces */
fman_if_enable_all_rx(void)170 static inline void fman_if_enable_all_rx(void)
171 {
172 	struct fman_if *__if;
173 
174 	list_for_each_entry(__if, fman_if_list, node)
175 		fman_if_enable_rx(__if);
176 }
177 
fman_if_disable_all_rx(void)178 static inline void fman_if_disable_all_rx(void)
179 {
180 	struct fman_if *__if;
181 
182 	list_for_each_entry(__if, fman_if_list, node)
183 		fman_if_disable_rx(__if);
184 }
185 #endif /* __FSL_FMAN_H */
186