path: root/include/linux/stmmac.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*******************************************************************************

  Header file for stmmac platform data

  Copyright (C) 2009  STMicroelectronics Ltd


  Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
*******************************************************************************/

#ifndef __STMMAC_PLATFORM_DATA
#define __STMMAC_PLATFORM_DATA

#include <linux/platform_device.h>
#include <linux/phylink.h>

#define MTL_MAX_RX_QUEUES	8
#define MTL_MAX_TX_QUEUES	8
#define STMMAC_CH_MAX		8

#define STMMAC_RX_COE_NONE	0
#define STMMAC_RX_COE_TYPE1	1
#define STMMAC_RX_COE_TYPE2	2

/* Define the macros for CSR clock range parameters to be passed by
 * platform code.
 * This could also be configured at run time using CPU freq framework. */

/* MDC Clock Selection define*/
#define	STMMAC_CSR_60_100M	0x0	/* MDC = clk_csr_i/42 */
#define	STMMAC_CSR_100_150M	0x1	/* MDC = clk_csr_i/62 */
#define	STMMAC_CSR_20_35M	0x2	/* MDC = clk_csr_i/16 */
#define	STMMAC_CSR_35_60M	0x3	/* MDC = clk_csr_i/26 */
#define	STMMAC_CSR_150_250M	0x4	/* MDC = clk_csr_i/102 */
#define	STMMAC_CSR_250_300M	0x5	/* MDC = clk_csr_i/124 */
#define	STMMAC_CSR_300_500M	0x6	/* MDC = clk_csr_i/204 */
#define	STMMAC_CSR_500_800M	0x7	/* MDC = clk_csr_i/324 */

/* MTL algorithms identifiers */
#define MTL_TX_ALGORITHM_WRR	0x0
#define MTL_TX_ALGORITHM_WFQ	0x1
#define MTL_TX_ALGORITHM_DWRR	0x2
#define MTL_TX_ALGORITHM_SP	0x3
#define MTL_RX_ALGORITHM_SP	0x4
#define MTL_RX_ALGORITHM_WSP	0x5

/* RX/TX Queue Mode */
#define MTL_QUEUE_AVB		0x0
#define MTL_QUEUE_DCB		0x1

/* The MDC clock could be set higher than the IEEE 802.3
 * specified frequency limit 0f 2.5 MHz, by programming a clock divider
 * of value different than the above defined values. The resultant MDIO
 * clock frequency of 12.5 MHz is applicable for the interfacing chips
 * supporting higher MDC clocks.
 * The MDC clock selection macros need to be defined for MDC clock rate
 * of 12.5 MHz, corresponding to the following selection.
 */
#define STMMAC_CSR_I_4		0x8	/* clk_csr_i/4 */
#define STMMAC_CSR_I_6		0x9	/* clk_csr_i/6 */
#define STMMAC_CSR_I_8		0xA	/* clk_csr_i/8 */
#define STMMAC_CSR_I_10		0xB	/* clk_csr_i/10 */
#define STMMAC_CSR_I_12		0xC	/* clk_csr_i/12 */
#define STMMAC_CSR_I_14		0xD	/* clk_csr_i/14 */
#define STMMAC_CSR_I_16		0xE	/* clk_csr_i/16 */
#define STMMAC_CSR_I_18		0xF	/* clk_csr_i/18 */

/* AXI DMA Burst length supported */
#define DMA_AXI_BLEN_4		(1 << 1)
#define DMA_AXI_BLEN_8		(1 << 2)
#define DMA_AXI_BLEN_16		(1 << 3)
#define DMA_AXI_BLEN_32		(1 << 4)
#define DMA_AXI_BLEN_64		(1 << 5)
#define DMA_AXI_BLEN_128	(1 << 6)
#define DMA_AXI_BLEN_256	(1 << 7)
#define DMA_AXI_BLEN_ALL (DMA_AXI_BLEN_4 | DMA_AXI_BLEN_8 | DMA_AXI_BLEN_16 \
			| DMA_AXI_BLEN_32 | DMA_AXI_BLEN_64 \
			| DMA_AXI_BLEN_128 | DMA_AXI_BLEN_256)

