[mirror_ubuntu-artful-kernel.git] / drivers / net / ethernet / stmicro / stmmac / stmmac.h

/*******************************************************************************
  Copyright (C) 2007-2009  STMicroelectronics Ltd

  This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

  This program is distributed in the hope it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  more details.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
*******************************************************************************/

#ifndef __STMMAC_H__
#define __STMMAC_H__

#define STMMAC_RESOURCE_NAME   "stmmaceth"
#define DRV_MODULE_VERSION	"March_2013"

#include <linux/clk.h>
#include <linux/stmmac.h>
#include <linux/phy.h>
#include <linux/pci.h>
#include "common.h"
#include <linux/ptp_clock_kernel.h>

struct stmmac_priv {
	/* Frequently used values are kept adjacent for cache effect */
	struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
	struct dma_desc *dma_tx;
	struct sk_buff **tx_skbuff;
	unsigned int cur_tx;
	unsigned int dirty_tx;
	unsigned int dma_tx_size;
	u32 tx_count_frames;
	u32 tx_coal_frames;
	u32 tx_coal_timer;
	dma_addr_t *tx_skbuff_dma;
	dma_addr_t dma_tx_phy;
	int tx_coalesce;
	int hwts_tx_en;
	spinlock_t tx_lock;
	bool tx_path_in_lpi_mode;
	struct timer_list txtimer;

	struct dma_desc *dma_rx	____cacheline_aligned_in_smp;
	struct dma_extended_desc *dma_erx;
	struct sk_buff **rx_skbuff;
	unsigned int cur_rx;
	unsigned int dirty_rx;
	unsigned int dma_rx_size;
	unsigned int dma_buf_sz;
	u32 rx_riwt;
	int hwts_rx_en;
	dma_addr_t *rx_skbuff_dma;
	dma_addr_t dma_rx_phy;

	struct napi_struct napi ____cacheline_aligned_in_smp;

	void __iomem *ioaddr;
	struct net_device *dev;
	struct device *device;
	struct mac_device_info *hw;
	spinlock_t lock;

	struct phy_device *phydev ____cacheline_aligned_in_smp;
	int oldlink;
	int speed;
	int oldduplex;
	unsigned int flow_ctrl;
	unsigned int pause;
	struct mii_bus *mii;
	int mii_irq[PHY_MAX_ADDR];

	struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
	struct plat_stmmacenet_data *plat;
	struct dma_features dma_cap;
	struct stmmac_counters mmc;
	int hw_cap_support;
	int synopsys_id;
	u32 msg_enable;
	int wolopts;
	int wol_irq;
	struct clk *stmmac_clk;
	int clk_csr;
	struct timer_list eee_ctrl_timer;
	int lpi_irq;
	int eee_enabled;
	int eee_active;
	int tx_lpi_timer;
	int pcs;
	unsigned int mode;
	int extend_desc;
	struct ptp_clock *ptp_clock;
	struct ptp_clock_info ptp_clock_ops;
	unsigned int default_addend;
	u32 adv_ts;
	int use_riwt;
	int irq_wake;
	spinlock_t ptp_lock;
};

int stmmac_mdio_unregister(struct net_device *ndev);
int stmmac_mdio_register(struct net_device *ndev);
int stmmac_mdio_reset(struct mii_bus *mii);
void stmmac_set_ethtool_ops(struct net_device *netdev);
extern const struct stmmac_desc_ops enh_desc_ops;
extern const struct stmmac_desc_ops ndesc_ops;
extern const struct stmmac_hwtimestamp stmmac_ptp;
int stmmac_ptp_register(struct stmmac_priv *priv);
void stmmac_ptp_unregister(struct stmmac_priv *priv);
int stmmac_resume(struct net_device *ndev);
int stmmac_suspend(struct net_device *ndev);
int stmmac_dvr_remove(struct net_device *ndev);
struct stmmac_priv *stmmac_dvr_probe(struct device *device,
				     struct plat_stmmacenet_data *plat_dat,
				     void __iomem *addr);
