[deliverable/linux.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_2012"

#include <linux/clk.h>
#include <linux/stmmac.h>
#include <linux/phy.h>
#include <linux/pci.h>
#include "common.h"
#ifdef CONFIG_STMMAC_TIMER
#include "stmmac_timer.h"
#endif

struct stmmac_priv {
	/* Frequently used values are kept adjacent for cache effect */
	struct dma_desc *dma_tx ____cacheline_aligned;
	dma_addr_t dma_tx_phy;
	struct sk_buff **tx_skbuff;
	unsigned int cur_tx;
	unsigned int dirty_tx;
	unsigned int dma_tx_size;
	int tx_coalesce;

	struct dma_desc *dma_rx ;
	unsigned int cur_rx;
	unsigned int dirty_rx;
	struct sk_buff **rx_skbuff;
	dma_addr_t *rx_skbuff_dma;
	struct sk_buff_head rx_recycle;

	struct net_device *dev;
	dma_addr_t dma_rx_phy;
	unsigned int dma_rx_size;
	unsigned int dma_buf_sz;
	struct device *device;
	struct mac_device_info *hw;
	void __iomem *ioaddr;

	struct stmmac_extra_stats xstats;
	struct napi_struct napi;
	int no_csum_insertion;

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

	u32 msg_enable;
	spinlock_t lock;
	spinlock_t tx_lock;
	int wolopts;
	int wol_irq;
#ifdef CONFIG_STMMAC_TIMER
	struct stmmac_timer *tm;
#endif
	struct plat_stmmacenet_data *plat;
	struct stmmac_counters mmc;
	struct dma_features dma_cap;
	int hw_cap_support;
	struct clk *stmmac_clk;
	int clk_csr;
	int synopsys_id;
	struct timer_list eee_ctrl_timer;
	bool tx_path_in_lpi_mode;
	int lpi_irq;
	int eee_enabled;
	int eee_active;
	int tx_lpi_timer;
};

extern int phyaddr;

extern int stmmac_mdio_unregister(struct net_device *ndev);
extern int stmmac_mdio_register(struct net_device *ndev);
extern 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;
int stmmac_freeze(struct net_device *ndev);
int stmmac_restore(struct net_device *ndev);
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_register(&stmmac_pltfr_driver);
}
#else
static inline int stmmac_register_platform(void)
{
	pr_debug("stmmac: do not register the platf driver\n");

	return -EINVAL;
}
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 -EINVAL;
}
static inline void stmmac_unregister_pci(void)
{
}
#endif /* CONFIG_STMMAC_PCI */

#endif /* __STMMAC_H__ */
Commit	Line	Data
	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_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	#ifdef CONFIG_STMMAC_TIMER
	35	#include "stmmac_timer.h"
	36	#endif
	37
	38	struct stmmac_priv {
	39	/* Frequently used values are kept adjacent for cache effect */
	40	struct dma_desc *dma_tx ____cacheline_aligned;
	41	dma_addr_t dma_tx_phy;
	42	struct sk_buff **tx_skbuff;
	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 ;
	49	unsigned int cur_rx;
	50	unsigned int dirty_rx;
	51	struct sk_buff **rx_skbuff;
	52	dma_addr_t *rx_skbuff_dma;
	53	struct sk_buff_head rx_recycle;
	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	#ifdef CONFIG_STMMAC_TIMER
	82	struct stmmac_timer *tm;
	83	#endif
	84	struct plat_stmmacenet_data *plat;
	85	struct stmmac_counters mmc;
	86	struct dma_features dma_cap;
	87	int hw_cap_support;
	88	struct clk *stmmac_clk;
	89	int clk_csr;
	90	int synopsys_id;
	91	struct timer_list eee_ctrl_timer;
	92	bool tx_path_in_lpi_mode;
	93	int lpi_irq;
	94	int eee_enabled;
	95	int eee_active;
	96	int tx_lpi_timer;
	97	};
	98
	99	extern int phyaddr;
	100
	101	extern int stmmac_mdio_unregister(struct net_device *ndev);
	102	extern int stmmac_mdio_register(struct net_device *ndev);
	103	extern void stmmac_set_ethtool_ops(struct net_device *netdev);
	104	extern const struct stmmac_desc_ops enh_desc_ops;
	105	extern const struct stmmac_desc_ops ndesc_ops;
	106	int stmmac_freeze(struct net_device *ndev);
	107	int stmmac_restore(struct net_device *ndev);
	108	int stmmac_resume(struct net_device *ndev);
	109	int stmmac_suspend(struct net_device *ndev);
	110	int stmmac_dvr_remove(struct net_device *ndev);
	111	struct stmmac_priv stmmac_dvr_probe(struct device device,
	112	struct plat_stmmacenet_data *plat_dat,
	113	void __iomem *addr);
	114	void stmmac_disable_eee_mode(struct stmmac_priv *priv);
	115	bool stmmac_eee_init(struct stmmac_priv *priv);
	116
	117	#ifdef CONFIG_STMMAC_PLATFORM
	118	extern struct platform_driver stmmac_pltfr_driver;
	119	static inline int stmmac_register_platform(void)
	120	{
	121	int err;
	122
	123	err = platform_driver_register(&stmmac_pltfr_driver);
	124	if (err)
	125	pr_err("stmmac: failed to register the platform driver\n");
	126
	127	return err;
	128	}
	129	static inline void stmmac_unregister_platform(void)
	130	{
	131	platform_driver_register(&stmmac_pltfr_driver);
	132	}
	133	#else
	134	static inline int stmmac_register_platform(void)
	135	{
	136	pr_debug("stmmac: do not register the platf driver\n");
	137
	138	return -EINVAL;
	139	}
	140	static inline void stmmac_unregister_platform(void)
	141	{
	142	}
	143	#endif /* CONFIG_STMMAC_PLATFORM */
	144
	145	#ifdef CONFIG_STMMAC_PCI
	146	extern struct pci_driver stmmac_pci_driver;
	147	static inline int stmmac_register_pci(void)
	148	{
	149	int err;
	150
	151	err = pci_register_driver(&stmmac_pci_driver);
	152	if (err)
	153	pr_err("stmmac: failed to register the PCI driver\n");
	154
	155	return err;
	156	}
	157	static inline void stmmac_unregister_pci(void)
	158	{
	159	pci_unregister_driver(&stmmac_pci_driver);
	160	}
	161	#else
	162	static inline int stmmac_register_pci(void)
	163	{
	164	pr_debug("stmmac: do not register the PCI driver\n");
	165
	166	return -EINVAL;
	167	}
	168	static inline void stmmac_unregister_pci(void)
	169	{
	170	}
	171	#endif /* CONFIG_STMMAC_PCI */
	172
	173	#endif /* __STMMAC_H__ */