1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*******************************************************************************
3 
4   Header file for stmmac platform data
5 
6   Copyright (C) 2009  STMicroelectronics Ltd
7 
8 
9   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
10 *******************************************************************************/
11 
12 #ifndef __STMMAC_PLATFORM_DATA
13 #define __STMMAC_PLATFORM_DATA
14 
15 #include <linux/platform_device.h>
16 #include <linux/phy.h>
17 
18 #define MTL_MAX_RX_QUEUES 8
19 #define MTL_MAX_TX_QUEUES 8
20 #define STMMAC_CH_MAX 8
21 
22 #define STMMAC_RX_COE_NONE 0
23 #define STMMAC_RX_COE_TYPE1 1
24 #define STMMAC_RX_COE_TYPE2 2
25 
26 /* Define the macros for CSR clock range parameters to be passed by
27  * platform code.
28  * This could also be configured at run time using CPU freq framework. */
29 
30 /* MDC Clock Selection define */
31 #define STMMAC_CSR_60_100M 0x0  /* MDC = clk_scr_i/42 */
32 #define STMMAC_CSR_100_150M 0x1 /* MDC = clk_scr_i/62 */
33 #define STMMAC_CSR_20_35M 0x2   /* MDC = clk_scr_i/16 */
34 #define STMMAC_CSR_35_60M 0x3   /* MDC = clk_scr_i/26 */
35 #define STMMAC_CSR_150_250M 0x4 /* MDC = clk_scr_i/102 */
36 #define STMMAC_CSR_250_300M 0x5 /* MDC = clk_scr_i/122 */
37 
38 /* MTL algorithms identifiers */
39 #define MTL_TX_ALGORITHM_WRR 0x0
40 #define MTL_TX_ALGORITHM_WFQ 0x1
41 #define MTL_TX_ALGORITHM_DWRR 0x2
42 #define MTL_TX_ALGORITHM_SP 0x3
43 #define MTL_RX_ALGORITHM_SP 0x4
44 #define MTL_RX_ALGORITHM_WSP 0x5
45 
46 /* RX/TX Queue Mode */
47 #define MTL_QUEUE_AVB 0x0
48 #define MTL_QUEUE_DCB 0x1
49 
50 /* The MDC clock could be set higher than the IEEE 802.3
51  * specified frequency limit 0f 2.5 MHz, by programming a clock divider
52  * of value different than the above defined values. The resultant MDIO
53  * clock frequency of 12.5 MHz is applicable for the interfacing chips
54  * supporting higher MDC clocks.
55  * The MDC clock selection macros need to be defined for MDC clock rate
56  * of 12.5 MHz, corresponding to the following selection.
57  */
58 #define STMMAC_CSR_I_4 0x8  /* clk_csr_i/4 */
59 #define STMMAC_CSR_I_6 0x9  /* clk_csr_i/6 */
60 #define STMMAC_CSR_I_8 0xA  /* clk_csr_i/8 */
61 #define STMMAC_CSR_I_10 0xB /* clk_csr_i/10 */
62 #define STMMAC_CSR_I_12 0xC /* clk_csr_i/12 */
63 #define STMMAC_CSR_I_14 0xD /* clk_csr_i/14 */
64 #define STMMAC_CSR_I_16 0xE /* clk_csr_i/16 */
65 #define STMMAC_CSR_I_18 0xF /* clk_csr_i/18 */
66 
67 /* AXI DMA Burst length supported */
68 #define DMA_AXI_BLEN_4 (1 << 1)
69 #define DMA_AXI_BLEN_8 (1 << 2)
70 #define DMA_AXI_BLEN_16 (1 << 3)
71 #define DMA_AXI_BLEN_32 (1 << 4)
72 #define DMA_AXI_BLEN_64 (1 << 5)
73 #define DMA_AXI_BLEN_128 (1 << 6)
74 #define DMA_AXI_BLEN_256 (1 << 7)
75 #define DMA_AXI_BLEN_ALL                                                                                               \
76     (DMA_AXI_BLEN_4 | DMA_AXI_BLEN_8 | DMA_AXI_BLEN_16 | DMA_AXI_BLEN_32 | DMA_AXI_BLEN_64 | DMA_AXI_BLEN_128 |        \
77      DMA_AXI_BLEN_256)
78 
79 /* Platfrom data for platform device structure's platform_data field */
80 
81 struct stmmac_mdio_bus_data {
82     unsigned int phy_mask;
83     unsigned int has_xpcs;
84     int *irqs;
85     int probed_phy_irq;
86     bool needs_reset;
87 };
88 
89 struct stmmac_dma_cfg {
90     int pbl;
91     int txpbl;
92     int rxpbl;
93     bool pblx8;
94     int fixed_burst;
95     int mixed_burst;
96     bool aal;
97     bool eame;
98 };
99 
100 #define AXI_BLEN 7
101 struct stmmac_axi {
102     bool axi_lpi_en;
103     bool axi_xit_frm;
104     u32 axi_wr_osr_lmt;
105     u32 axi_rd_osr_lmt;
106     bool axi_kbbe;
107     u32 axi_blen[AXI_BLEN];
108     bool axi_fb;
109     bool axi_mb;
110     bool axi_rb;
111 };
112 
113 #define EST_GCL 1024
114 struct stmmac_est {
115     struct mutex lock;
116     int enable;
117     u32 btr_offset[2];
118     u32 btr[2];
119     u32 ctr[2];
120     u32 ter;
121     u32 gcl_unaligned[EST_GCL];
122     u32 gcl[EST_GCL];
123     u32 gcl_size;
124 };
125 
126 struct stmmac_rxq_cfg {
127     u8 mode_to_use;
128     u32 chan;
129     u8 pkt_route;
130     bool use_prio;
131     u32 prio;
132 };
133 
134 struct stmmac_txq_cfg {
135     u32 weight;
136     u8 mode_to_use;
137     /* Credit Base Shaper parameters */
138     u32 send_slope;
139     u32 idle_slope;
140     u32 high_credit;
141     u32 low_credit;
142     bool use_prio;
143     u32 prio;
144     int tbs_en;
145 };
146 
147 struct plat_stmmacenet_data {
148     int bus_id;
149     int phy_addr;
150     int interface;
151     phy_interface_t phy_interface;
152     struct stmmac_mdio_bus_data *mdio_bus_data;
153     struct device_node *phy_node;
154     struct device_node *phylink_node;
155     struct device_node *mdio_node;
156     struct stmmac_dma_cfg *dma_cfg;
157     struct stmmac_est *est;
158     int clk_csr;
159     int has_gmac;
160     int enh_desc;
161     int tx_coe;
162     int rx_coe;
163     int bugged_jumbo;
164     int pmt;
165     int force_sf_dma_mode;
166     int force_thresh_dma_mode;
167     int riwt_off;
168     int max_speed;
169     int maxmtu;
170     int multicast_filter_bins;
171     int unicast_filter_entries;
172     int tx_fifo_size;
173     int rx_fifo_size;
174     u32 addr64;
175     u32 rx_queues_to_use;
176     u32 tx_queues_to_use;
177     u8 rx_sched_algorithm;
178     u8 tx_sched_algorithm;
179     struct stmmac_rxq_cfg rx_queues_cfg[MTL_MAX_RX_QUEUES];
180     struct stmmac_txq_cfg tx_queues_cfg[MTL_MAX_TX_QUEUES];
181     void (*fix_mac_speed)(void *priv, unsigned int speed);
182     int (*serdes_powerup)(struct net_device *ndev, void *priv);
183     void (*serdes_powerdown)(struct net_device *ndev, void *priv);
184     int (*init)(struct platform_device *pdev, void *priv);
185     void (*exit)(struct platform_device *pdev, void *priv);
186     void (*get_eth_addr)(void *priv, unsigned char *addr);
187     struct mac_device_info *(*setup)(void *priv);
188     void *bsp_priv;
189     struct clk *stmmac_clk;
190     struct clk *pclk;
191     struct clk *clk_ptp_ref;
192     unsigned int clk_ptp_rate;
193     unsigned int clk_ref_rate;
194     s32 ptp_max_adj;
195     struct reset_control *stmmac_rst;
196     struct stmmac_axi *axi;
197     int has_gmac4;
198     bool has_sun8i;
199     bool tso_en;
200     int rss_en;
201     int mac_port_sel_speed;
202     bool en_tx_lpi_clockgating;
203     int has_xgmac;
204     bool vlan_fail_q_en;
205     u8 vlan_fail_q;
206     unsigned int eee_usecs_rate;
207     bool sph_disable;
208 };
209 #endif
210