[linux-2.6-block.git] / drivers / net / ethernet / apm / xgene / xgene_enet_main.h

/* Applied Micro X-Gene SoC Ethernet Driver
 *
 * Copyright (c) 2014, Applied Micro Circuits Corporation
 * Authors: Iyappan Subramanian <isubramanian@apm.com>
 *	    Ravi Patel <rapatel@apm.com>
 *	    Keyur Chudgar <kchudgar@apm.com>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __XGENE_ENET_MAIN_H__
#define __XGENE_ENET_MAIN_H__

#include <linux/clk.h>
#include <linux/of_platform.h>
#include <linux/of_net.h>
#include <linux/of_mdio.h>
#include <linux/module.h>
#include <net/ip.h>
#include <linux/prefetch.h>
#include <linux/if_vlan.h>
#include <linux/phy.h>
#include "xgene_enet_hw.h"

#define XGENE_DRV_VERSION	"v1.0"
#define XGENE_ENET_MAX_MTU	1536
#define SKB_BUFFER_SIZE		(XGENE_ENET_MAX_MTU - NET_IP_ALIGN)
#define NUM_PKT_BUF	64
#define NUM_BUFPOOL	32

/* software context of a descriptor ring */
struct xgene_enet_desc_ring {
	struct net_device *ndev;
	u16 id;
	u16 num;
	u16 head;
	u16 tail;
	u16 slots;
	u16 irq;
	u32 size;
	u32 state[NUM_RING_CONFIG];
	void __iomem *cmd_base;
	void __iomem *cmd;
	dma_addr_t dma;
	u16 dst_ring_num;
	u8 nbufpool;
	struct sk_buff *(*rx_skb);
	struct sk_buff *(*cp_skb);
	enum xgene_enet_ring_cfgsize cfgsize;
	struct xgene_enet_desc_ring *cp_ring;
	struct xgene_enet_desc_ring *buf_pool;
	struct napi_struct napi;
	union {
		void *desc_addr;
		struct xgene_enet_raw_desc *raw_desc;
		struct xgene_enet_raw_desc16 *raw_desc16;
	};
};

struct xgene_mac_ops {
	void (*init)(struct xgene_enet_pdata *pdata);
	void (*reset)(struct xgene_enet_pdata *pdata);
	void (*tx_enable)(struct xgene_enet_pdata *pdata);
	void (*rx_enable)(struct xgene_enet_pdata *pdata);
	void (*tx_disable)(struct xgene_enet_pdata *pdata);
	void (*rx_disable)(struct xgene_enet_pdata *pdata);
	void (*set_mac_addr)(struct xgene_enet_pdata *pdata);
	void (*link_state)(struct work_struct *work);
};

struct xgene_port_ops {
	void (*reset)(struct xgene_enet_pdata *pdata);
	void (*cle_bypass)(struct xgene_enet_pdata *pdata,
			   u32 dst_ring_num, u16 bufpool_id);
	void (*shutdown)(struct xgene_enet_pdata *pdata);
};

/* ethernet private data */
struct xgene_enet_pdata {
	struct net_device *ndev;
	struct mii_bus *mdio_bus;
	struct phy_device *phy_dev;
	int phy_speed;
	struct clk *clk;
	struct platform_device *pdev;
	struct xgene_enet_desc_ring *tx_ring;
	struct xgene_enet_desc_ring *rx_ring;
	char *dev_name;
	u32 rx_buff_cnt;
	u32 tx_qcnt_hi;
	u32 cp_qcnt_hi;
	u32 cp_qcnt_low;
	u32 rx_irq;
	void __iomem *eth_csr_addr;
	void __iomem *eth_ring_if_addr;
	void __iomem *eth_diag_csr_addr;
	void __iomem *mcx_mac_addr;
	void __iomem *mcx_mac_csr_addr;
	void __iomem *base_addr;
	void __iomem *ring_csr_addr;
	void __iomem *ring_cmd_addr;
	int phy_mode;
	enum xgene_enet_rm rm;
	struct rtnl_link_stats64 stats;
	struct xgene_mac_ops *mac_ops;
	struct xgene_port_ops *port_ops;
	struct delayed_work link_work;
};

/* Set the specified value into a bit-field defined by its starting position
 * and length within a single u64.
 */
static inline u64 xgene_enet_set_field_value(int pos, int len, u64 val)
{
	return (val & ((1ULL << len) - 1)) << pos;
}