void stmmac_disable_eee_mode(struct stmmac_priv *priv);
bool stmmac_eee_init(struct stmmac_priv *priv);

#ifdef CONFIG_STMMAC_PLATFORM
extern struct platform_driver stmmac_pltfr_driver;
static inline int stmmac_register_platform(void)
{
	int err;

	err = platform_driver_register(&stmmac_pltfr_driver);
	if (err)
		pr_err("stmmac: failed to register the platform driver\n");

	return err;
}

static inline void stmmac_unregister_platform(void)
{
	platform_driver_unregister(&stmmac_pltfr_driver);
}
#else
static inline int stmmac_register_platform(void)
{
	pr_debug("stmmac: do not register the platf driver\n");

	return 0;
}

static inline void stmmac_unregister_platform(void)
{
}
#endif /* CONFIG_STMMAC_PLATFORM */

#ifdef CONFIG_STMMAC_PCI
extern struct pci_driver stmmac_pci_driver;
static inline int stmmac_register_pci(void)
{
	int err;

	err = pci_register_driver(&stmmac_pci_driver);
	if (err)
		pr_err("stmmac: failed to register the PCI driver\n");

	return err;
}

static inline void stmmac_unregister_pci(void)
{
	pci_unregister_driver(&stmmac_pci_driver);
}
#else
static inline int stmmac_register_pci(void)
{
	pr_debug("stmmac: do not register the PCI driver\n");

	return 0;
}

static inline void stmmac_unregister_pci(void)
{
}
#endif /* CONFIG_STMMAC_PCI */

#endif /* __STMMAC_H__ */
Commit	Line	Data
47dd7a54 GC	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
bd4242df RK	23	#ifndef __STMMAC_H__
	24	#define __STMMAC_H__
	25