struct clk;
struct stmmac_priv;

/* Platfrom data for platform device structure's platform_data field */

struct stmmac_mdio_bus_data {
	u32 phy_mask;
	u32 pcs_mask;
	int *irqs;
	int probed_phy_irq;
	bool needs_reset;
};

struct stmmac_dma_cfg {
	/* pbl: programmable burst limit
	 * txpbl: transmit programmable burst limit
	 * rxpbl: receive programmable burst limit
	 * If txpbl or rxpbl are zero, the value of pbl will be substituted.
	 * Range 0 - 63.
	 */
	int pbl;
	int txpbl;
	int rxpbl;
	/* pblx8: multiplies pbl, txpbl, rxpbl by a factor of 8 for dwmac >=
	 * 3.50a, or a factor of 4 for previous versions.
	 */
	bool pblx8;
	/* fixed_burst:
	 *  when set, AXI bursts defined by axi_blen_regval are permitted.
	 *   AHB uses SINGLE, INCR4, INCR8 or INCR16 during burst transfers.
	 *  when clear, AXI and AHB use SINGLE or INCR bursts.
	 */
	bool fixed_burst;
	/* mixed_burst:
	 *  when set and fixed_burst is clear, AHB uses INCR for bursts > 16
	 *  and SINGLE or INCRx for bursts <= 16.
	 */
	bool mixed_burst;
	/* aal: address aligned bursts for AHB and AXI master interface */
	bool aal;
	bool dche;
	bool eame;
	/* multi_msi_en: stmmac core internal */
	bool multi_msi_en;
	/* atds: stmmac core internal */
	bool atds;
};

#define AXI_BLEN	7
struct stmmac_axi {
	u32 axi_wr_osr_lmt;
	u32 axi_rd_osr_lmt;
	u32 axi_blen_regval;
	bool axi_lpi_en;
	bool axi_xit_frm;
	bool axi_fb;
};

struct stmmac_rxq_cfg {
	u32 chan;
	u32 prio;
	u8 mode_to_use;
	u8 pkt_route;
	bool use_prio;
};

struct stmmac_txq_cfg {
	u32 weight;
	/* Credit Base Shaper parameters */
	u32 send_slope;
	u32 idle_slope;
	u32 high_credit;
	u32 low_credit;
	u32 prio;
	int tbs_en;
	bool use_prio;
	bool coe_unsupported;
	u8 mode_to_use;
};

struct stmmac_safety_feature_cfg {
	u32 tsoee;
	u32 mrxpee;
	u32 mestee;
	u32 mrxee;
	u32 mtxee;
	u32 epsi;
	u32 edpp;
	u32 prtyen;
	u32 tmouten;
};

/* Addresses that may be customized by a platform */
struct dwmac4_addrs {
	u32 dma_chan;
	u32 dma_chan_offset;
	u32 mtl_chan;
	u32 mtl_chan_offset;
	u32 mtl_ets_ctrl;
	u32 mtl_ets_ctrl_offset;
	u32 mtl_txq_weight;
	u32 mtl_txq_weight_offset;
	u32 mtl_send_slp_cred;
	u32 mtl_send_slp_cred_offset;
	u32 mtl_high_cred;
	u32 mtl_high_cred_offset;
	u32 mtl_low_cred;
	u32 mtl_low_cred_offset;
};

enum dwmac_core_type {
	DWMAC_CORE_MAC100,
	DWMAC_CORE_GMAC,
	DWMAC_CORE_GMAC4,
	DWMAC_CORE_XGMAC,
};

