1 /* SPDX-License-Identifier: (GPL-2.0 OR MIT) */
2 // Copyright (c) 2018 Synopsys, Inc. and/or its affiliates.
3 // stmmac HW Interface Callbacks
4 
5 #ifndef __STMMAC_HWIF_H__
6 #define __STMMAC_HWIF_H__
7 
8 #include <linux/netdevice.h>
9 #include <linux/stmmac.h>
10 
11 #define stmmac_do_void_callback(__priv, __module, __cname,  __arg0, __args...) \
12 ({ \
13 	int __result = -EINVAL; \
14 	if ((__priv)->hw->__module && (__priv)->hw->__module->__cname) { \
15 		(__priv)->hw->__module->__cname((__arg0), ##__args); \
16 		__result = 0; \
17 	} \
18 	__result; \
19 })
20 #define stmmac_do_callback(__priv, __module, __cname,  __arg0, __args...) \
21 ({ \
22 	int __result = -EINVAL; \
23 	if ((__priv)->hw->__module && (__priv)->hw->__module->__cname) \
24 		__result = (__priv)->hw->__module->__cname((__arg0), ##__args); \
25 	__result; \
26 })
27 
28 struct stmmac_extra_stats;
29 struct stmmac_priv;
30 struct stmmac_safety_stats;
31 struct dma_desc;
32 struct dma_extended_desc;
33 struct dma_edesc;
34 
35 /* Descriptors helpers */
36 struct stmmac_desc_ops {
37 	/* DMA RX descriptor ring initialization */
38 	void (*init_rx_desc)(struct dma_desc *p, int disable_rx_ic, int mode,
39 			int end, int bfsize);
40 	/* DMA TX descriptor ring initialization */
41 	void (*init_tx_desc)(struct dma_desc *p, int mode, int end);
42 	/* Invoked by the xmit function to prepare the tx descriptor */
43 	void (*prepare_tx_desc)(struct dma_desc *p, int is_fs, int len,
44 			bool csum_flag, int mode, bool tx_own, bool ls,
45 			unsigned int tot_pkt_len);
46 	void (*prepare_tso_tx_desc)(struct dma_desc *p, int is_fs, int len1,
47 			int len2, bool tx_own, bool ls, unsigned int tcphdrlen,
48 			unsigned int tcppayloadlen);
49 	/* Set/get the owner of the descriptor */
50 	void (*set_tx_owner)(struct dma_desc *p);
51 	int (*get_tx_owner)(struct dma_desc *p);
52 	/* Clean the tx descriptor as soon as the tx irq is received */
53 	void (*release_tx_desc)(struct dma_desc *p, int mode);
54 	/* Clear interrupt on tx frame completion. When this bit is
55 	 * set an interrupt happens as soon as the frame is transmitted */
56 	void (*set_tx_ic)(struct dma_desc *p);
57 	/* Last tx segment reports the transmit status */
58 	int (*get_tx_ls)(struct dma_desc *p);
59 	/* Return the transmit status looking at the TDES1 */
60 	int (*tx_status)(struct net_device_stats *stats,
61 			 struct stmmac_extra_stats *x,
62 			 struct dma_desc *p, void __iomem *ioaddr);
63 	/* Get the buffer size from the descriptor */
64 	int (*get_tx_len)(struct dma_desc *p);
65 	/* Handle extra events on specific interrupts hw dependent */
66 	void (*set_rx_owner)(struct dma_desc *p, int disable_rx_ic);
67 	/* Get the receive frame size */
68 	int (*get_rx_frame_len)(struct dma_desc *p, int rx_coe_type);
69 	/* Return the reception status looking at the RDES1 */
70 	int (*rx_status)(struct net_device_stats *stats,
71 			 struct stmmac_extra_stats *x,
72 			 struct dma_desc *p);
73 	void (*rx_extended_status)(struct net_device_stats *stats,
74 				   struct stmmac_extra_stats *x,
75 				   struct dma_extended_desc *p);
76 	/* Set tx timestamp enable bit */
77 	void (*enable_tx_timestamp) (struct dma_desc *p);
78 	/* get tx timestamp status */
79 	int (*get_tx_timestamp_status) (struct dma_desc *p);
80 	/* get timestamp value */
81 	void (*get_timestamp)(void *desc, u32 ats, u64 *ts);
82 	/* get rx timestamp status */
83 	int (*get_rx_timestamp_status)(void *desc, void *next_desc, u32 ats);
84 	/* Display ring */
85 	void (*display_ring)(void *head, unsigned int size, bool rx,
86 			     dma_addr_t dma_rx_phy, unsigned int desc_size);
87 	/* set MSS via context descriptor */
88 	void (*set_mss)(struct dma_desc *p, unsigned int mss);
89 	/* set descriptor skbuff address */
90 	void (*set_addr)(struct dma_desc *p, dma_addr_t addr);
91 	/* clear descriptor */
92 	void (*clear)(struct dma_desc *p);
93 	/* RSS */
94 	int (*get_rx_hash)(struct dma_desc *p, u32 *hash,
95 			   enum pkt_hash_types *type);
96 	void (*get_rx_header_len)(struct dma_desc *p, unsigned int *len);
97 	void (*set_sec_addr)(struct dma_desc *p, dma_addr_t addr, bool buf2_valid);
98 	void (*set_sarc)(struct dma_desc *p, u32 sarc_type);
99 	void (*set_vlan_tag)(struct dma_desc *p, u16 tag, u16 inner_tag,
100 			     u32 inner_type);
101 	void (*set_vlan)(struct dma_desc *p, u32 type);
102 	void (*set_tbs)(struct dma_edesc *p, u32 sec, u32 nsec);
103 };
104 
105 #define stmmac_init_rx_desc(__priv, __args...) \
106 	stmmac_do_void_callback(__priv, desc, init_rx_desc, __args)
107 #define stmmac_init_tx_desc(__priv, __args...) \
108 	stmmac_do_void_callback(__priv, desc, init_tx_desc, __args)
109 #define stmmac_prepare_tx_desc(__priv, __args...) \
110 	stmmac_do_void_callback(__priv, desc, prepare_tx_desc, __args)
111 #define stmmac_prepare_tso_tx_desc(__priv, __args...) \
112 	stmmac_do_void_callback(__priv, desc, prepare_tso_tx_desc, __args)
113 #define stmmac_set_tx_owner(__priv, __args...) \
114 	stmmac_do_void_callback(__priv, desc, set_tx_owner, __args)
115 #define stmmac_get_tx_owner(__priv, __args...) \
116 	stmmac_do_callback(__priv, desc, get_tx_owner, __args)
117 #define stmmac_release_tx_desc(__priv, __args...) \
118 	stmmac_do_void_callback(__priv, desc, release_tx_desc, __args)
119 #define stmmac_set_tx_ic(__priv, __args...) \
120 	stmmac_do_void_callback(__priv, desc, set_tx_ic, __args)
121 #define stmmac_get_tx_ls(__priv, __args...) \
122 	stmmac_do_callback(__priv, desc, get_tx_ls, __args)
123 #define stmmac_tx_status(__priv, __args...) \
124 	stmmac_do_callback(__priv, desc, tx_status, __args)
125 #define stmmac_get_tx_len(__priv, __args...) \
126 	stmmac_do_callback(__priv, desc, get_tx_len, __args)
127 #define stmmac_set_rx_owner(__priv, __args...) \
128 	stmmac_do_void_callback(__priv, desc, set_rx_owner, __args)
129 #define stmmac_get_rx_frame_len(__priv, __args...) \
130 	stmmac_do_callback(__priv, desc, get_rx_frame_len, __args)
131 #define stmmac_rx_status(__priv, __args...) \
132 	stmmac_do_callback(__priv, desc, rx_status, __args)
133 #define stmmac_rx_extended_status(__priv, __args...) \
134 	stmmac_do_void_callback(__priv, desc, rx_extended_status, __args)
135 #define stmmac_enable_tx_timestamp(__priv, __args...) \
136 	stmmac_do_void_callback(__priv, desc, enable_tx_timestamp, __args)
137 #define stmmac_get_tx_timestamp_status(__priv, __args...) \
138 	stmmac_do_callback(__priv, desc, get_tx_timestamp_status, __args)
139 #define stmmac_get_timestamp(__priv, __args...) \
140 	stmmac_do_void_callback(__priv, desc, get_timestamp, __args)
141 #define stmmac_get_rx_timestamp_status(__priv, __args...) \
142 	stmmac_do_callback(__priv, desc, get_rx_timestamp_status, __args)
143 #define stmmac_display_ring(__priv, __args...) \
144 	stmmac_do_void_callback(__priv, desc, display_ring, __args)
145 #define stmmac_set_mss(__priv, __args...) \
146 	stmmac_do_void_callback(__priv, desc, set_mss, __args)
147 #define stmmac_set_desc_addr(__priv, __args...) \
148 	stmmac_do_void_callback(__priv, desc, set_addr, __args)
149 #define stmmac_clear_desc(__priv, __args...) \
150 	stmmac_do_void_callback(__priv, desc, clear, __args)
151 #define stmmac_get_rx_hash(__priv, __args...) \
152 	stmmac_do_callback(__priv, desc, get_rx_hash, __args)
153 #define stmmac_get_rx_header_len(__priv, __args...) \
154 	stmmac_do_void_callback(__priv, desc, get_rx_header_len, __args)
155 #define stmmac_set_desc_sec_addr(__priv, __args...) \
156 	stmmac_do_void_callback(__priv, desc, set_sec_addr, __args)
157 #define stmmac_set_desc_sarc(__priv, __args...) \
158 	stmmac_do_void_callback(__priv, desc, set_sarc, __args)
159 #define stmmac_set_desc_vlan_tag(__priv, __args...) \
160 	stmmac_do_void_callback(__priv, desc, set_vlan_tag, __args)
161 #define stmmac_set_desc_vlan(__priv, __args...) \
162 	stmmac_do_void_callback(__priv, desc, set_vlan, __args)
163 #define stmmac_set_desc_tbs(__priv, __args...) \
164 	stmmac_do_void_callback(__priv, desc, set_tbs, __args)
165 
166 struct stmmac_dma_cfg;
167 struct dma_features;
168 
169 /* Specific DMA helpers */
170 struct stmmac_dma_ops {
171 	/* DMA core initialization */
172 	int (*reset)(void __iomem *ioaddr);
173 	void (*init)(void __iomem *ioaddr, struct stmmac_dma_cfg *dma_cfg,
174 		     int atds);
175 	void (*init_chan)(struct stmmac_priv *priv, void __iomem *ioaddr,
176 			  struct stmmac_dma_cfg *dma_cfg, u32 chan);
177 	void (*init_rx_chan)(struct stmmac_priv *priv, void __iomem *ioaddr,
178 			     struct stmmac_dma_cfg *dma_cfg,
179 			     dma_addr_t phy, u32 chan);
180 	void (*init_tx_chan)(struct stmmac_priv *priv, void __iomem *ioaddr,
181 			     struct stmmac_dma_cfg *dma_cfg,
182 			     dma_addr_t phy, u32 chan);
183 	/* Configure the AXI Bus Mode Register */
184 	void (*axi)(void __iomem *ioaddr, struct stmmac_axi *axi);
185 	/* Dump DMA registers */
186 	void (*dump_regs)(struct stmmac_priv *priv, void __iomem *ioaddr,
187 			  u32 *reg_space);
188 	void (*dma_rx_mode)(struct stmmac_priv *priv, void __iomem *ioaddr,
189 			    int mode, u32 channel,
190 			    int fifosz, u8 qmode);
191 	void (*dma_tx_mode)(struct stmmac_priv *priv, void __iomem *ioaddr,
192 			    int mode, u32 channel, int fifosz, u8 qmode);
193 	/* To track extra statistic (if supported) */
194 	void (*dma_diagnostic_fr)(struct net_device_stats *stats,
195 				  struct stmmac_extra_stats *x,
196 				  void __iomem *ioaddr);
197 	void (*enable_dma_transmission) (void __iomem *ioaddr);
198 	void (*enable_dma_irq)(struct stmmac_priv *priv, void __iomem *ioaddr,
199 			       u32 chan, bool rx, bool tx);
200 	void (*disable_dma_irq)(struct stmmac_priv *priv, void __iomem *ioaddr,
201 				u32 chan, bool rx, bool tx);
202 	void (*start_tx)(struct stmmac_priv *priv, void __iomem *ioaddr,
203 			 u32 chan);
204 	void (*stop_tx)(struct stmmac_priv *priv, void __iomem *ioaddr,
205 			u32 chan);
206 	void (*start_rx)(struct stmmac_priv *priv, void __iomem *ioaddr,
207 			 u32 chan);
208 	void (*stop_rx)(struct stmmac_priv *priv, void __iomem *ioaddr,
209 			u32 chan);
210 	int (*dma_interrupt)(struct stmmac_priv *priv, void __iomem *ioaddr,
211 			     struct stmmac_extra_stats *x, u32 chan, u32 dir);
212 	/* If supported then get the optional core features */
213 	int (*get_hw_feature)(void __iomem *ioaddr,
214 			      struct dma_features *dma_cap);
215 	/* Program the HW RX Watchdog */
216 	void (*rx_watchdog)(struct stmmac_priv *priv, void __iomem *ioaddr,
217 			    u32 riwt, u32 queue);
218 	void (*set_tx_ring_len)(struct stmmac_priv *priv, void __iomem *ioaddr,
219 				u32 len, u32 chan);
220 	void (*set_rx_ring_len)(struct stmmac_priv *priv, void __iomem *ioaddr,
221 				u32 len, u32 chan);
222 	void (*set_rx_tail_ptr)(struct stmmac_priv *priv, void __iomem *ioaddr,
223 				u32 tail_ptr, u32 chan);
224 	void (*set_tx_tail_ptr)(struct stmmac_priv *priv, void __iomem *ioaddr,
225 				u32 tail_ptr, u32 chan);
226 	void (*enable_tso)(struct stmmac_priv *priv, void __iomem *ioaddr,
227 			   bool en, u32 chan);
228 	void (*qmode)(struct stmmac_priv *priv, void __iomem *ioaddr,
229 		      u32 channel, u8 qmode);
230 	void (*set_bfsize)(struct stmmac_priv *priv, void __iomem *ioaddr,
231 			   int bfsize, u32 chan);
232 	void (*enable_sph)(struct stmmac_priv *priv, void __iomem *ioaddr,
233 			   bool en, u32 chan);
234 	int (*enable_tbs)(struct stmmac_priv *priv, void __iomem *ioaddr,
235 			  bool en, u32 chan);
236 };
237 
238 #define stmmac_dma_init(__priv, __args...) \
239 	stmmac_do_void_callback(__priv, dma, init, __args)
240 #define stmmac_init_chan(__priv, __args...) \
241 	stmmac_do_void_callback(__priv, dma, init_chan, __priv, __args)
242 #define stmmac_init_rx_chan(__priv, __args...) \
243 	stmmac_do_void_callback(__priv, dma, init_rx_chan, __priv, __args)
244 #define stmmac_init_tx_chan(__priv, __args...) \
245 	stmmac_do_void_callback(__priv, dma, init_tx_chan, __priv, __args)
246 #define stmmac_axi(__priv, __args...) \
247 	stmmac_do_void_callback(__priv, dma, axi, __args)
248 #define stmmac_dump_dma_regs(__priv, __args...) \
249 	stmmac_do_void_callback(__priv, dma, dump_regs, __priv, __args)
250 #define stmmac_dma_rx_mode(__priv, __args...) \
251 	stmmac_do_void_callback(__priv, dma, dma_rx_mode, __priv, __args)
252 #define stmmac_dma_tx_mode(__priv, __args...) \
253 	stmmac_do_void_callback(__priv, dma, dma_tx_mode, __priv, __args)
254 #define stmmac_dma_diagnostic_fr(__priv, __args...) \
255 	stmmac_do_void_callback(__priv, dma, dma_diagnostic_fr, __args)
256 #define stmmac_enable_dma_transmission(__priv, __args...) \
257 	stmmac_do_void_callback(__priv, dma, enable_dma_transmission, __args)
258 #define stmmac_enable_dma_irq(__priv, __args...) \
259 	stmmac_do_void_callback(__priv, dma, enable_dma_irq, __priv, __args)
260 #define stmmac_disable_dma_irq(__priv, __args...) \
261 	stmmac_do_void_callback(__priv, dma, disable_dma_irq, __priv, __args)
262 #define stmmac_start_tx(__priv, __args...) \
263 	stmmac_do_void_callback(__priv, dma, start_tx, __priv, __args)
264 #define stmmac_stop_tx(__priv, __args...) \
265 	stmmac_do_void_callback(__priv, dma, stop_tx, __priv, __args)
266 #define stmmac_start_rx(__priv, __args...) \
267 	stmmac_do_void_callback(__priv, dma, start_rx, __priv, __args)
268 #define stmmac_stop_rx(__priv, __args...) \
269 	stmmac_do_void_callback(__priv, dma, stop_rx, __priv, __args)
270 #define stmmac_dma_interrupt_status(__priv, __args...) \
271 	stmmac_do_callback(__priv, dma, dma_interrupt, __priv, __args)
272 #define stmmac_get_hw_feature(__priv, __args...) \
273 	stmmac_do_callback(__priv, dma, get_hw_feature, __args)
274 #define stmmac_rx_watchdog(__priv, __args...) \
275 	stmmac_do_void_callback(__priv, dma, rx_watchdog, __priv, __args)
276 #define stmmac_set_tx_ring_len(__priv, __args...) \
277 	stmmac_do_void_callback(__priv, dma, set_tx_ring_len, __priv, __args)
278 #define stmmac_set_rx_ring_len(__priv, __args...) \
279 	stmmac_do_void_callback(__priv, dma, set_rx_ring_len, __priv, __args)
280 #define stmmac_set_rx_tail_ptr(__priv, __args...) \
281 	stmmac_do_void_callback(__priv, dma, set_rx_tail_ptr, __priv, __args)
282 #define stmmac_set_tx_tail_ptr(__priv, __args...) \
283 	stmmac_do_void_callback(__priv, dma, set_tx_tail_ptr, __priv, __args)
284 #define stmmac_enable_tso(__priv, __args...) \
285 	stmmac_do_void_callback(__priv, dma, enable_tso, __priv, __args)
286 #define stmmac_dma_qmode(__priv, __args...) \
287 	stmmac_do_void_callback(__priv, dma, qmode, __priv, __args)
288 #define stmmac_set_dma_bfsize(__priv, __args...) \
289 	stmmac_do_void_callback(__priv, dma, set_bfsize, __priv, __args)
290 #define stmmac_enable_sph(__priv, __args...) \
291 	stmmac_do_void_callback(__priv, dma, enable_sph, __priv, __args)
292 #define stmmac_enable_tbs(__priv, __args...) \
293 	stmmac_do_callback(__priv, dma, enable_tbs, __priv, __args)
294 
295 struct mac_device_info;
296 struct net_device;
297 struct rgmii_adv;
298 struct stmmac_tc_entry;
299 struct stmmac_pps_cfg;
300 struct stmmac_rss;
301 struct stmmac_est;
302 
303 /* Helpers to program the MAC core */
304 struct stmmac_ops {
305 	/* MAC core initialization */
306 	void (*core_init)(struct mac_device_info *hw, struct net_device *dev);
307 	/* Enable the MAC RX/TX */
308 	void (*set_mac)(void __iomem *ioaddr, bool enable);
309 	/* Enable and verify that the IPC module is supported */
310 	int (*rx_ipc)(struct mac_device_info *hw);
311 	/* Enable RX Queues */
312 	void (*rx_queue_enable)(struct mac_device_info *hw, u8 mode, u32 queue);
313 	/* RX Queues Priority */
314 	void (*rx_queue_prio)(struct mac_device_info *hw, u32 prio, u32 queue);
315 	/* TX Queues Priority */
316 	void (*tx_queue_prio)(struct mac_device_info *hw, u32 prio, u32 queue);
317 	/* RX Queues Routing */
318 	void (*rx_queue_routing)(struct mac_device_info *hw, u8 packet,
319 				 u32 queue);
320 	/* Program RX Algorithms */
321 	void (*prog_mtl_rx_algorithms)(struct mac_device_info *hw, u32 rx_alg);
322 	/* Program TX Algorithms */
323 	void (*prog_mtl_tx_algorithms)(struct mac_device_info *hw, u32 tx_alg);
324 	/* Set MTL TX queues weight */
325 	void (*set_mtl_tx_queue_weight)(struct stmmac_priv *priv,
326 					struct mac_device_info *hw,
327 					u32 weight, u32 queue);
328 	/* RX MTL queue to RX dma mapping */
329 	void (*map_mtl_to_dma)(struct mac_device_info *hw, u32 queue, u32 chan);
330 	/* Configure AV Algorithm */
331 	void (*config_cbs)(struct stmmac_priv *priv, struct mac_device_info *hw,
332 			   u32 send_slope, u32 idle_slope, u32 high_credit,
333 			   u32 low_credit, u32 queue);
334 	/* Dump MAC registers */
335 	void (*dump_regs)(struct mac_device_info *hw, u32 *reg_space);
336 	/* Handle extra events on specific interrupts hw dependent */
337 	int (*host_irq_status)(struct mac_device_info *hw,
338 			       struct stmmac_extra_stats *x);
339 	/* Handle MTL interrupts */
340 	int (*host_mtl_irq_status)(struct stmmac_priv *priv,
341 				   struct mac_device_info *hw, u32 chan);
342 	/* Multicast filter setting */
343 	void (*set_filter)(struct mac_device_info *hw, struct net_device *dev);
344 	/* Flow control setting */
345 	void (*flow_ctrl)(struct mac_device_info *hw, unsigned int duplex,
346 			  unsigned int fc, unsigned int pause_time, u32 tx_cnt);
347 	/* Set power management mode (e.g. magic frame) */
348 	void (*pmt)(struct mac_device_info *hw, unsigned long mode);
349 	/* Set/Get Unicast MAC addresses */
350 	void (*set_umac_addr)(struct mac_device_info *hw,
351 			      const unsigned char *addr,
352 			      unsigned int reg_n);
353 	void (*get_umac_addr)(struct mac_device_info *hw, unsigned char *addr,
354 			      unsigned int reg_n);
355 	void (*set_eee_mode)(struct mac_device_info *hw,
356 			     bool en_tx_lpi_clockgating);
357 	void (*reset_eee_mode)(struct mac_device_info *hw);
358 	void (*set_eee_lpi_entry_timer)(struct mac_device_info *hw, int et);
359 	void (*set_eee_timer)(struct mac_device_info *hw, int ls, int tw);
360 	void (*set_eee_pls)(struct mac_device_info *hw, int link);
361 	void (*debug)(struct stmmac_priv *priv, void __iomem *ioaddr,
362 		      struct stmmac_extra_stats *x, u32 rx_queues,
363 		      u32 tx_queues);
364 	/* PCS calls */
365 	void (*pcs_ctrl_ane)(void __iomem *ioaddr, bool ane, bool srgmi_ral,
366 			     bool loopback);
367 	void (*pcs_rane)(void __iomem *ioaddr, bool restart);
368 	void (*pcs_get_adv_lp)(void __iomem *ioaddr, struct rgmii_adv *adv);
369 	/* Safety Features */
370 	int (*safety_feat_config)(void __iomem *ioaddr, unsigned int asp,
371 				  struct stmmac_safety_feature_cfg *safety_cfg);
372 	int (*safety_feat_irq_status)(struct net_device *ndev,
373 			void __iomem *ioaddr, unsigned int asp,
374 			struct stmmac_safety_stats *stats);
375 	int (*safety_feat_dump)(struct stmmac_safety_stats *stats,
376 			int index, unsigned long *count, const char **desc);
377 	/* Flexible RX Parser */
378 	int (*rxp_config)(void __iomem *ioaddr, struct stmmac_tc_entry *entries,
379 			  unsigned int count);
380 	/* Flexible PPS */
381 	int (*flex_pps_config)(void __iomem *ioaddr, int index,
382 			       struct stmmac_pps_cfg *cfg, bool enable,
383 			       u32 sub_second_inc, u32 systime_flags);
384 	/* Loopback for selftests */
385 	void (*set_mac_loopback)(void __iomem *ioaddr, bool enable);
386 	/* RSS */
387 	int (*rss_configure)(struct mac_device_info *hw,
388 			     struct stmmac_rss *cfg, u32 num_rxq);
389 	/* VLAN */
390 	void (*update_vlan_hash)(struct mac_device_info *hw, u32 hash,
391 				 __le16 perfect_match, bool is_double);
392 	void (*enable_vlan)(struct mac_device_info *hw, u32 type);
393 	int (*add_hw_vlan_rx_fltr)(struct net_device *dev,
394 				   struct mac_device_info *hw,
395 				   __be16 proto, u16 vid);
396 	int (*del_hw_vlan_rx_fltr)(struct net_device *dev,
397 				   struct mac_device_info *hw,
398 				   __be16 proto, u16 vid);
399 	void (*restore_hw_vlan_rx_fltr)(struct net_device *dev,
400 					struct mac_device_info *hw);
401 	/* TX Timestamp */
402 	int (*get_mac_tx_timestamp)(struct mac_device_info *hw, u64 *ts);
403 	/* Source Address Insertion / Replacement */
404 	void (*sarc_configure)(void __iomem *ioaddr, int val);
405 	/* Filtering */
406 	int (*config_l3_filter)(struct mac_device_info *hw, u32 filter_no,
407 				bool en, bool ipv6, bool sa, bool inv,
408 				u32 match);
409 	int (*config_l4_filter)(struct mac_device_info *hw, u32 filter_no,
410 				bool en, bool udp, bool sa, bool inv,
411 				u32 match);
412 	void (*set_arp_offload)(struct mac_device_info *hw, bool en, u32 addr);
413 	int (*est_configure)(void __iomem *ioaddr, struct stmmac_est *cfg,
414 			     unsigned int ptp_rate);
415 	void (*est_irq_status)(void __iomem *ioaddr, struct net_device *dev,
416 			       struct stmmac_extra_stats *x, u32 txqcnt);
417 	void (*fpe_configure)(void __iomem *ioaddr, u32 num_txq, u32 num_rxq,
418 			      bool enable);
419 	void (*fpe_send_mpacket)(void __iomem *ioaddr,
420 				 enum stmmac_mpacket_type type);
421 	int (*fpe_irq_status)(void __iomem *ioaddr, struct net_device *dev);
422 };
423 
424 #define stmmac_core_init(__priv, __args...) \
425 	stmmac_do_void_callback(__priv, mac, core_init, __args)
426 #define stmmac_mac_set(__priv, __args...) \
427 	stmmac_do_void_callback(__priv, mac, set_mac, __args)
428 #define stmmac_rx_ipc(__priv, __args...) \
429 	stmmac_do_callback(__priv, mac, rx_ipc, __args)
430 #define stmmac_rx_queue_enable(__priv, __args...) \
431 	stmmac_do_void_callback(__priv, mac, rx_queue_enable, __args)
432 #define stmmac_rx_queue_prio(__priv, __args...) \
433 	stmmac_do_void_callback(__priv, mac, rx_queue_prio, __args)
434 #define stmmac_tx_queue_prio(__priv, __args...) \
435 	stmmac_do_void_callback(__priv, mac, tx_queue_prio, __args)
436 #define stmmac_rx_queue_routing(__priv, __args...) \
437 	stmmac_do_void_callback(__priv, mac, rx_queue_routing, __args)
438 #define stmmac_prog_mtl_rx_algorithms(__priv, __args...) \
439 	stmmac_do_void_callback(__priv, mac, prog_mtl_rx_algorithms, __args)
440 #define stmmac_prog_mtl_tx_algorithms(__priv, __args...) \
441 	stmmac_do_void_callback(__priv, mac, prog_mtl_tx_algorithms, __args)
442 #define stmmac_set_mtl_tx_queue_weight(__priv, __args...) \
443 	stmmac_do_void_callback(__priv, mac, set_mtl_tx_queue_weight, __priv, __args)
444 #define stmmac_map_mtl_to_dma(__priv, __args...) \
445 	stmmac_do_void_callback(__priv, mac, map_mtl_to_dma, __args)
446 #define stmmac_config_cbs(__priv, __args...) \
447 	stmmac_do_void_callback(__priv, mac, config_cbs, __priv, __args)
448 #define stmmac_dump_mac_regs(__priv, __args...) \
449 	stmmac_do_void_callback(__priv, mac, dump_regs, __args)
450 #define stmmac_host_irq_status(__priv, __args...) \
451 	stmmac_do_callback(__priv, mac, host_irq_status, __args)
452 #define stmmac_host_mtl_irq_status(__priv, __args...) \
453 	stmmac_do_callback(__priv, mac, host_mtl_irq_status, __priv, __args)
454 #define stmmac_set_filter(__priv, __args...) \
455 	stmmac_do_void_callback(__priv, mac, set_filter, __args)
456 #define stmmac_flow_ctrl(__priv, __args...) \
457 	stmmac_do_void_callback(__priv, mac, flow_ctrl, __args)
458 #define stmmac_pmt(__priv, __args...) \
459 	stmmac_do_void_callback(__priv, mac, pmt, __args)
460 #define stmmac_set_umac_addr(__priv, __args...) \
461 	stmmac_do_void_callback(__priv, mac, set_umac_addr, __args)
462 #define stmmac_get_umac_addr(__priv, __args...) \
463 	stmmac_do_void_callback(__priv, mac, get_umac_addr, __args)
464 #define stmmac_set_eee_mode(__priv, __args...) \
465 	stmmac_do_void_callback(__priv, mac, set_eee_mode, __args)
466 #define stmmac_reset_eee_mode(__priv, __args...) \
467 	stmmac_do_void_callback(__priv, mac, reset_eee_mode, __args)
468 #define stmmac_set_eee_lpi_timer(__priv, __args...) \
469 	stmmac_do_void_callback(__priv, mac, set_eee_lpi_entry_timer, __args)
470 #define stmmac_set_eee_timer(__priv, __args...) \
471 	stmmac_do_void_callback(__priv, mac, set_eee_timer, __args)
472 #define stmmac_set_eee_pls(__priv, __args...) \
473 	stmmac_do_void_callback(__priv, mac, set_eee_pls, __args)
474 #define stmmac_mac_debug(__priv, __args...) \
475 	stmmac_do_void_callback(__priv, mac, debug, __priv, __args)
476 #define stmmac_pcs_ctrl_ane(__priv, __args...) \
477 	stmmac_do_void_callback(__priv, mac, pcs_ctrl_ane, __args)
478 #define stmmac_pcs_rane(__priv, __args...) \
479 	stmmac_do_void_callback(__priv, mac, pcs_rane, __priv, __args)
480 #define stmmac_pcs_get_adv_lp(__priv, __args...) \
481 	stmmac_do_void_callback(__priv, mac, pcs_get_adv_lp, __args)
482 #define stmmac_safety_feat_config(__priv, __args...) \
483 	stmmac_do_callback(__priv, mac, safety_feat_config, __args)
484 #define stmmac_safety_feat_irq_status(__priv, __args...) \
485 	stmmac_do_callback(__priv, mac, safety_feat_irq_status, __args)
486 #define stmmac_safety_feat_dump(__priv, __args...) \
487 	stmmac_do_callback(__priv, mac, safety_feat_dump, __args)
488 #define stmmac_rxp_config(__priv, __args...) \
489 	stmmac_do_callback(__priv, mac, rxp_config, __args)
490 #define stmmac_flex_pps_config(__priv, __args...) \
491 	stmmac_do_callback(__priv, mac, flex_pps_config, __args)
492 #define stmmac_set_mac_loopback(__priv, __args...) \
493 	stmmac_do_void_callback(__priv, mac, set_mac_loopback, __args)
494 #define stmmac_rss_configure(__priv, __args...) \
495 	stmmac_do_callback(__priv, mac, rss_configure, __args)
496 #define stmmac_update_vlan_hash(__priv, __args...) \
497 	stmmac_do_void_callback(__priv, mac, update_vlan_hash, __args)
498 #define stmmac_enable_vlan(__priv, __args...) \
499 	stmmac_do_void_callback(__priv, mac, enable_vlan, __args)
500 #define stmmac_add_hw_vlan_rx_fltr(__priv, __args...) \
501 	stmmac_do_callback(__priv, mac, add_hw_vlan_rx_fltr, __args)
502 #define stmmac_del_hw_vlan_rx_fltr(__priv, __args...) \
503 	stmmac_do_callback(__priv, mac, del_hw_vlan_rx_fltr, __args)
504 #define stmmac_restore_hw_vlan_rx_fltr(__priv, __args...) \
505 	stmmac_do_void_callback(__priv, mac, restore_hw_vlan_rx_fltr, __args)
506 #define stmmac_get_mac_tx_timestamp(__priv, __args...) \
507 	stmmac_do_callback(__priv, mac, get_mac_tx_timestamp, __args)
508 #define stmmac_sarc_configure(__priv, __args...) \
509 	stmmac_do_void_callback(__priv, mac, sarc_configure, __args)
510 #define stmmac_config_l3_filter(__priv, __args...) \
511 	stmmac_do_callback(__priv, mac, config_l3_filter, __args)
512 #define stmmac_config_l4_filter(__priv, __args...) \
513 	stmmac_do_callback(__priv, mac, config_l4_filter, __args)
514 #define stmmac_set_arp_offload(__priv, __args...) \
515 	stmmac_do_void_callback(__priv, mac, set_arp_offload, __args)
516 #define stmmac_est_configure(__priv, __args...) \
517 	stmmac_do_callback(__priv, mac, est_configure, __args)
518 #define stmmac_est_irq_status(__priv, __args...) \
519 	stmmac_do_void_callback(__priv, mac, est_irq_status, __args)
520 #define stmmac_fpe_configure(__priv, __args...) \
521 	stmmac_do_void_callback(__priv, mac, fpe_configure, __args)
522 #define stmmac_fpe_send_mpacket(__priv, __args...) \
523 	stmmac_do_void_callback(__priv, mac, fpe_send_mpacket, __args)
524 #define stmmac_fpe_irq_status(__priv, __args...) \
525 	stmmac_do_callback(__priv, mac, fpe_irq_status, __args)
526 
527 /* PTP and HW Timer helpers */
528 struct stmmac_hwtimestamp {
529 	void (*config_hw_tstamping) (void __iomem *ioaddr, u32 data);
530 	void (*config_sub_second_increment)(void __iomem *ioaddr, u32 ptp_clock,
531 					   int gmac4, u32 *ssinc);
532 	int (*init_systime) (void __iomem *ioaddr, u32 sec, u32 nsec);
533 	int (*config_addend) (void __iomem *ioaddr, u32 addend);
534 	int (*adjust_systime) (void __iomem *ioaddr, u32 sec, u32 nsec,
535 			       int add_sub, int gmac4);
536 	void (*get_systime) (void __iomem *ioaddr, u64 *systime);
537 	void (*get_ptptime)(void __iomem *ioaddr, u64 *ptp_time);
538 	void (*timestamp_interrupt)(struct stmmac_priv *priv);
539 };
540 
541 #define stmmac_config_hw_tstamping(__priv, __args...) \
542 	stmmac_do_void_callback(__priv, ptp, config_hw_tstamping, __args)
543 #define stmmac_config_sub_second_increment(__priv, __args...) \
544 	stmmac_do_void_callback(__priv, ptp, config_sub_second_increment, __args)
545 #define stmmac_init_systime(__priv, __args...) \
546 	stmmac_do_callback(__priv, ptp, init_systime, __args)
547 #define stmmac_config_addend(__priv, __args...) \
548 	stmmac_do_callback(__priv, ptp, config_addend, __args)
549 #define stmmac_adjust_systime(__priv, __args...) \
550 	stmmac_do_callback(__priv, ptp, adjust_systime, __args)
551 #define stmmac_get_systime(__priv, __args...) \
552 	stmmac_do_void_callback(__priv, ptp, get_systime, __args)
553 #define stmmac_get_ptptime(__priv, __args...) \
554 	stmmac_do_void_callback(__priv, ptp, get_ptptime, __args)
555 #define stmmac_timestamp_interrupt(__priv, __args...) \
556 	stmmac_do_void_callback(__priv, ptp, timestamp_interrupt, __args)
557 
558 struct stmmac_tx_queue;
559 struct stmmac_rx_queue;
560 
561 /* Helpers to manage the descriptors for chain and ring modes */
562 struct stmmac_mode_ops {
563 	void (*init) (void *des, dma_addr_t phy_addr, unsigned int size,
564 		      unsigned int extend_desc);
565 	unsigned int (*is_jumbo_frm) (int len, int ehn_desc);
566 	int (*jumbo_frm)(struct stmmac_tx_queue *tx_q, struct sk_buff *skb,
567 			 int csum);
568 	int (*set_16kib_bfsize)(int mtu);
569 	void (*init_desc3)(struct dma_desc *p);
570 	void (*refill_desc3)(struct stmmac_rx_queue *rx_q, struct dma_desc *p);
571 	void (*clean_desc3)(struct stmmac_tx_queue *tx_q, struct dma_desc *p);
572 };
573 
574 #define stmmac_mode_init(__priv, __args...) \
575 	stmmac_do_void_callback(__priv, mode, init, __args)
576 #define stmmac_is_jumbo_frm(__priv, __args...) \
577 	stmmac_do_callback(__priv, mode, is_jumbo_frm, __args)
578 #define stmmac_jumbo_frm(__priv, __args...) \
579 	stmmac_do_callback(__priv, mode, jumbo_frm, __args)
580 #define stmmac_set_16kib_bfsize(__priv, __args...) \
581 	stmmac_do_callback(__priv, mode, set_16kib_bfsize, __args)
582 #define stmmac_init_desc3(__priv, __args...) \
583 	stmmac_do_void_callback(__priv, mode, init_desc3, __args)
584 #define stmmac_refill_desc3(__priv, __args...) \
585 	stmmac_do_void_callback(__priv, mode, refill_desc3, __args)
586 #define stmmac_clean_desc3(__priv, __args...) \
587 	stmmac_do_void_callback(__priv, mode, clean_desc3, __args)
588 
589 struct tc_cls_u32_offload;
590 struct tc_cbs_qopt_offload;
591 struct flow_cls_offload;
592 struct tc_taprio_qopt_offload;
593 struct tc_etf_qopt_offload;
594 struct tc_query_caps_base;
595 
596 struct stmmac_tc_ops {
597 	int (*init)(struct stmmac_priv *priv);
598 	int (*setup_cls_u32)(struct stmmac_priv *priv,
599 			     struct tc_cls_u32_offload *cls);
600 	int (*setup_cbs)(struct stmmac_priv *priv,
601 			 struct tc_cbs_qopt_offload *qopt);
602 	int (*setup_cls)(struct stmmac_priv *priv,
603 			 struct flow_cls_offload *cls);
604 	int (*setup_taprio)(struct stmmac_priv *priv,
605 			    struct tc_taprio_qopt_offload *qopt);
606 	int (*setup_etf)(struct stmmac_priv *priv,
607 			 struct tc_etf_qopt_offload *qopt);
608 	int (*query_caps)(struct stmmac_priv *priv,
609 			  struct tc_query_caps_base *base);
610 };
611 
612 #define stmmac_tc_init(__priv, __args...) \
613 	stmmac_do_callback(__priv, tc, init, __args)
614 #define stmmac_tc_setup_cls_u32(__priv, __args...) \
615 	stmmac_do_callback(__priv, tc, setup_cls_u32, __args)
616 #define stmmac_tc_setup_cbs(__priv, __args...) \
617 	stmmac_do_callback(__priv, tc, setup_cbs, __args)
618 #define stmmac_tc_setup_cls(__priv, __args...) \
619 	stmmac_do_callback(__priv, tc, setup_cls, __args)
620 #define stmmac_tc_setup_taprio(__priv, __args...) \
621 	stmmac_do_callback(__priv, tc, setup_taprio, __args)
622 #define stmmac_tc_setup_etf(__priv, __args...) \
623 	stmmac_do_callback(__priv, tc, setup_etf, __args)
624 #define stmmac_tc_query_caps(__priv, __args...) \
625 	stmmac_do_callback(__priv, tc, query_caps, __args)
626 
627 struct stmmac_counters;
628 
629 struct stmmac_mmc_ops {
630 	void (*ctrl)(void __iomem *ioaddr, unsigned int mode);
631 	void (*intr_all_mask)(void __iomem *ioaddr);
632 	void (*read)(void __iomem *ioaddr, struct stmmac_counters *mmc);
633 };
634 
635 #define stmmac_mmc_ctrl(__priv, __args...) \
636 	stmmac_do_void_callback(__priv, mmc, ctrl, __args)
637 #define stmmac_mmc_intr_all_mask(__priv, __args...) \
638 	stmmac_do_void_callback(__priv, mmc, intr_all_mask, __args)
639 #define stmmac_mmc_read(__priv, __args...) \
640 	stmmac_do_void_callback(__priv, mmc, read, __args)
641 
642 struct stmmac_regs_off {
643 	u32 ptp_off;
644 	u32 mmc_off;
645 };
646 
647 extern const struct stmmac_ops dwmac100_ops;
648 extern const struct stmmac_dma_ops dwmac100_dma_ops;
649 extern const struct stmmac_ops dwmac1000_ops;
650 extern const struct stmmac_dma_ops dwmac1000_dma_ops;
651 extern const struct stmmac_ops dwmac4_ops;
652 extern const struct stmmac_dma_ops dwmac4_dma_ops;
653 extern const struct stmmac_ops dwmac410_ops;
654 extern const struct stmmac_dma_ops dwmac410_dma_ops;
655 extern const struct stmmac_ops dwmac510_ops;
656 extern const struct stmmac_tc_ops dwmac510_tc_ops;
657 extern const struct stmmac_ops dwxgmac210_ops;
658 extern const struct stmmac_ops dwxlgmac2_ops;
659 extern const struct stmmac_dma_ops dwxgmac210_dma_ops;
660 extern const struct stmmac_desc_ops dwxgmac210_desc_ops;
661 extern const struct stmmac_mmc_ops dwmac_mmc_ops;
662 extern const struct stmmac_mmc_ops dwxgmac_mmc_ops;
663 
664 #define GMAC_VERSION		0x00000020	/* GMAC CORE Version */
665 #define GMAC4_VERSION		0x00000110	/* GMAC4+ CORE Version */
666 
667 int stmmac_reset(struct stmmac_priv *priv, void __iomem *ioaddr);
668 int stmmac_hwif_init(struct stmmac_priv *priv);
669 
670 #endif /* __STMMAC_HWIF_H__ */
671