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