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