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/reset.h>
  32
  33 struct stmmac_resources {
  34         void __iomem *addr;
  35         const char *mac;
  36         int wol_irq;
  37         int lpi_irq;
  38         int irq;
  39 };
  40
  41 struct stmmac_tx_info {
  42         dma_addr_t buf;
  43         bool map_as_page;
  44         unsigned len;
  45         bool last_segment;
  46         bool is_jumbo;
  47 };
  48
  49 /* Frequently used values are kept adjacent for cache effect */
  50 struct stmmac_tx_queue {
  51         u32 queue_index;
  52         struct stmmac_priv *priv_data;
  53         struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
  54         struct dma_desc *dma_tx;
  55         struct sk_buff **tx_skbuff;
  56         struct stmmac_tx_info *tx_skbuff_dma;
  57         unsigned int cur_tx;
  58         unsigned int dirty_tx;
  59         dma_addr_t dma_tx_phy;
  60         u32 tx_tail_addr;
  61 };
  62
  63 struct stmmac_rx_queue {
  64         u32 queue_index;
  65         struct stmmac_priv *priv_data;
  66         struct dma_extended_desc *dma_erx;
  67         struct dma_desc *dma_rx ____cacheline_aligned_in_smp;
  68         struct sk_buff **rx_skbuff;
  69         dma_addr_t *rx_skbuff_dma;
  70         unsigned int cur_rx;
  71         unsigned int dirty_rx;
  72         u32 rx_zeroc_thresh;
  73         dma_addr_t dma_rx_phy;
  74         u32 rx_tail_addr;
  75         struct napi_struct napi ____cacheline_aligned_in_smp;
  76 };
  77
  78 struct stmmac_priv {
  79         /* Frequently used values are kept adjacent for cache effect */
  80         u32 tx_count_frames;
  81         u32 tx_coal_frames;
  82         u32 tx_coal_timer;
  83
  84         int tx_coalesce;
  85         int hwts_tx_en;
  86         bool tx_path_in_lpi_mode;
  87         struct timer_list txtimer;
  88         bool tso;
  89
  90         unsigned int dma_buf_sz;
  91         unsigned int rx_copybreak;
  92         u32 rx_riwt;
  93         int hwts_rx_en;
  94
  95         void __iomem *ioaddr;
  96         struct net_device *dev;
  97         struct device *device;
  98         struct mac_device_info *hw;
  99         struct mutex lock;
 100
 101         /* RX Queue */
 102         struct stmmac_rx_queue rx_queue[MTL_MAX_RX_QUEUES];
 103
 104         /* TX Queue */
 105         struct stmmac_tx_queue tx_queue[MTL_MAX_TX_QUEUES];
 106
 107         bool oldlink;
 108         int speed;
 109         int oldduplex;
 110         unsigned int flow_ctrl;
 111         unsigned int pause;
 112         struct mii_bus *mii;
 113         int mii_irq[PHY_MAX_ADDR];
 114
 115         struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
 116         struct plat_stmmacenet_data *plat;
 117         struct dma_features dma_cap;
 118         struct stmmac_counters mmc;
 119         int hw_cap_support;
 120         int synopsys_id;
 121         u32 msg_enable;
 122         int wolopts;
 123         int wol_irq;
 124         int clk_csr;
 125         struct timer_list eee_ctrl_timer;
 126         int lpi_irq;
 127         int eee_enabled;
 128         int eee_active;
 129         int tx_lpi_timer;
 130         unsigned int mode;
 131         int extend_desc;
 132         struct ptp_clock *ptp_clock;
 133         struct ptp_clock_info ptp_clock_ops;
 134         unsigned int default_addend;
 135         u32 adv_ts;
 136         int use_riwt;
 137         int irq_wake;
 138         spinlock_t ptp_lock;
 139         void __iomem *mmcaddr;
 140         void __iomem *ptpaddr;
 141         u32 mss;
 142
 143 #ifdef CONFIG_DEBUG_FS
 144         struct dentry *dbgfs_dir;
 145         struct dentry *dbgfs_rings_status;
 146         struct dentry *dbgfs_dma_cap;
 147 #endif
 148 };
 149
 150 int stmmac_mdio_unregister(struct net_device *ndev);
 151 int stmmac_mdio_register(struct net_device *ndev);
 152 int stmmac_mdio_reset(struct mii_bus *mii);
 153 void stmmac_set_ethtool_ops(struct net_device *netdev);
 154
 155 void stmmac_ptp_register(struct stmmac_priv *priv);
 156 void stmmac_ptp_unregister(struct stmmac_priv *priv);
 157 int stmmac_resume(struct device *dev);
 158 int stmmac_suspend(struct device *dev);
 159 int stmmac_dvr_remove(struct device *dev);
 160 int stmmac_dvr_probe(struct device *device,
 161                      struct plat_stmmacenet_data *plat_dat,
 162                      struct stmmac_resources *res);
 163 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
 164 bool stmmac_eee_init(struct stmmac_priv *priv);
 165
 166 #endif /* __STMMAC_H__ */