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   You should have received a copy of the GNU General Public License along with
  14   this program; if not, write to the Free Software Foundation, Inc.,
  15   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  16
  17   The full GNU General Public License is included in this distribution in
  18   the file called "COPYING".
  19
  20   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
  21 *******************************************************************************/
  22
  23 #ifndef __STMMAC_H__
  24 #define __STMMAC_H__
  25
  26 #define STMMAC_RESOURCE_NAME   "stmmaceth"
  27 #define DRV_MODULE_VERSION      "March_2013"
  28
  29 #include <linux/clk.h>
  30 #include <linux/stmmac.h>
  31 #include <linux/phy.h>
  32 #include <linux/pci.h>
  33 #include "common.h"
  34 #include <linux/ptp_clock_kernel.h>
  35
  36 struct stmmac_priv {
  37         /* Frequently used values are kept adjacent for cache effect */
  38         struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
  39         struct dma_desc *dma_tx;
  40         struct sk_buff **tx_skbuff;
  41         unsigned int cur_tx;
  42         unsigned int dirty_tx;
  43         unsigned int dma_tx_size;
  44         u32 tx_count_frames;
  45         u32 tx_coal_frames;
  46         u32 tx_coal_timer;
  47         dma_addr_t *tx_skbuff_dma;
  48         dma_addr_t dma_tx_phy;
  49         int tx_coalesce;
  50         int hwts_tx_en;
  51         spinlock_t tx_lock;
  52         bool tx_path_in_lpi_mode;
  53         struct timer_list txtimer;
  54
  55         struct dma_desc *dma_rx ____cacheline_aligned_in_smp;
  56         struct dma_extended_desc *dma_erx;
  57         struct sk_buff **rx_skbuff;
  58         unsigned int cur_rx;
  59         unsigned int dirty_rx;
  60         unsigned int dma_rx_size;
  61         unsigned int dma_buf_sz;
  62         u32 rx_riwt;
  63         int hwts_rx_en;
  64         dma_addr_t *rx_skbuff_dma;
  65         dma_addr_t dma_rx_phy;
  66
  67         struct napi_struct napi ____cacheline_aligned_in_smp;
  68
  69         void __iomem *ioaddr;
  70         struct net_device *dev;
  71         struct device *device;
  72         struct mac_device_info *hw;
  73         spinlock_t lock;
  74
  75         struct phy_device *phydev ____cacheline_aligned_in_smp;
  76         int oldlink;
  77         int speed;
  78         int oldduplex;
  79         unsigned int flow_ctrl;
  80         unsigned int pause;
  81         struct mii_bus *mii;
  82         int mii_irq[PHY_MAX_ADDR];
  83
  84         struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
  85         struct plat_stmmacenet_data *plat;
  86         struct dma_features dma_cap;
  87         struct stmmac_counters mmc;
  88         int hw_cap_support;
  89         int synopsys_id;
  90         u32 msg_enable;
  91         int wolopts;
  92         int wol_irq;
  93         struct clk *stmmac_clk;
  94         int clk_csr;
  95         struct timer_list eee_ctrl_timer;
  96         int lpi_irq;
  97         int eee_enabled;
  98         int eee_active;
  99         int tx_lpi_timer;
 100         int pcs;
 101         unsigned int mode;
 102         int extend_desc;
 103         struct ptp_clock *ptp_clock;
 104         struct ptp_clock_info ptp_clock_ops;
 105         unsigned int default_addend;
 106         u32 adv_ts;
 107         int use_riwt;
 108         spinlock_t ptp_lock;
 109 };
 110
 111 int stmmac_mdio_unregister(struct net_device *ndev);
 112 int stmmac_mdio_register(struct net_device *ndev);
 113 void stmmac_set_ethtool_ops(struct net_device *netdev);
 114 extern const struct stmmac_desc_ops enh_desc_ops;
 115 extern const struct stmmac_desc_ops ndesc_ops;
 116 extern const struct stmmac_hwtimestamp stmmac_ptp;
 117 int stmmac_ptp_register(struct stmmac_priv *priv);
 118 void stmmac_ptp_unregister(struct stmmac_priv *priv);
 119 int stmmac_freeze(struct net_device *ndev);
 120 int stmmac_restore(struct net_device *ndev);
 121 int stmmac_resume(struct net_device *ndev);
 122 int stmmac_suspend(struct net_device *ndev);
 123 int stmmac_dvr_remove(struct net_device *ndev);
 124 struct stmmac_priv *stmmac_dvr_probe(struct device *device,
 125                                      struct plat_stmmacenet_data *plat_dat,
 126                                      void __iomem *addr);
 127 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
 128 bool stmmac_eee_init(struct stmmac_priv *priv);
 129
 130 #ifdef CONFIG_STMMAC_PLATFORM
 131 extern struct platform_driver stmmac_pltfr_driver;
 132 static inline int stmmac_register_platform(void)
 133 {
 134         int err;
 135
 136         err = platform_driver_register(&stmmac_pltfr_driver);
 137         if (err)
 138                 pr_err("stmmac: failed to register the platform driver\n");
 139
 140         return err;
 141 }
 142
 143 static inline void stmmac_unregister_platform(void)
 144 {
 145         platform_driver_unregister(&stmmac_pltfr_driver);
 146 }
 147 #else
 148 static inline int stmmac_register_platform(void)
 149 {
 150         pr_debug("stmmac: do not register the platf driver\n");
 151
 152         return 0;
 153 }
 154
 155 static inline void stmmac_unregister_platform(void)
 156 {
 157 }
 158 #endif /* CONFIG_STMMAC_PLATFORM */
 159
 160 #ifdef CONFIG_STMMAC_PCI
 161 extern struct pci_driver stmmac_pci_driver;
 162 static inline int stmmac_register_pci(void)
 163 {
 164         int err;
 165
 166         err = pci_register_driver(&stmmac_pci_driver);
 167         if (err)
 168                 pr_err("stmmac: failed to register the PCI driver\n");
 169
 170         return err;
 171 }
 172
 173 static inline void stmmac_unregister_pci(void)
 174 {
 175         pci_unregister_driver(&stmmac_pci_driver);
 176 }
 177 #else
 178 static inline int stmmac_register_pci(void)
 179 {
 180         pr_debug("stmmac: do not register the PCI driver\n");
 181
 182         return 0;
 183 }
 184
 185 static inline void stmmac_unregister_pci(void)
 186 {
 187 }
 188 #endif /* CONFIG_STMMAC_PCI */
 189
 190 #endif /* __STMMAC_H__ */