drivers/net/ethernet/stmicro/stmmac/stmmac.h

   1 /*******************************************************************************
   2   Copyright (C) 2007-2009  STMicroelectronics Ltd
   3
   4   This program is free software; you can redistribute it and/or modify it
   5   under the terms and conditions of the GNU General Public License,
   6   version 2, as published by the Free Software Foundation.
   7
   8   This program is distributed in the hope it will be useful, but WITHOUT
   9   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11   more details.
  12
  13   The full GNU General Public License is included in this distribution in
  14   the file called "COPYING".
  15
  16   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
  17 *******************************************************************************/
  18
  19 #ifndef __STMMAC_H__
  20 #define __STMMAC_H__
  21
  22 #define STMMAC_RESOURCE_NAME   "stmmaceth"
  23 #define DRV_MODULE_VERSION      "Jan_2016"
  24
  25 #include <linux/clk.h>
  26 #include <linux/stmmac.h>
  27 #include <linux/phy.h>
  28 #include <linux/pci.h>
  29 #include "common.h"
  30 #include <linux/ptp_clock_kernel.h>
  31 #include <linux/net_tstamp.h>
  32 #include <linux/reset.h>
  33
  34 struct stmmac_resources {
  35         void __iomem *addr;
  36         const char *mac;
  37         int wol_irq;
  38         int lpi_irq;
  39         int irq;
  40 };
  41
  42 struct stmmac_tx_info {
  43         dma_addr_t buf;
  44         bool map_as_page;
  45         unsigned len;
  46         bool last_segment;
  47         bool is_jumbo;
  48 };
  49
  50 /* Frequently used values are kept adjacent for cache effect */
  51 struct stmmac_tx_queue {
  52         u32 tx_count_frames;
  53         struct timer_list txtimer;
  54         u32 queue_index;
  55         struct stmmac_priv *priv_data;
  56         struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
  57         struct dma_desc *dma_tx;
  58         struct sk_buff **tx_skbuff;
  59         struct stmmac_tx_info *tx_skbuff_dma;
  60         unsigned int cur_tx;
  61         unsigned int dirty_tx;
  62         dma_addr_t dma_tx_phy;
  63         u32 tx_tail_addr;
  64         u32 mss;
  65 };
  66
  67 struct stmmac_rx_queue {
  68         u32 queue_index;
  69         struct stmmac_priv *priv_data;
  70         struct dma_extended_desc *dma_erx;
  71         struct dma_desc *dma_rx ____cacheline_aligned_in_smp;
  72         struct sk_buff **rx_skbuff;
  73         dma_addr_t *rx_skbuff_dma;
  74         unsigned int cur_rx;
  75         unsigned int dirty_rx;
  76         u32 rx_zeroc_thresh;
  77         dma_addr_t dma_rx_phy;
  78         u32 rx_tail_addr;
  79 };
  80
  81 struct stmmac_channel {
  82         struct napi_struct rx_napi ____cacheline_aligned_in_smp;
  83         struct napi_struct tx_napi ____cacheline_aligned_in_smp;
  84         struct stmmac_priv *priv_data;
  85         u32 index;
  86 };
  87
  88 struct stmmac_tc_entry {
  89         bool in_use;
  90         bool in_hw;
  91         bool is_last;
  92         bool is_frag;
  93         void *frag_ptr;
  94         unsigned int table_pos;
  95         u32 handle;
  96         u32 prio;
  97         struct {
  98                 u32 match_data;
  99                 u32 match_en;
 100                 u8 af:1;
 101                 u8 rf:1;
 102                 u8 im:1;
 103                 u8 nc:1;
 104                 u8 res1:4;
 105                 u8 frame_offset;
 106                 u8 ok_index;
 107                 u8 dma_ch_no;
 108                 u32 res2;
 109         } __packed val;
 110 };
 111
 112 #define STMMAC_PPS_MAX          4
 113 struct stmmac_pps_cfg {
 114         bool available;
 115         struct timespec64 start;
 116         struct timespec64 period;
 117 };
 118
 119 struct stmmac_priv {
 120         /* Frequently used values are kept adjacent for cache effect */
 121         u32 tx_coal_frames;
 122         u32 tx_coal_timer;
 123
 124         int tx_coalesce;
 125         int hwts_tx_en;
 126         bool tx_path_in_lpi_mode;
 127         bool tso;
 128
 129         unsigned int dma_buf_sz;
 130         unsigned int rx_copybreak;
 131         u32 rx_riwt;
 132         int hwts_rx_en;
 133
 134         void __iomem *ioaddr;
 135         struct net_device *dev;
 136         struct device *device;
 137         struct mac_device_info *hw;
 138         int (*hwif_quirks)(struct stmmac_priv *priv);
 139         struct mutex lock;
 140
 141         /* RX Queue */
 142         struct stmmac_rx_queue rx_queue[MTL_MAX_RX_QUEUES];
 143
 144         /* TX Queue */
 145         struct stmmac_tx_queue tx_queue[MTL_MAX_TX_QUEUES];
 146
 147         /* Generic channel for NAPI */
 148         struct stmmac_channel channel[STMMAC_CH_MAX];
 149
 150         bool oldlink;
 151         int speed;
 152         int oldduplex;
 153         unsigned int flow_ctrl;
 154         unsigned int pause;
 155         struct mii_bus *mii;
 156         int mii_irq[PHY_MAX_ADDR];
 157
 158         struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
 159         struct stmmac_safety_stats sstats;
 160         struct plat_stmmacenet_data *plat;
 161         struct dma_features dma_cap;
 162         struct stmmac_counters mmc;
 163         int hw_cap_support;
 164         int synopsys_id;
 165         u32 msg_enable;
 166         int wolopts;
 167         int wol_irq;
 168         int clk_csr;
 169         struct timer_list eee_ctrl_timer;
 170         int lpi_irq;
 171         int eee_enabled;
 172         int eee_active;
 173         int tx_lpi_timer;
 174         unsigned int mode;
 175         unsigned int chain_mode;
 176         int extend_desc;
 177         struct hwtstamp_config tstamp_config;
 178         struct ptp_clock *ptp_clock;
 179         struct ptp_clock_info ptp_clock_ops;
 180         unsigned int default_addend;
 181         u32 sub_second_inc;
 182         u32 systime_flags;
 183         u32 adv_ts;
 184         int use_riwt;
 185         int irq_wake;
 186         spinlock_t ptp_lock;
 187         void __iomem *mmcaddr;
 188         void __iomem *ptpaddr;
 189
 190 #ifdef CONFIG_DEBUG_FS
 191         struct dentry *dbgfs_dir;
 192         struct dentry *dbgfs_rings_status;
 193         struct dentry *dbgfs_dma_cap;
 194 #endif
 195
 196         unsigned long state;
 197         struct workqueue_struct *wq;
 198         struct work_struct service_task;
 199
 200         /* TC Handling */
 201         unsigned int tc_entries_max;
 202         unsigned int tc_off_max;
 203         struct stmmac_tc_entry *tc_entries;
 204
 205         /* Pulse Per Second output */
 206         struct stmmac_pps_cfg pps[STMMAC_PPS_MAX];
 207 };
 208
 209 enum stmmac_state {
 210         STMMAC_DOWN,
 211         STMMAC_RESET_REQUESTED,
 212         STMMAC_RESETING,
 213         STMMAC_SERVICE_SCHED,
 214 };
 215
 216 int stmmac_mdio_unregister(struct net_device *ndev);
 217 int stmmac_mdio_register(struct net_device *ndev);
 218 int stmmac_mdio_reset(struct mii_bus *mii);
 219 void stmmac_set_ethtool_ops(struct net_device *netdev);
 220
 221 void stmmac_ptp_register(struct stmmac_priv *priv);
 222 void stmmac_ptp_unregister(struct stmmac_priv *priv);
 223 int stmmac_resume(struct device *dev);
 224 int stmmac_suspend(struct device *dev);
 225 int stmmac_dvr_remove(struct device *dev);
 226 int stmmac_dvr_probe(struct device *device,
 227                      struct plat_stmmacenet_data *plat_dat,
 228                      struct stmmac_resources *res);
 229 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
 230 bool stmmac_eee_init(struct stmmac_priv *priv);
 231
 232 #endif /* __STMMAC_H__ */