#define SET_VAL(field, val) \
		xgene_enet_set_field_value(field ## _POS, field ## _LEN, val)

#define SET_BIT(field) \
		xgene_enet_set_field_value(field ## _POS, 1, 1)

/* Get the value from a bit-field defined by its starting position
 * and length within the specified u64.
 */
static inline u64 xgene_enet_get_field_value(int pos, int len, u64 src)
{
	return (src >> pos) & ((1ULL << len) - 1);
}

#define GET_VAL(field, src) \
		xgene_enet_get_field_value(field ## _POS, field ## _LEN, src)

static inline struct device *ndev_to_dev(struct net_device *ndev)
{
	return ndev->dev.parent;
}

void xgene_enet_set_ethtool_ops(struct net_device *netdev);

#endif /* __XGENE_ENET_MAIN_H__ */
Commit	Line	Data
e6ad7673 IS	1	/* Applied Micro X-Gene SoC Ethernet Driver
	2	*
	3	* Copyright (c) 2014, Applied Micro Circuits Corporation
	4	* Authors: Iyappan Subramanian <isubramanian@apm.com>
	5	* Ravi Patel <rapatel@apm.com>
	6	* Keyur Chudgar <kchudgar@apm.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2 of the License, or (at your
	11	* option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	20	*/
	21
	22	#ifndef __XGENE_ENET_MAIN_H__
	23	#define __XGENE_ENET_MAIN_H__
	24
	25	#include <linux/clk.h>
	26	#include <linux/of_platform.h>
	27	#include <linux/of_net.h>
	28	#include <linux/of_mdio.h>
	29	#include <linux/module.h>
	30	#include <net/ip.h>
	31	#include <linux/prefetch.h>
	32	#include <linux/if_vlan.h>
	33	#include <linux/phy.h>
	34	#include "xgene_enet_hw.h"
	35
	36	#define XGENE_DRV_VERSION "v1.0"
	37	#define XGENE_ENET_MAX_MTU 1536
	38	#define SKB_BUFFER_SIZE (XGENE_ENET_MAX_MTU - NET_IP_ALIGN)
	39	#define NUM_PKT_BUF 64
	40	#define NUM_BUFPOOL 32
	41
	42	/* software context of a descriptor ring */
	43	struct xgene_enet_desc_ring {
	44	struct net_device *ndev;
	45	u16 id;
	46	u16 num;
	47	u16 head;
	48	u16 tail;
	49	u16 slots;
	50	u16 irq;
	51	u32 size;
	52	u32 state[NUM_RING_CONFIG];
	53	void __iomem *cmd_base;
	54	void __iomem *cmd;
	55	dma_addr_t dma;
	56	u16 dst_ring_num;
	57	u8 nbufpool;
	58	struct sk_buff (rx_skb);
	59	struct sk_buff (cp_skb);
	60	enum xgene_enet_ring_cfgsize cfgsize;
	61	struct xgene_enet_desc_ring *cp_ring;
	62	struct xgene_enet_desc_ring *buf_pool;
	63	struct napi_struct napi;
	64	union {
65	void *desc_addr;
66	struct xgene_enet_raw_desc *raw_desc;
67	struct xgene_enet_raw_desc16 *raw_desc16;
68	};
69	};
70
d0eb7458 IS	71	struct xgene_mac_ops {
	72	void (init)(struct xgene_enet_pdata pdata);
	73	void (reset)(struct xgene_enet_pdata pdata);
	74	void (tx_enable)(struct xgene_enet_pdata pdata);
	75	void (rx_enable)(struct xgene_enet_pdata pdata);
	76	void (tx_disable)(struct xgene_enet_pdata pdata);
	77	void (rx_disable)(struct xgene_enet_pdata pdata);
	78	void (set_mac_addr)(struct xgene_enet_pdata pdata);
dc8385f0	79	void (link_state)(struct work_struct work);
d0eb7458 IS	80	};
	81
	82	struct xgene_port_ops {
	83	void (reset)(struct xgene_enet_pdata pdata);
	84	void (cle_bypass)(struct xgene_enet_pdata pdata,
	85	u32 dst_ring_num, u16 bufpool_id);
	86	void (shutdown)(struct xgene_enet_pdata pdata);
	87	};
	88
e6ad7673 IS	89	/* ethernet private data */
	90	struct xgene_enet_pdata {
	91	struct net_device *ndev;
	92	struct mii_bus *mdio_bus;
	93	struct phy_device *phy_dev;
	94	int phy_speed;
	95	struct clk *clk;
	96	struct platform_device *pdev;
	97	struct xgene_enet_desc_ring *tx_ring;
	98	struct xgene_enet_desc_ring *rx_ring;
	99	char *dev_name;
	100	u32 rx_buff_cnt;
	101	u32 tx_qcnt_hi;
	102	u32 cp_qcnt_hi;
	103	u32 cp_qcnt_low;
	104	u32 rx_irq;
	105	void __iomem *eth_csr_addr;
	106	void __iomem *eth_ring_if_addr;
	107	void __iomem *eth_diag_csr_addr;
	108	void __iomem *mcx_mac_addr;
e6ad7673 IS	109	void __iomem *mcx_mac_csr_addr;
	110	void __iomem *base_addr;
	111	void __iomem *ring_csr_addr;
	112	void __iomem *ring_cmd_addr;
e6ad7673	113	int phy_mode;
0148d38d	114	enum xgene_enet_rm rm;
e6ad7673	115	struct rtnl_link_stats64 stats;
d0eb7458 IS	116	struct xgene_mac_ops *mac_ops;
d0eb7458 IS	117	struct xgene_port_ops *port_ops;
0148d38d	118	struct delayed_work link_work;
e6ad7673 IS	119	};
	120
	121	/* Set the specified value into a bit-field defined by its starting position
	122	* and length within a single u64.
	123	*/
	124	static inline u64 xgene_enet_set_field_value(int pos, int len, u64 val)
	125	{
	126	return (val & ((1ULL << len) - 1)) << pos;
	127	}
	128
	129	#define SET_VAL(field, val) \
	130	xgene_enet_set_field_value(field ## _POS, field ## _LEN, val)
	131
	132	#define SET_BIT(field) \
	133	xgene_enet_set_field_value(field ## _POS, 1, 1)
	134
	135	/* Get the value from a bit-field defined by its starting position
	136	* and length within the specified u64.
	137	*/
	138	static inline u64 xgene_enet_get_field_value(int pos, int len, u64 src)
	139	{
	140	return (src >> pos) & ((1ULL << len) - 1);
	141	}
	142
	143	#define GET_VAL(field, src) \
	144	xgene_enet_get_field_value(field ## _POS, field ## _LEN, src)
	145
	146	static inline struct device ndev_to_dev(struct net_device ndev)
	147	{
	148	return ndev->dev.parent;
	149	}
	150
	151	void xgene_enet_set_ethtool_ops(struct net_device *netdev);
	152
	153	#endif /* __XGENE_ENET_MAIN_H__ */