bfab27a1	26	#define STMMAC_RESOURCE_NAME "stmmaceth"
94fbbbf8	27	#define DRV_MODULE_VERSION "March_2013"
ba1377ff GC	28
ba1377ff GC	29	#include <linux/clk.h>
ee7946a7	30	#include <linux/stmmac.h>
286a8372	31	#include <linux/phy.h>
33d5e332	32	#include <linux/pci.h>
47dd7a54	33	#include "common.h"
92ba6888	34	#include <linux/ptp_clock_kernel.h>
47dd7a54 GC	35
	36	struct stmmac_priv {
	37	/* Frequently used values are kept adjacent for cache effect */
1bb6dea8 GC	38	struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
1bb6dea8 GC	39	struct dma_desc *dma_tx;
47dd7a54 GC	40	struct sk_buff **tx_skbuff;
	41	unsigned int cur_tx;
	42	unsigned int dirty_tx;
	43	unsigned int dma_tx_size;
1bb6dea8 GC	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;
47dd7a54	49	int tx_coalesce;
1bb6dea8 GC	50	int hwts_tx_en;
	51	spinlock_t tx_lock;
	52	bool tx_path_in_lpi_mode;
	53	struct timer_list txtimer;
47dd7a54	54
1bb6dea8 GC	55	struct dma_desc *dma_rx ____cacheline_aligned_in_smp;
	56	struct dma_extended_desc *dma_erx;
	57	struct sk_buff **rx_skbuff;
47dd7a54 GC	58	unsigned int cur_rx;
47dd7a54 GC	59	unsigned int dirty_rx;
1bb6dea8 GC	60	unsigned int dma_rx_size;
	61	unsigned int dma_buf_sz;
	62	u32 rx_riwt;
	63	int hwts_rx_en;
47dd7a54	64	dma_addr_t *rx_skbuff_dma;
1bb6dea8	65	dma_addr_t dma_rx_phy;
47dd7a54	66
1bb6dea8 GC	67	struct napi_struct napi ____cacheline_aligned_in_smp;
	68
	69	void __iomem *ioaddr;
47dd7a54	70	struct net_device *dev;
47dd7a54	71	struct device *device;
db98a0b0	72	struct mac_device_info *hw;
1bb6dea8	73	spinlock_t lock;
47dd7a54	74
1bb6dea8	75	struct phy_device *phydev ____cacheline_aligned_in_smp;
47dd7a54 GC	76	int oldlink;
	77	int speed;
	78	int oldduplex;
	79	unsigned int flow_ctrl;
	80	unsigned int pause;
	81	struct mii_bus *mii;
36bcfe7d	82	int mii_irq[PHY_MAX_ADDR];
47dd7a54	83
1bb6dea8	84	struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
9dfeb4d9	85	struct plat_stmmacenet_data *plat;
e7434821	86	struct dma_features dma_cap;
1bb6dea8	87	struct stmmac_counters mmc;
19e30c14	88	int hw_cap_support;
1bb6dea8 GC	89	int synopsys_id;
	90	u32 msg_enable;
	91	int wolopts;
	92	int wol_irq;
ba1377ff	93	struct clk *stmmac_clk;
cd7201f4	94	int clk_csr;
d765955d	95	struct timer_list eee_ctrl_timer;
d765955d GC	96	int lpi_irq;
	97	int eee_enabled;
	98	int eee_active;
	99	int tx_lpi_timer;
1bb6dea8	100	int pcs;
4a7d666a	101	unsigned int mode;
c24602ef	102	int extend_desc;
92ba6888 RK	103	struct ptp_clock *ptp_clock;
92ba6888 RK	104	struct ptp_clock_info ptp_clock_ops;
1bb6dea8 GC	105	unsigned int default_addend;
	106	u32 adv_ts;
	107	int use_riwt;
89f7f2cf	108	int irq_wake;
92ba6888	109	spinlock_t ptp_lock;
47dd7a54 GC	110	};
47dd7a54 GC	111
d6cc64ef JP	112	int stmmac_mdio_unregister(struct net_device *ndev);
d6cc64ef JP	113	int stmmac_mdio_register(struct net_device *ndev);
073752aa	114	int stmmac_mdio_reset(struct mii_bus *mii);
d6cc64ef	115	void stmmac_set_ethtool_ops(struct net_device *netdev);
cadb7924	116	extern const struct stmmac_desc_ops enh_desc_ops;
cadb7924	117	extern const struct stmmac_desc_ops ndesc_ops;
891434b1	118	extern const struct stmmac_hwtimestamp stmmac_ptp;
d6cc64ef JP	119	int stmmac_ptp_register(struct stmmac_priv *priv);
d6cc64ef JP	120	void stmmac_ptp_unregister(struct stmmac_priv *priv);
bfab27a1 GC	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,
cf3f047b GC	125	struct plat_stmmacenet_data *plat_dat,
cf3f047b GC	126	void __iomem *addr);
d765955d GC	127	void stmmac_disable_eee_mode(struct stmmac_priv *priv);
d765955d GC	128	bool stmmac_eee_init(struct stmmac_priv *priv);
ba1377ff	129
33d5e332 GC	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	}
ceb69499	142
33d5e332 GC	143	static inline void stmmac_unregister_platform(void)
33d5e332 GC	144	{
493682b8	145	platform_driver_unregister(&stmmac_pltfr_driver);
33d5e332 GC	146	}
	147	#else
	148	static inline int stmmac_register_platform(void)
	149	{
	150	pr_debug("stmmac: do not register the platf driver\n");
	151
493682b8	152	return 0;
33d5e332	153	}
ceb69499	154
33d5e332 GC	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	}
ceb69499	172
33d5e332 GC	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
493682b8	182	return 0;
33d5e332	183	}
ceb69499	184
33d5e332 GC	185	static inline void stmmac_unregister_pci(void)
	186	{
	187	}
	188	#endif /* CONFIG_STMMAC_PCI */
bd4242df RK	189
bd4242df RK	190	#endif /* __STMMAC_H__ */