#define STMMAC_FLAG_SPH_DISABLE			BIT(1)
#define STMMAC_FLAG_USE_PHY_WOL			BIT(2)
#define STMMAC_FLAG_HAS_SUN8I			BIT(3)
#define STMMAC_FLAG_TSO_EN			BIT(4)
#define STMMAC_FLAG_SERDES_UP_AFTER_PHY_LINKUP	BIT(5)
#define STMMAC_FLAG_VLAN_FAIL_Q_EN		BIT(6)
#define STMMAC_FLAG_MULTI_MSI_EN		BIT(7)
#define STMMAC_FLAG_EXT_SNAPSHOT_EN		BIT(8)
#define STMMAC_FLAG_INT_SNAPSHOT_EN		BIT(9)
#define STMMAC_FLAG_EEE_DISABLE			BIT(10)
#define STMMAC_FLAG_RX_CLK_RUNS_IN_LPI		BIT(11)
#define STMMAC_FLAG_EN_TX_LPI_CLOCKGATING	BIT(12)
#define STMMAC_FLAG_EN_TX_LPI_CLK_PHY_CAP	BIT(13)
#define STMMAC_FLAG_HWTSTAMP_CORRECT_LATENCY	BIT(14)
#define STMMAC_FLAG_KEEP_PREAMBLE_BEFORE_SFD	BIT(15)
#define STMMAC_FLAG_SERDES_SUPPORTS_2500M	BIT(16)

struct mac_device_info;

struct plat_stmmacenet_data {
	enum dwmac_core_type core_type;
	int bus_id;
	int phy_addr;
	/* MAC ----- optional PCS ----- SerDes ----- optional PHY ----- Media
	 *                                       ^
	 *                                  phy_interface
	 *
	 * The Synopsys dwmac core only covers the MAC and an optional
	 * integrated PCS. Where the integrated PCS is used with a SerDes,
	 * e.g. for 1000base-X or Cisco SGMII, the connection between the
	 * PCS and SerDes will be TBI.
	 *
	 * Where the Synopsys dwmac core has been instantiated with multiple
	 * interface modes, these are selected via core-external configuration
	 * which is sampled when the dwmac core is reset. How this is done is
	 * platform glue specific, but this defines the interface used from
	 * the Synopsys dwmac core to the rest of the SoC.
	 *
	 * Where PCS other than the optional integrated Synopsys dwmac PCS
	 * is used, this counts as "the rest of the SoC" in the above
	 * paragraph.
	 *
	 * phy_interface is the PHY-side interface - the interface used by
	 * an attached PHY or SFP etc. This is equivalent to the interface
	 * that phylink uses.
	 */
	phy_interface_t phy_interface;
	struct stmmac_mdio_bus_data *mdio_bus_data;
	struct device_node *phy_node;
	struct device_node *mdio_node;
	struct stmmac_dma_cfg *dma_cfg;
	struct stmmac_safety_feature_cfg *safety_feat_cfg;
	int clk_csr;
	bool default_an_inband;
	bool enh_desc;
	bool tx_coe;
	bool bugged_jumbo;
	bool pmt;
	bool force_sf_dma_mode;
	bool force_thresh_dma_mode;
	bool riwt_off;
	int rx_coe;
	int max_speed;
	int maxmtu;
	int multicast_filter_bins;
	int unicast_filter_entries;
	int tx_fifo_size;
	int rx_fifo_size;
	u8 host_dma_width;
	u8 rx_queues_to_use;
	u8 tx_queues_to_use;
	u8 rx_sched_algorithm;
	u8 tx_sched_algorithm;
	struct stmmac_rxq_cfg rx_queues_cfg[MTL_MAX_RX_QUEUES];
	struct stmmac_txq_cfg tx_queues_cfg[MTL_MAX_TX_QUEUES];
	void (*get_interfaces)(struct stmmac_priv *priv, void *bsp_priv,
			       unsigned long *interfaces);
	int (*set_phy_intf_sel)(void *priv, u8 phy_intf_sel);
	int (*set_clk_tx_rate)(void *priv, struct clk *clk_tx_i,
			       phy_interface_t interface, int speed);
	void (*fix_mac_speed)(void *priv, phy_interface_t interface,
			      int speed, unsigned int mode);
	int (*fix_soc_reset)(struct stmmac_priv *priv);
	int (*serdes_powerup)(struct net_device *ndev, void *priv);
	void (*serdes_powerdown)(struct net_device *ndev, void *priv);
	int (*mac_finish)(struct net_device *ndev,
			  void *priv,
			  unsigned int mode,
			  phy_interface_t interface);
	void (*ptp_clk_freq_config)(struct stmmac_priv *priv);
	int (*init)(struct device *dev, void *priv);
	void (*exit)(struct device *dev, void *priv);
	int (*suspend)(struct device *dev, void *priv);
	int (*resume)(struct device *dev, void *priv);
	int (*mac_setup)(void *priv, struct mac_device_info *mac);
	int (*clks_config)(void *priv, bool enabled);
	int (*crosststamp)(ktime_t *device, struct system_counterval_t *system,
			   void *ctx);
	void (*dump_debug_regs)(void *priv);
	int (*pcs_init)(struct stmmac_priv *priv);
	void (*pcs_exit)(struct stmmac_priv *priv);
	struct phylink_pcs *(*select_pcs)(struct stmmac_priv *priv,
					  phy_interface_t interface);
	void *bsp_priv;

