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      "Nov_2012"
  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_desc *dma_tx ____cacheline_aligned;  /* Basic TX desc */
  39         struct dma_extended_desc *dma_etx;      /* Extended TX descriptor */
  40         dma_addr_t dma_tx_phy;
  41         struct sk_buff **tx_skbuff;
  42         dma_addr_t *tx_skbuff_dma;
  43         unsigned int cur_tx;
  44         unsigned int dirty_tx;
  45         unsigned int dma_tx_size;
  46         int tx_coalesce;
  47
  48         struct dma_desc *dma_rx;                /* Basic RX descriptor */
  49         struct dma_extended_desc *dma_erx;      /* Extended RX descriptor */
  50         unsigned int cur_rx;
  51         unsigned int dirty_rx;
  52         struct sk_buff **rx_skbuff;
  53         dma_addr_t *rx_skbuff_dma;
  54
  55         struct net_device *dev;
  56         dma_addr_t dma_rx_phy;
  57         unsigned int dma_rx_size;
  58         unsigned int dma_buf_sz;
  59         struct device *device;
  60         struct mac_device_info *hw;
  61         void __iomem *ioaddr;
  62
  63         struct stmmac_extra_stats xstats;
  64         struct napi_struct napi;
  65         int no_csum_insertion;
  66
  67         struct phy_device *phydev;
  68         int oldlink;
  69         int speed;
  70         int oldduplex;
  71         unsigned int flow_ctrl;
  72         unsigned int pause;
  73         struct mii_bus *mii;
  74         int mii_irq[PHY_MAX_ADDR];
  75
  76         u32 msg_enable;
  77         spinlock_t lock;
  78         spinlock_t tx_lock;
  79         int wolopts;
  80         int wol_irq;
  81         struct plat_stmmacenet_data *plat;
  82         struct stmmac_counters mmc;
  83         struct dma_features dma_cap;
  84         int hw_cap_support;
  85         struct clk *stmmac_clk;
  86         int clk_csr;
  87         int synopsys_id;
  88         struct timer_list eee_ctrl_timer;
  89         bool tx_path_in_lpi_mode;
  90         int lpi_irq;
  91         int eee_enabled;
  92         int eee_active;
  93         int tx_lpi_timer;
  94         struct timer_list txtimer;
  95         u32 tx_count_frames;
  96         u32 tx_coal_frames;
  97         u32 tx_coal_timer;
  98         int use_riwt;
  99         u32 rx_riwt;
 100         unsigned int mode;
 101         int extend_desc;
 102         int pcs;
 103         int hwts_tx_en;
 104         int hwts_rx_en;
 105         unsigned int default_addend;
 106         u32 adv_ts;
 107         struct ptp_clock *ptp_clock;
 108         struct ptp_clock_info ptp_clock_ops;
 109         spinlock_t ptp_lock;
 110 };
 111
 112 extern int phyaddr;
 113
 114 extern int stmmac_mdio_unregister(struct net_device *ndev);
 115 extern int stmmac_mdio_register(struct net_device *ndev);
 116 extern void stmmac_set_ethtool_ops(struct net_device *netdev);
 117 extern const struct stmmac_desc_ops enh_desc_ops;
 118 extern const struct stmmac_desc_ops ndesc_ops;
 119 extern const struct stmmac_hwtimestamp stmmac_ptp;
 120 extern int stmmac_ptp_register(struct stmmac_priv *priv);
 121 extern void stmmac_ptp_unregister(struct stmmac_priv *priv);
 122 int stmmac_freeze(struct net_device *ndev);
 123 int stmmac_restore(struct net_device *ndev);
 124 int stmmac_resume(struct net_device *ndev);
 125 int stmmac_suspend(struct net_device *ndev);
 126 int stmmac_dvr_remove(struct net_device *ndev);
 127 struct stmmac_priv *stmmac_dvr_probe(struct device *device,
 128                                      struct plat_stmmacenet_data *plat_dat,
 129                                      void __iomem *addr);
 130 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
 131 bool stmmac_eee_init(struct stmmac_priv *priv);
 132
 133 #ifdef CONFIG_STMMAC_PLATFORM
 134 extern struct platform_driver stmmac_pltfr_driver;
 135 static inline int stmmac_register_platform(void)
 136 {
 137         int err;
 138
 139         err = platform_driver_register(&stmmac_pltfr_driver);
 140         if (err)
 141                 pr_err("stmmac: failed to register the platform driver\n");
 142
 143         return err;
 144 }
 145 static inline void stmmac_unregister_platform(void)
 146 {
 147         platform_driver_unregister(&stmmac_pltfr_driver);
 148 }
 149 #else
 150 static inline int stmmac_register_platform(void)
 151 {
 152         pr_debug("stmmac: do not register the platf driver\n");
 153
 154         return 0;
 155 }
 156 static inline void stmmac_unregister_platform(void)
 157 {
 158 }
 159 #endif /* CONFIG_STMMAC_PLATFORM */
 160
 161 #ifdef CONFIG_STMMAC_PCI
 162 extern struct pci_driver stmmac_pci_driver;
 163 static inline int stmmac_register_pci(void)
 164 {
 165         int err;
 166
 167         err = pci_register_driver(&stmmac_pci_driver);
 168         if (err)
 169                 pr_err("stmmac: failed to register the PCI driver\n");
 170
 171         return err;
 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 static inline void stmmac_unregister_pci(void)
 185 {
 186 }
 187 #endif /* CONFIG_STMMAC_PCI */
 188
 189 #endif /* __STMMAC_H__ */