xref: /openbmc/linux/drivers/net/ethernet/stmicro/stmmac/hwif.h (revision 25e80cd05ff81e51750106f1ae12364449ec38e7)
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_safety_stats;
30 struct dma_desc;
31 struct dma_extended_desc;
32 
33 /* Descriptors helpers */
34 struct stmmac_desc_ops {
35 	/* DMA RX descriptor ring initialization */
36 	void (*init_rx_desc)(struct dma_desc *p, int disable_rx_ic, int mode,
37 			int end, int bfsize);
38 	/* DMA TX descriptor ring initialization */
39 	void (*init_tx_desc)(struct dma_desc *p, int mode, int end);
40 	/* Invoked by the xmit function to prepare the tx descriptor */
41 	void (*prepare_tx_desc)(struct dma_desc *p, int is_fs, int len,
42 			bool csum_flag, int mode, bool tx_own, bool ls,
43 			unsigned int tot_pkt_len);
44 	void (*prepare_tso_tx_desc)(struct dma_desc *p, int is_fs, int len1,
45 			int len2, bool tx_own, bool ls, unsigned int tcphdrlen,
46 			unsigned int tcppayloadlen);
47 	/* Set/get the owner of the descriptor */
48 	void (*set_tx_owner)(struct dma_desc *p);
49 	int (*get_tx_owner)(struct dma_desc *p);
50 	/* Clean the tx descriptor as soon as the tx irq is received */
51 	void (*release_tx_desc)(struct dma_desc *p, int mode);
52 	/* Clear interrupt on tx frame completion. When this bit is
53 	 * set an interrupt happens as soon as the frame is transmitted */
54 	void (*set_tx_ic)(struct dma_desc *p);
55 	/* Last tx segment reports the transmit status */
56 	int (*get_tx_ls)(struct dma_desc *p);
57 	/* Return the transmit status looking at the TDES1 */
58 	int (*tx_status)(void *data, struct stmmac_extra_stats *x,
59 			struct dma_desc *p, void __iomem *ioaddr);
60 	/* Get the buffer size from the descriptor */
61 	int (*get_tx_len)(struct dma_desc *p);
62 	/* Handle extra events on specific interrupts hw dependent */
63 	void (*set_rx_owner)(struct dma_desc *p, int disable_rx_ic);
64 	/* Get the receive frame size */
65 	int (*get_rx_frame_len)(struct dma_desc *p, int rx_coe_type);
66 	/* Return the reception status looking at the RDES1 */
67 	int (*rx_status)(void *data, struct stmmac_extra_stats *x,
68 			struct dma_desc *p);
69 	void (*rx_extended_status)(void *data, struct stmmac_extra_stats *x,
70 			struct dma_extended_desc *p);
71 	/* Set tx timestamp enable bit */
72 	void (*enable_tx_timestamp) (struct dma_desc *p);
73 	/* get tx timestamp status */
74 	int (*get_tx_timestamp_status) (struct dma_desc *p);
75 	/* get timestamp value */
76 	void (*get_timestamp)(void *desc, u32 ats, u64 *ts);
77 	/* get rx timestamp status */
78 	int (*get_rx_timestamp_status)(void *desc, void *next_desc, u32 ats);
79 	/* Display ring */
80 	void (*display_ring)(void *head, unsigned int size, bool rx);
81 	/* set MSS via context descriptor */
82 	void (*set_mss)(struct dma_desc *p, unsigned int mss);
83 	/* get descriptor skbuff address */
84 	void (*get_addr)(struct dma_desc *p, unsigned int *addr);
85 	/* set descriptor skbuff address */
86 	void (*set_addr)(struct dma_desc *p, dma_addr_t addr);
87 	/* clear descriptor */
88 	void (*clear)(struct dma_desc *p);
89 	/* RSS */
90 	int (*get_rx_hash)(struct dma_desc *p, u32 *hash,
91 			   enum pkt_hash_types *type);
92 };
93 
94 #define stmmac_init_rx_desc(__priv, __args...) \
95 	stmmac_do_void_callback(__priv, desc, init_rx_desc, __args)
96 #define stmmac_init_tx_desc(__priv, __args...) \
97 	stmmac_do_void_callback(__priv, desc, init_tx_desc, __args)
98 #define stmmac_prepare_tx_desc(__priv, __args...) \
99 	stmmac_do_void_callback(__priv, desc, prepare_tx_desc, __args)
100 #define stmmac_prepare_tso_tx_desc(__priv, __args...) \
101 	stmmac_do_void_callback(__priv, desc, prepare_tso_tx_desc, __args)
102 #define stmmac_set_tx_owner(__priv, __args...) \
103 	stmmac_do_void_callback(__priv, desc, set_tx_owner, __args)
104 #define stmmac_get_tx_owner(__priv, __args...) \
105 	stmmac_do_callback(__priv, desc, get_tx_owner, __args)
106 #define stmmac_release_tx_desc(__priv, __args...) \
107 	stmmac_do_void_callback(__priv, desc, release_tx_desc, __args)
108 #define stmmac_set_tx_ic(__priv, __args...) \
109 	stmmac_do_void_callback(__priv, desc, set_tx_ic, __args)
110 #define stmmac_get_tx_ls(__priv, __args...) \
111 	stmmac_do_callback(__priv, desc, get_tx_ls, __args)
112 #define stmmac_tx_status(__priv, __args...) \
113 	stmmac_do_callback(__priv, desc, tx_status, __args)
114 #define stmmac_get_tx_len(__priv, __args...) \
115 	stmmac_do_callback(__priv, desc, get_tx_len, __args)
116 #define stmmac_set_rx_owner(__priv, __args...) \
117 	stmmac_do_void_callback(__priv, desc, set_rx_owner, __args)
118 #define stmmac_get_rx_frame_len(__priv, __args...) \
119 	stmmac_do_callback(__priv, desc, get_rx_frame_len, __args)
120 #define stmmac_rx_status(__priv, __args...) \
121 	stmmac_do_callback(__priv, desc, rx_status, __args)
122 #define stmmac_rx_extended_status(__priv, __args...) \
123 	stmmac_do_void_callback(__priv, desc, rx_extended_status, __args)
124 #define stmmac_enable_tx_timestamp(__priv, __args...) \
125 	stmmac_do_void_callback(__priv, desc, enable_tx_timestamp, __args)
126 #define stmmac_get_tx_timestamp_status(__priv, __args...) \
127 	stmmac_do_callback(__priv, desc, get_tx_timestamp_status, __args)
128 #define stmmac_get_timestamp(__priv, __args...) \
129 	stmmac_do_void_callback(__priv, desc, get_timestamp, __args)
130 #define stmmac_get_rx_timestamp_status(__priv, __args...) \
131 	stmmac_do_callback(__priv, desc, get_rx_timestamp_status, __args)
132 #define stmmac_display_ring(__priv, __args...) \
133 	stmmac_do_void_callback(__priv, desc, display_ring, __args)
134 #define stmmac_set_mss(__priv, __args...) \
135 	stmmac_do_void_callback(__priv, desc, set_mss, __args)
136 #define stmmac_get_desc_addr(__priv, __args...) \
137 	stmmac_do_void_callback(__priv, desc, get_addr, __args)
138 #define stmmac_set_desc_addr(__priv, __args...) \
139 	stmmac_do_void_callback(__priv, desc, set_addr, __args)
140 #define stmmac_clear_desc(__priv, __args...) \
141 	stmmac_do_void_callback(__priv, desc, clear, __args)
142 #define stmmac_get_rx_hash(__priv, __args...) \
143 	stmmac_do_callback(__priv, desc, get_rx_hash, __args)
144 
145 struct stmmac_dma_cfg;
146 struct dma_features;
147 
148 /* Specific DMA helpers */
149 struct stmmac_dma_ops {
150 	/* DMA core initialization */
151 	int (*reset)(void __iomem *ioaddr);
152 	void (*init)(void __iomem *ioaddr, struct stmmac_dma_cfg *dma_cfg,
153 		     int atds);
154 	void (*init_chan)(void __iomem *ioaddr,
155 			  struct stmmac_dma_cfg *dma_cfg, u32 chan);
156 	void (*init_rx_chan)(void __iomem *ioaddr,
157 			     struct stmmac_dma_cfg *dma_cfg,
158 			     dma_addr_t phy, u32 chan);
159 	void (*init_tx_chan)(void __iomem *ioaddr,
160 			     struct stmmac_dma_cfg *dma_cfg,
161 			     dma_addr_t phy, u32 chan);
162 	/* Configure the AXI Bus Mode Register */
163 	void (*axi)(void __iomem *ioaddr, struct stmmac_axi *axi);
164 	/* Dump DMA registers */
165 	void (*dump_regs)(void __iomem *ioaddr, u32 *reg_space);
166 	void (*dma_rx_mode)(void __iomem *ioaddr, int mode, u32 channel,
167 			    int fifosz, u8 qmode);
168 	void (*dma_tx_mode)(void __iomem *ioaddr, int mode, u32 channel,
169 			    int fifosz, u8 qmode);
170 	/* To track extra statistic (if supported) */
171 	void (*dma_diagnostic_fr) (void *data, struct stmmac_extra_stats *x,
172 				   void __iomem *ioaddr);
173 	void (*enable_dma_transmission) (void __iomem *ioaddr);
174 	void (*enable_dma_irq)(void __iomem *ioaddr, u32 chan);
175 	void (*disable_dma_irq)(void __iomem *ioaddr, u32 chan);
176 	void (*start_tx)(void __iomem *ioaddr, u32 chan);
177 	void (*stop_tx)(void __iomem *ioaddr, u32 chan);
178 	void (*start_rx)(void __iomem *ioaddr, u32 chan);
179 	void (*stop_rx)(void __iomem *ioaddr, u32 chan);
180 	int (*dma_interrupt) (void __iomem *ioaddr,
181 			      struct stmmac_extra_stats *x, u32 chan);
182 	/* If supported then get the optional core features */
183 	void (*get_hw_feature)(void __iomem *ioaddr,
184 			       struct dma_features *dma_cap);
185 	/* Program the HW RX Watchdog */
186 	void (*rx_watchdog)(void __iomem *ioaddr, u32 riwt, u32 number_chan);
187 	void (*set_tx_ring_len)(void __iomem *ioaddr, u32 len, u32 chan);
188 	void (*set_rx_ring_len)(void __iomem *ioaddr, u32 len, u32 chan);
189 	void (*set_rx_tail_ptr)(void __iomem *ioaddr, u32 tail_ptr, u32 chan);
190 	void (*set_tx_tail_ptr)(void __iomem *ioaddr, u32 tail_ptr, u32 chan);
191 	void (*enable_tso)(void __iomem *ioaddr, bool en, u32 chan);
192 	void (*qmode)(void __iomem *ioaddr, u32 channel, u8 qmode);
193 	void (*set_bfsize)(void __iomem *ioaddr, int bfsize, u32 chan);
194 };
195 
196 #define stmmac_reset(__priv, __args...) \
197 	stmmac_do_callback(__priv, dma, reset, __args)
198 #define stmmac_dma_init(__priv, __args...) \
199 	stmmac_do_void_callback(__priv, dma, init, __args)
200 #define stmmac_init_chan(__priv, __args...) \
201 	stmmac_do_void_callback(__priv, dma, init_chan, __args)
202 #define stmmac_init_rx_chan(__priv, __args...) \
203 	stmmac_do_void_callback(__priv, dma, init_rx_chan, __args)
204 #define stmmac_init_tx_chan(__priv, __args...) \
205 	stmmac_do_void_callback(__priv, dma, init_tx_chan, __args)
206 #define stmmac_axi(__priv, __args...) \
207 	stmmac_do_void_callback(__priv, dma, axi, __args)
208 #define stmmac_dump_dma_regs(__priv, __args...) \
209 	stmmac_do_void_callback(__priv, dma, dump_regs, __args)
210 #define stmmac_dma_rx_mode(__priv, __args...) \
211 	stmmac_do_void_callback(__priv, dma, dma_rx_mode, __args)
212 #define stmmac_dma_tx_mode(__priv, __args...) \
213 	stmmac_do_void_callback(__priv, dma, dma_tx_mode, __args)
214 #define stmmac_dma_diagnostic_fr(__priv, __args...) \
215 	stmmac_do_void_callback(__priv, dma, dma_diagnostic_fr, __args)
216 #define stmmac_enable_dma_transmission(__priv, __args...) \
217 	stmmac_do_void_callback(__priv, dma, enable_dma_transmission, __args)
218 #define stmmac_enable_dma_irq(__priv, __args...) \
219 	stmmac_do_void_callback(__priv, dma, enable_dma_irq, __args)
220 #define stmmac_disable_dma_irq(__priv, __args...) \
221 	stmmac_do_void_callback(__priv, dma, disable_dma_irq, __args)
222 #define stmmac_start_tx(__priv, __args...) \
223 	stmmac_do_void_callback(__priv, dma, start_tx, __args)
224 #define stmmac_stop_tx(__priv, __args...) \
225 	stmmac_do_void_callback(__priv, dma, stop_tx, __args)
226 #define stmmac_start_rx(__priv, __args...) \
227 	stmmac_do_void_callback(__priv, dma, start_rx, __args)
228 #define stmmac_stop_rx(__priv, __args...) \
229 	stmmac_do_void_callback(__priv, dma, stop_rx, __args)
230 #define stmmac_dma_interrupt_status(__priv, __args...) \
231 	stmmac_do_callback(__priv, dma, dma_interrupt, __args)
232 #define stmmac_get_hw_feature(__priv, __args...) \
233 	stmmac_do_void_callback(__priv, dma, get_hw_feature, __args)
234 #define stmmac_rx_watchdog(__priv, __args...) \
235 	stmmac_do_void_callback(__priv, dma, rx_watchdog, __args)
236 #define stmmac_set_tx_ring_len(__priv, __args...) \
237 	stmmac_do_void_callback(__priv, dma, set_tx_ring_len, __args)
238 #define stmmac_set_rx_ring_len(__priv, __args...) \
239 	stmmac_do_void_callback(__priv, dma, set_rx_ring_len, __args)
240 #define stmmac_set_rx_tail_ptr(__priv, __args...) \
241 	stmmac_do_void_callback(__priv, dma, set_rx_tail_ptr, __args)
242 #define stmmac_set_tx_tail_ptr(__priv, __args...) \
243 	stmmac_do_void_callback(__priv, dma, set_tx_tail_ptr, __args)
244 #define stmmac_enable_tso(__priv, __args...) \
245 	stmmac_do_void_callback(__priv, dma, enable_tso, __args)
246 #define stmmac_dma_qmode(__priv, __args...) \
247 	stmmac_do_void_callback(__priv, dma, qmode, __args)
248 #define stmmac_set_dma_bfsize(__priv, __args...) \
249 	stmmac_do_void_callback(__priv, dma, set_bfsize, __args)
250 
251 struct mac_device_info;
252 struct net_device;
253 struct rgmii_adv;
254 struct stmmac_safety_stats;
255 struct stmmac_tc_entry;
256 struct stmmac_pps_cfg;
257 struct stmmac_rss;
258 
259 /* Helpers to program the MAC core */
260 struct stmmac_ops {
261 	/* MAC core initialization */
262 	void (*core_init)(struct mac_device_info *hw, struct net_device *dev);
263 	/* Enable the MAC RX/TX */
264 	void (*set_mac)(void __iomem *ioaddr, bool enable);
265 	/* Enable and verify that the IPC module is supported */
266 	int (*rx_ipc)(struct mac_device_info *hw);
267 	/* Enable RX Queues */
268 	void (*rx_queue_enable)(struct mac_device_info *hw, u8 mode, u32 queue);
269 	/* RX Queues Priority */
270 	void (*rx_queue_prio)(struct mac_device_info *hw, u32 prio, u32 queue);
271 	/* TX Queues Priority */
272 	void (*tx_queue_prio)(struct mac_device_info *hw, u32 prio, u32 queue);
273 	/* RX Queues Routing */
274 	void (*rx_queue_routing)(struct mac_device_info *hw, u8 packet,
275 				 u32 queue);
276 	/* Program RX Algorithms */
277 	void (*prog_mtl_rx_algorithms)(struct mac_device_info *hw, u32 rx_alg);
278 	/* Program TX Algorithms */
279 	void (*prog_mtl_tx_algorithms)(struct mac_device_info *hw, u32 tx_alg);
280 	/* Set MTL TX queues weight */
281 	void (*set_mtl_tx_queue_weight)(struct mac_device_info *hw,
282 					u32 weight, u32 queue);
283 	/* RX MTL queue to RX dma mapping */
284 	void (*map_mtl_to_dma)(struct mac_device_info *hw, u32 queue, u32 chan);
285 	/* Configure AV Algorithm */
286 	void (*config_cbs)(struct mac_device_info *hw, u32 send_slope,
287 			   u32 idle_slope, u32 high_credit, u32 low_credit,
288 			   u32 queue);
289 	/* Dump MAC registers */
290 	void (*dump_regs)(struct mac_device_info *hw, u32 *reg_space);
291 	/* Handle extra events on specific interrupts hw dependent */
292 	int (*host_irq_status)(struct mac_device_info *hw,
293 			       struct stmmac_extra_stats *x);
294 	/* Handle MTL interrupts */
295 	int (*host_mtl_irq_status)(struct mac_device_info *hw, u32 chan);
296 	/* Multicast filter setting */
297 	void (*set_filter)(struct mac_device_info *hw, struct net_device *dev);
298 	/* Flow control setting */
299 	void (*flow_ctrl)(struct mac_device_info *hw, unsigned int duplex,
300 			  unsigned int fc, unsigned int pause_time, u32 tx_cnt);
301 	/* Set power management mode (e.g. magic frame) */
302 	void (*pmt)(struct mac_device_info *hw, unsigned long mode);
303 	/* Set/Get Unicast MAC addresses */
304 	void (*set_umac_addr)(struct mac_device_info *hw, unsigned char *addr,
305 			      unsigned int reg_n);
306 	void (*get_umac_addr)(struct mac_device_info *hw, unsigned char *addr,
307 			      unsigned int reg_n);
308 	void (*set_eee_mode)(struct mac_device_info *hw,
309 			     bool en_tx_lpi_clockgating);
310 	void (*reset_eee_mode)(struct mac_device_info *hw);
311 	void (*set_eee_timer)(struct mac_device_info *hw, int ls, int tw);
312 	void (*set_eee_pls)(struct mac_device_info *hw, int link);
313 	void (*debug)(void __iomem *ioaddr, struct stmmac_extra_stats *x,
314 		      u32 rx_queues, u32 tx_queues);
315 	/* PCS calls */
316 	void (*pcs_ctrl_ane)(void __iomem *ioaddr, bool ane, bool srgmi_ral,
317 			     bool loopback);
318 	void (*pcs_rane)(void __iomem *ioaddr, bool restart);
319 	void (*pcs_get_adv_lp)(void __iomem *ioaddr, struct rgmii_adv *adv);
320 	/* Safety Features */
321 	int (*safety_feat_config)(void __iomem *ioaddr, unsigned int asp);
322 	int (*safety_feat_irq_status)(struct net_device *ndev,
323 			void __iomem *ioaddr, unsigned int asp,
324 			struct stmmac_safety_stats *stats);
325 	int (*safety_feat_dump)(struct stmmac_safety_stats *stats,
326 			int index, unsigned long *count, const char **desc);
327 	/* Flexible RX Parser */
328 	int (*rxp_config)(void __iomem *ioaddr, struct stmmac_tc_entry *entries,
329 			  unsigned int count);
330 	/* Flexible PPS */
331 	int (*flex_pps_config)(void __iomem *ioaddr, int index,
332 			       struct stmmac_pps_cfg *cfg, bool enable,
333 			       u32 sub_second_inc, u32 systime_flags);
334 	/* Loopback for selftests */
335 	void (*set_mac_loopback)(void __iomem *ioaddr, bool enable);
336 	/* RSS */
337 	int (*rss_configure)(struct mac_device_info *hw,
338 			     struct stmmac_rss *cfg, u32 num_rxq);
339 	/* VLAN */
340 	void (*update_vlan_hash)(struct mac_device_info *hw, u32 hash,
341 				 bool is_double);
342 	/* TX Timestamp */
343 	int (*get_mac_tx_timestamp)(struct mac_device_info *hw, u64 *ts);
344 };
345 
346 #define stmmac_core_init(__priv, __args...) \
347 	stmmac_do_void_callback(__priv, mac, core_init, __args)
348 #define stmmac_mac_set(__priv, __args...) \
349 	stmmac_do_void_callback(__priv, mac, set_mac, __args)
350 #define stmmac_rx_ipc(__priv, __args...) \
351 	stmmac_do_callback(__priv, mac, rx_ipc, __args)
352 #define stmmac_rx_queue_enable(__priv, __args...) \
353 	stmmac_do_void_callback(__priv, mac, rx_queue_enable, __args)
354 #define stmmac_rx_queue_prio(__priv, __args...) \
355 	stmmac_do_void_callback(__priv, mac, rx_queue_prio, __args)
356 #define stmmac_tx_queue_prio(__priv, __args...) \
357 	stmmac_do_void_callback(__priv, mac, tx_queue_prio, __args)
358 #define stmmac_rx_queue_routing(__priv, __args...) \
359 	stmmac_do_void_callback(__priv, mac, rx_queue_routing, __args)
360 #define stmmac_prog_mtl_rx_algorithms(__priv, __args...) \
361 	stmmac_do_void_callback(__priv, mac, prog_mtl_rx_algorithms, __args)
362 #define stmmac_prog_mtl_tx_algorithms(__priv, __args...) \
363 	stmmac_do_void_callback(__priv, mac, prog_mtl_tx_algorithms, __args)
364 #define stmmac_set_mtl_tx_queue_weight(__priv, __args...) \
365 	stmmac_do_void_callback(__priv, mac, set_mtl_tx_queue_weight, __args)
366 #define stmmac_map_mtl_to_dma(__priv, __args...) \
367 	stmmac_do_void_callback(__priv, mac, map_mtl_to_dma, __args)
368 #define stmmac_config_cbs(__priv, __args...) \
369 	stmmac_do_void_callback(__priv, mac, config_cbs, __args)
370 #define stmmac_dump_mac_regs(__priv, __args...) \
371 	stmmac_do_void_callback(__priv, mac, dump_regs, __args)
372 #define stmmac_host_irq_status(__priv, __args...) \
373 	stmmac_do_callback(__priv, mac, host_irq_status, __args)
374 #define stmmac_host_mtl_irq_status(__priv, __args...) \
375 	stmmac_do_callback(__priv, mac, host_mtl_irq_status, __args)
376 #define stmmac_set_filter(__priv, __args...) \
377 	stmmac_do_void_callback(__priv, mac, set_filter, __args)
378 #define stmmac_flow_ctrl(__priv, __args...) \
379 	stmmac_do_void_callback(__priv, mac, flow_ctrl, __args)
380 #define stmmac_pmt(__priv, __args...) \
381 	stmmac_do_void_callback(__priv, mac, pmt, __args)
382 #define stmmac_set_umac_addr(__priv, __args...) \
383 	stmmac_do_void_callback(__priv, mac, set_umac_addr, __args)
384 #define stmmac_get_umac_addr(__priv, __args...) \
385 	stmmac_do_void_callback(__priv, mac, get_umac_addr, __args)
386 #define stmmac_set_eee_mode(__priv, __args...) \
387 	stmmac_do_void_callback(__priv, mac, set_eee_mode, __args)
388 #define stmmac_reset_eee_mode(__priv, __args...) \
389 	stmmac_do_void_callback(__priv, mac, reset_eee_mode, __args)
390 #define stmmac_set_eee_timer(__priv, __args...) \
391 	stmmac_do_void_callback(__priv, mac, set_eee_timer, __args)
392 #define stmmac_set_eee_pls(__priv, __args...) \
393 	stmmac_do_void_callback(__priv, mac, set_eee_pls, __args)
394 #define stmmac_mac_debug(__priv, __args...) \
395 	stmmac_do_void_callback(__priv, mac, debug, __args)
396 #define stmmac_pcs_ctrl_ane(__priv, __args...) \
397 	stmmac_do_void_callback(__priv, mac, pcs_ctrl_ane, __args)
398 #define stmmac_pcs_rane(__priv, __args...) \
399 	stmmac_do_void_callback(__priv, mac, pcs_rane, __args)
400 #define stmmac_pcs_get_adv_lp(__priv, __args...) \
401 	stmmac_do_void_callback(__priv, mac, pcs_get_adv_lp, __args)
402 #define stmmac_safety_feat_config(__priv, __args...) \
403 	stmmac_do_callback(__priv, mac, safety_feat_config, __args)
404 #define stmmac_safety_feat_irq_status(__priv, __args...) \
405 	stmmac_do_callback(__priv, mac, safety_feat_irq_status, __args)
406 #define stmmac_safety_feat_dump(__priv, __args...) \
407 	stmmac_do_callback(__priv, mac, safety_feat_dump, __args)
408 #define stmmac_rxp_config(__priv, __args...) \
409 	stmmac_do_callback(__priv, mac, rxp_config, __args)
410 #define stmmac_flex_pps_config(__priv, __args...) \
411 	stmmac_do_callback(__priv, mac, flex_pps_config, __args)
412 #define stmmac_set_mac_loopback(__priv, __args...) \
413 	stmmac_do_void_callback(__priv, mac, set_mac_loopback, __args)
414 #define stmmac_rss_configure(__priv, __args...) \
415 	stmmac_do_callback(__priv, mac, rss_configure, __args)
416 #define stmmac_update_vlan_hash(__priv, __args...) \
417 	stmmac_do_void_callback(__priv, mac, update_vlan_hash, __args)
418 #define stmmac_get_mac_tx_timestamp(__priv, __args...) \
419 	stmmac_do_callback(__priv, mac, get_mac_tx_timestamp, __args)
420 
421 /* PTP and HW Timer helpers */
422 struct stmmac_hwtimestamp {
423 	void (*config_hw_tstamping) (void __iomem *ioaddr, u32 data);
424 	void (*config_sub_second_increment)(void __iomem *ioaddr, u32 ptp_clock,
425 					   int gmac4, u32 *ssinc);
426 	int (*init_systime) (void __iomem *ioaddr, u32 sec, u32 nsec);
427 	int (*config_addend) (void __iomem *ioaddr, u32 addend);
428 	int (*adjust_systime) (void __iomem *ioaddr, u32 sec, u32 nsec,
429 			       int add_sub, int gmac4);
430 	void (*get_systime) (void __iomem *ioaddr, u64 *systime);
431 };
432 
433 #define stmmac_config_hw_tstamping(__priv, __args...) \
434 	stmmac_do_void_callback(__priv, ptp, config_hw_tstamping, __args)
435 #define stmmac_config_sub_second_increment(__priv, __args...) \
436 	stmmac_do_void_callback(__priv, ptp, config_sub_second_increment, __args)
437 #define stmmac_init_systime(__priv, __args...) \
438 	stmmac_do_callback(__priv, ptp, init_systime, __args)
439 #define stmmac_config_addend(__priv, __args...) \
440 	stmmac_do_callback(__priv, ptp, config_addend, __args)
441 #define stmmac_adjust_systime(__priv, __args...) \
442 	stmmac_do_callback(__priv, ptp, adjust_systime, __args)
443 #define stmmac_get_systime(__priv, __args...) \
444 	stmmac_do_void_callback(__priv, ptp, get_systime, __args)
445 
446 /* Helpers to manage the descriptors for chain and ring modes */
447 struct stmmac_mode_ops {
448 	void (*init) (void *des, dma_addr_t phy_addr, unsigned int size,
449 		      unsigned int extend_desc);
450 	unsigned int (*is_jumbo_frm) (int len, int ehn_desc);
451 	int (*jumbo_frm)(void *priv, struct sk_buff *skb, int csum);
452 	int (*set_16kib_bfsize)(int mtu);
453 	void (*init_desc3)(struct dma_desc *p);
454 	void (*refill_desc3) (void *priv, struct dma_desc *p);
455 	void (*clean_desc3) (void *priv, struct dma_desc *p);
456 };
457 
458 #define stmmac_mode_init(__priv, __args...) \
459 	stmmac_do_void_callback(__priv, mode, init, __args)
460 #define stmmac_is_jumbo_frm(__priv, __args...) \
461 	stmmac_do_callback(__priv, mode, is_jumbo_frm, __args)
462 #define stmmac_jumbo_frm(__priv, __args...) \
463 	stmmac_do_callback(__priv, mode, jumbo_frm, __args)
464 #define stmmac_set_16kib_bfsize(__priv, __args...) \
465 	stmmac_do_callback(__priv, mode, set_16kib_bfsize, __args)
466 #define stmmac_init_desc3(__priv, __args...) \
467 	stmmac_do_void_callback(__priv, mode, init_desc3, __args)
468 #define stmmac_refill_desc3(__priv, __args...) \
469 	stmmac_do_void_callback(__priv, mode, refill_desc3, __args)
470 #define stmmac_clean_desc3(__priv, __args...) \
471 	stmmac_do_void_callback(__priv, mode, clean_desc3, __args)
472 
473 struct stmmac_priv;
474 struct tc_cls_u32_offload;
475 struct tc_cbs_qopt_offload;
476 
477 struct stmmac_tc_ops {
478 	int (*init)(struct stmmac_priv *priv);
479 	int (*setup_cls_u32)(struct stmmac_priv *priv,
480 			     struct tc_cls_u32_offload *cls);
481 	int (*setup_cbs)(struct stmmac_priv *priv,
482 			 struct tc_cbs_qopt_offload *qopt);
483 };
484 
485 #define stmmac_tc_init(__priv, __args...) \
486 	stmmac_do_callback(__priv, tc, init, __args)
487 #define stmmac_tc_setup_cls_u32(__priv, __args...) \
488 	stmmac_do_callback(__priv, tc, setup_cls_u32, __args)
489 #define stmmac_tc_setup_cbs(__priv, __args...) \
490 	stmmac_do_callback(__priv, tc, setup_cbs, __args)
491 
492 struct stmmac_counters;
493 
494 struct stmmac_mmc_ops {
495 	void (*ctrl)(void __iomem *ioaddr, unsigned int mode);
496 	void (*intr_all_mask)(void __iomem *ioaddr);
497 	void (*read)(void __iomem *ioaddr, struct stmmac_counters *mmc);
498 };
499 
500 #define stmmac_mmc_ctrl(__priv, __args...) \
501 	stmmac_do_void_callback(__priv, mmc, ctrl, __args)
502 #define stmmac_mmc_intr_all_mask(__priv, __args...) \
503 	stmmac_do_void_callback(__priv, mmc, intr_all_mask, __args)
504 #define stmmac_mmc_read(__priv, __args...) \
505 	stmmac_do_void_callback(__priv, mmc, read, __args)
506 
507 struct stmmac_regs_off {
508 	u32 ptp_off;
509 	u32 mmc_off;
510 };
511 
512 extern const struct stmmac_ops dwmac100_ops;
513 extern const struct stmmac_dma_ops dwmac100_dma_ops;
514 extern const struct stmmac_ops dwmac1000_ops;
515 extern const struct stmmac_dma_ops dwmac1000_dma_ops;
516 extern const struct stmmac_ops dwmac4_ops;
517 extern const struct stmmac_dma_ops dwmac4_dma_ops;
518 extern const struct stmmac_ops dwmac410_ops;
519 extern const struct stmmac_dma_ops dwmac410_dma_ops;
520 extern const struct stmmac_ops dwmac510_ops;
521 extern const struct stmmac_tc_ops dwmac510_tc_ops;
522 extern const struct stmmac_ops dwxgmac210_ops;
523 extern const struct stmmac_dma_ops dwxgmac210_dma_ops;
524 extern const struct stmmac_desc_ops dwxgmac210_desc_ops;
525 extern const struct stmmac_mmc_ops dwmac_mmc_ops;
526 extern const struct stmmac_mmc_ops dwxgmac_mmc_ops;
527 
528 #define GMAC_VERSION		0x00000020	/* GMAC CORE Version */
529 #define GMAC4_VERSION		0x00000110	/* GMAC4+ CORE Version */
530 
531 int stmmac_hwif_init(struct stmmac_priv *priv);
532 
533 #endif /* __STMMAC_HWIF_H__ */
534