	/* stmmac clocks:
	 *  stmmac_clk: CSR clock (which can be hclk_i, clk_csr_i, aclk_i,
	 *    or clk_app_i depending on GMAC configuration). This clock
	 *    generates the MDC clock.
	 *
	 *  pclk: introduced for Imagination Technologies Pistachio board -
	 *    see 5f9755d26fbf ("stmmac: Add an optional register interface
	 *    clock"). This is probably used for cases where separate clocks
	 *    are provided for the host interface and register interface. In
	 *    this case, as the MDC clock is derived from stmmac_clk, pclk
	 *    can only really be the "application clock" for the "host
	 *    interface" and not the "register interface" aka CSR clock as
	 *    it is never used when determining the divider for the MDC
	 *    clock.
	 *
	 *  clk_ptp_ref: optional PTP reference clock (clk_ptp_ref_i). When
	 *    present, this clock increments the timestamp value. Otherwise,
	 *    the rate of stmmac_clk will be used.
	 *
	 *  clk_tx_i: MAC transmit clock, which will be 2.5MHz for 10M,
	 *    25MHz for 100M, or 125MHz for 1G irrespective of the interface
	 *    mode. For the DWMAC PHY interface modes:
	 *
	 *    GMII/MII	PHY's transmit clock for 10M (2.5MHz) or 100M (25MHz),
	 *		or 125MHz local clock for 1G mode
	 *    RMII	50MHz RMII clock divided by 2 or 20.
	 *    RGMII	125MHz local clock divided by 1, 5, or 50.
	 *    SGMII	125MHz SerDes clock divided by 1, 5, or 50.
	 *    TBI/RTBI	125MHz SerDes clock
	 */
	struct clk *stmmac_clk;
	struct clk *pclk;
	struct clk *clk_ptp_ref;
	struct clk *clk_tx_i;
	unsigned long clk_ptp_rate;
	unsigned long clk_ref_rate;
	struct clk_bulk_data *clks;
	int num_clks;
	unsigned int mult_fact_100ns;
	s32 ptp_max_adj;
	u32 cdc_error_adj;
	struct reset_control *stmmac_rst;
	struct reset_control *stmmac_ahb_rst;
	struct stmmac_axi *axi;
	int rss_en;
	int mac_port_sel_speed;
	u8 vlan_fail_q;
	bool provide_bus_info;
	int int_snapshot_num;
	int msi_mac_vec;
	int msi_wol_vec;
	int msi_sfty_ce_vec;
	int msi_sfty_ue_vec;
	int msi_rx_base_vec;
	int msi_tx_base_vec;
	const struct dwmac4_addrs *dwmac4_addrs;
	unsigned int flags;
	struct stmmac_dma_cfg __dma_cfg;
};
#endif