hwif.h

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