1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /******************************************************************************* 3 Copyright (C) 2007-2009 STMicroelectronics Ltd 4 5 6 Author: Giuseppe Cavallaro <peppe.cavallaro@st.com> 7 *******************************************************************************/ 8 9 #ifndef __STMMAC_H__ 10 #define __STMMAC_H__ 11 12 #define STMMAC_RESOURCE_NAME "stmmaceth" 13 #define DRV_MODULE_VERSION "Jan_2016" 14 15 #include <linux/clk.h> 16 #include <linux/hrtimer.h> 17 #include <linux/if_vlan.h> 18 #include <linux/stmmac.h> 19 #include <linux/phylink.h> 20 #include <linux/pci.h> 21 #include "common.h" 22 #include <linux/ptp_clock_kernel.h> 23 #include <linux/net_tstamp.h> 24 #include <linux/reset.h> 25 #include <net/page_pool.h> 26 27 struct stmmac_resources { 28 void __iomem *addr; 29 u8 mac[ETH_ALEN]; 30 int wol_irq; 31 int lpi_irq; 32 int irq; 33 int sfty_ce_irq; 34 int sfty_ue_irq; 35 int rx_irq[MTL_MAX_RX_QUEUES]; 36 int tx_irq[MTL_MAX_TX_QUEUES]; 37 }; 38 39 enum stmmac_txbuf_type { 40 STMMAC_TXBUF_T_SKB, 41 STMMAC_TXBUF_T_XDP_TX, 42 STMMAC_TXBUF_T_XDP_NDO, 43 STMMAC_TXBUF_T_XSK_TX, 44 }; 45 46 struct stmmac_tx_info { 47 dma_addr_t buf; 48 bool map_as_page; 49 unsigned len; 50 bool last_segment; 51 bool is_jumbo; 52 enum stmmac_txbuf_type buf_type; 53 }; 54 55 #define STMMAC_TBS_AVAIL BIT(0) 56 #define STMMAC_TBS_EN BIT(1) 57 58 /* Frequently used values are kept adjacent for cache effect */ 59 struct stmmac_tx_queue { 60 u32 tx_count_frames; 61 int tbs; 62 struct hrtimer txtimer; 63 u32 queue_index; 64 struct stmmac_priv *priv_data; 65 struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp; 66 struct dma_edesc *dma_entx; 67 struct dma_desc *dma_tx; 68 union { 69 struct sk_buff **tx_skbuff; 70 struct xdp_frame **xdpf; 71 }; 72 struct stmmac_tx_info *tx_skbuff_dma; 73 struct xsk_buff_pool *xsk_pool; 74 u32 xsk_frames_done; 75 unsigned int cur_tx; 76 unsigned int dirty_tx; 77 dma_addr_t dma_tx_phy; 78 dma_addr_t tx_tail_addr; 79 u32 mss; 80 }; 81 82 struct stmmac_rx_buffer { 83 union { 84 struct { 85 struct page *page; 86 dma_addr_t addr; 87 __u32 page_offset; 88 }; 89 struct xdp_buff *xdp; 90 }; 91 struct page *sec_page; 92 dma_addr_t sec_addr; 93 }; 94 95 struct stmmac_rx_queue { 96 u32 rx_count_frames; 97 u32 queue_index; 98 struct xdp_rxq_info xdp_rxq; 99 struct xsk_buff_pool *xsk_pool; 100 struct page_pool *page_pool; 101 struct stmmac_rx_buffer *buf_pool; 102 struct stmmac_priv *priv_data; 103 struct dma_extended_desc *dma_erx; 104 struct dma_desc *dma_rx ____cacheline_aligned_in_smp; 105 unsigned int cur_rx; 106 unsigned int dirty_rx; 107 unsigned int buf_alloc_num; 108 u32 rx_zeroc_thresh; 109 dma_addr_t dma_rx_phy; 110 u32 rx_tail_addr; 111 unsigned int state_saved; 112 struct { 113 struct sk_buff *skb; 114 unsigned int len; 115 unsigned int error; 116 } state; 117 }; 118 119 struct stmmac_channel { 120 struct napi_struct rx_napi ____cacheline_aligned_in_smp; 121 struct napi_struct tx_napi ____cacheline_aligned_in_smp; 122 struct napi_struct rxtx_napi ____cacheline_aligned_in_smp; 123 struct stmmac_priv *priv_data; 124 spinlock_t lock; 125 u32 index; 126 }; 127 128 struct stmmac_tc_entry { 129 bool in_use; 130 bool in_hw; 131 bool is_last; 132 bool is_frag; 133 void *frag_ptr; 134 unsigned int table_pos; 135 u32 handle; 136 u32 prio; 137 struct { 138 u32 match_data; 139 u32 match_en; 140 u8 af:1; 141 u8 rf:1; 142 u8 im:1; 143 u8 nc:1; 144 u8 res1:4; 145 u8 frame_offset; 146 u8 ok_index; 147 u8 dma_ch_no; 148 u32 res2; 149 } __packed val; 150 }; 151 152 #define STMMAC_PPS_MAX 4 153 struct stmmac_pps_cfg { 154 bool available; 155 struct timespec64 start; 156 struct timespec64 period; 157 }; 158 159 struct stmmac_rss { 160 int enable; 161 u8 key[STMMAC_RSS_HASH_KEY_SIZE]; 162 u32 table[STMMAC_RSS_MAX_TABLE_SIZE]; 163 }; 164 165 #define STMMAC_FLOW_ACTION_DROP BIT(0) 166 struct stmmac_flow_entry { 167 unsigned long cookie; 168 unsigned long action; 169 u8 ip_proto; 170 int in_use; 171 int idx; 172 int is_l4; 173 }; 174 175 /* Rx Frame Steering */ 176 enum stmmac_rfs_type { 177 STMMAC_RFS_T_VLAN, 178 STMMAC_RFS_T_MAX, 179 }; 180 181 struct stmmac_rfs_entry { 182 unsigned long cookie; 183 int in_use; 184 int type; 185 int tc; 186 }; 187 188 struct stmmac_priv { 189 /* Frequently used values are kept adjacent for cache effect */ 190 u32 tx_coal_frames[MTL_MAX_TX_QUEUES]; 191 u32 tx_coal_timer[MTL_MAX_TX_QUEUES]; 192 u32 rx_coal_frames[MTL_MAX_TX_QUEUES]; 193 194 int tx_coalesce; 195 int hwts_tx_en; 196 bool tx_path_in_lpi_mode; 197 bool tso; 198 int sph; 199 int sph_cap; 200 u32 sarc_type; 201 202 unsigned int dma_buf_sz; 203 unsigned int rx_copybreak; 204 u32 rx_riwt[MTL_MAX_TX_QUEUES]; 205 int hwts_rx_en; 206 207 void __iomem *ioaddr; 208 struct net_device *dev; 209 struct device *device; 210 struct mac_device_info *hw; 211 int (*hwif_quirks)(struct stmmac_priv *priv); 212 struct mutex lock; 213 214 /* RX Queue */ 215 struct stmmac_rx_queue rx_queue[MTL_MAX_RX_QUEUES]; 216 unsigned int dma_rx_size; 217 218 /* TX Queue */ 219 struct stmmac_tx_queue tx_queue[MTL_MAX_TX_QUEUES]; 220 unsigned int dma_tx_size; 221 222 /* Generic channel for NAPI */ 223 struct stmmac_channel channel[STMMAC_CH_MAX]; 224 225 int speed; 226 unsigned int flow_ctrl; 227 unsigned int pause; 228 struct mii_bus *mii; 229 int mii_irq[PHY_MAX_ADDR]; 230 231 struct phylink_config phylink_config; 232 struct phylink *phylink; 233 234 struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp; 235 struct stmmac_safety_stats sstats; 236 struct plat_stmmacenet_data *plat; 237 struct dma_features dma_cap; 238 struct stmmac_counters mmc; 239 int hw_cap_support; 240 int synopsys_id; 241 u32 msg_enable; 242 int wolopts; 243 int wol_irq; 244 int clk_csr; 245 struct timer_list eee_ctrl_timer; 246 int lpi_irq; 247 int eee_enabled; 248 int eee_active; 249 int tx_lpi_timer; 250 int tx_lpi_enabled; 251 int eee_tw_timer; 252 bool eee_sw_timer_en; 253 unsigned int mode; 254 unsigned int chain_mode; 255 int extend_desc; 256 struct hwtstamp_config tstamp_config; 257 struct ptp_clock *ptp_clock; 258 struct ptp_clock_info ptp_clock_ops; 259 unsigned int default_addend; 260 u32 sub_second_inc; 261 u32 systime_flags; 262 u32 adv_ts; 263 int use_riwt; 264 int irq_wake; 265 spinlock_t ptp_lock; 266 /* Protects auxiliary snapshot registers from concurrent access. */ 267 struct mutex aux_ts_lock; 268 269 void __iomem *mmcaddr; 270 void __iomem *ptpaddr; 271 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; 272 int sfty_ce_irq; 273 int sfty_ue_irq; 274 int rx_irq[MTL_MAX_RX_QUEUES]; 275 int tx_irq[MTL_MAX_TX_QUEUES]; 276 /*irq name */ 277 char int_name_mac[IFNAMSIZ + 9]; 278 char int_name_wol[IFNAMSIZ + 9]; 279 char int_name_lpi[IFNAMSIZ + 9]; 280 char int_name_sfty_ce[IFNAMSIZ + 10]; 281 char int_name_sfty_ue[IFNAMSIZ + 10]; 282 char int_name_rx_irq[MTL_MAX_TX_QUEUES][IFNAMSIZ + 14]; 283 char int_name_tx_irq[MTL_MAX_TX_QUEUES][IFNAMSIZ + 18]; 284 285 #ifdef CONFIG_DEBUG_FS 286 struct dentry *dbgfs_dir; 287 #endif 288 289 unsigned long state; 290 struct workqueue_struct *wq; 291 struct work_struct service_task; 292 293 /* Workqueue for handling FPE hand-shaking */ 294 unsigned long fpe_task_state; 295 struct workqueue_struct *fpe_wq; 296 struct work_struct fpe_task; 297 char wq_name[IFNAMSIZ + 4]; 298 299 /* TC Handling */ 300 unsigned int tc_entries_max; 301 unsigned int tc_off_max; 302 struct stmmac_tc_entry *tc_entries; 303 unsigned int flow_entries_max; 304 struct stmmac_flow_entry *flow_entries; 305 unsigned int rfs_entries_max[STMMAC_RFS_T_MAX]; 306 unsigned int rfs_entries_cnt[STMMAC_RFS_T_MAX]; 307 unsigned int rfs_entries_total; 308 struct stmmac_rfs_entry *rfs_entries; 309 310 /* Pulse Per Second output */ 311 struct stmmac_pps_cfg pps[STMMAC_PPS_MAX]; 312 313 /* Receive Side Scaling */ 314 struct stmmac_rss rss; 315 316 /* XDP BPF Program */ 317 unsigned long *af_xdp_zc_qps; 318 struct bpf_prog *xdp_prog; 319 }; 320 321 enum stmmac_state { 322 STMMAC_DOWN, 323 STMMAC_RESET_REQUESTED, 324 STMMAC_RESETING, 325 STMMAC_SERVICE_SCHED, 326 }; 327 328 int stmmac_mdio_unregister(struct net_device *ndev); 329 int stmmac_mdio_register(struct net_device *ndev); 330 int stmmac_mdio_reset(struct mii_bus *mii); 331 int stmmac_xpcs_setup(struct mii_bus *mii); 332 void stmmac_set_ethtool_ops(struct net_device *netdev); 333 334 int stmmac_init_tstamp_counter(struct stmmac_priv *priv, u32 systime_flags); 335 void stmmac_ptp_register(struct stmmac_priv *priv); 336 void stmmac_ptp_unregister(struct stmmac_priv *priv); 337 int stmmac_open(struct net_device *dev); 338 int stmmac_release(struct net_device *dev); 339 int stmmac_resume(struct device *dev); 340 int stmmac_suspend(struct device *dev); 341 int stmmac_dvr_remove(struct device *dev); 342 int stmmac_dvr_probe(struct device *device, 343 struct plat_stmmacenet_data *plat_dat, 344 struct stmmac_resources *res); 345 void stmmac_disable_eee_mode(struct stmmac_priv *priv); 346 bool stmmac_eee_init(struct stmmac_priv *priv); 347 int stmmac_reinit_queues(struct net_device *dev, u32 rx_cnt, u32 tx_cnt); 348 int stmmac_reinit_ringparam(struct net_device *dev, u32 rx_size, u32 tx_size); 349 int stmmac_bus_clks_config(struct stmmac_priv *priv, bool enabled); 350 void stmmac_fpe_handshake(struct stmmac_priv *priv, bool enable); 351 352 static inline bool stmmac_xdp_is_enabled(struct stmmac_priv *priv) 353 { 354 return !!priv->xdp_prog; 355 } 356 357 static inline unsigned int stmmac_rx_offset(struct stmmac_priv *priv) 358 { 359 if (stmmac_xdp_is_enabled(priv)) 360 return XDP_PACKET_HEADROOM; 361 362 return 0; 363 } 364 365 void stmmac_disable_rx_queue(struct stmmac_priv *priv, u32 queue); 366 void stmmac_enable_rx_queue(struct stmmac_priv *priv, u32 queue); 367 void stmmac_disable_tx_queue(struct stmmac_priv *priv, u32 queue); 368 void stmmac_enable_tx_queue(struct stmmac_priv *priv, u32 queue); 369 int stmmac_xsk_wakeup(struct net_device *dev, u32 queue, u32 flags); 370 struct timespec64 stmmac_calc_tas_basetime(ktime_t old_base_time, 371 ktime_t current_time, 372 u64 cycle_time); 373 374 #if IS_ENABLED(CONFIG_STMMAC_SELFTESTS) 375 void stmmac_selftest_run(struct net_device *dev, 376 struct ethtool_test *etest, u64 *buf); 377 void stmmac_selftest_get_strings(struct stmmac_priv *priv, u8 *data); 378 int stmmac_selftest_get_count(struct stmmac_priv *priv); 379 #else 380 static inline void stmmac_selftest_run(struct net_device *dev, 381 struct ethtool_test *etest, u64 *buf) 382 { 383 /* Not enabled */ 384 } 385 static inline void stmmac_selftest_get_strings(struct stmmac_priv *priv, 386 u8 *data) 387 { 388 /* Not enabled */ 389 } 390 static inline int stmmac_selftest_get_count(struct stmmac_priv *priv) 391 { 392 return -EOPNOTSUPP; 393 } 394 #endif /* CONFIG_STMMAC_SELFTESTS */ 395 396 #endif /* __STMMAC_H__ */ 397