[deliverable/linux.git] / drivers / net / enic / vnic_dev.h

/*
 * Copyright 2008 Cisco Systems, Inc.  All rights reserved.
 * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
 *
 * This program is free software; you may redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

#ifndef _VNIC_DEV_H_
#define _VNIC_DEV_H_

#include "vnic_resource.h"
#include "vnic_devcmd.h"

#ifndef VNIC_PADDR_TARGET
#define VNIC_PADDR_TARGET	0x0000000000000000ULL
#endif

#ifndef readq
static inline u64 readq(void __iomem *reg)
{
	return (((u64)readl(reg + 0x4UL) << 32) |
		(u64)readl(reg));
}

static inline void writeq(u64 val, void __iomem *reg)
{
	writel(val & 0xffffffff, reg);
	writel(val >> 32, reg + 0x4UL);
}
#endif

enum vnic_dev_hw_version {
	VNIC_DEV_HW_VER_UNKNOWN,
	VNIC_DEV_HW_VER_A1,
	VNIC_DEV_HW_VER_A2,
};

enum vnic_dev_intr_mode {
	VNIC_DEV_INTR_MODE_UNKNOWN,
	VNIC_DEV_INTR_MODE_INTX,
	VNIC_DEV_INTR_MODE_MSI,
	VNIC_DEV_INTR_MODE_MSIX,
};

struct vnic_dev_bar {
	void __iomem *vaddr;
	dma_addr_t bus_addr;
	unsigned long len;
};

struct vnic_dev_ring {
	void *descs;
	size_t size;
	dma_addr_t base_addr;
	size_t base_align;
	void *descs_unaligned;
	size_t size_unaligned;
	dma_addr_t base_addr_unaligned;
	unsigned int desc_size;
	unsigned int desc_count;
	unsigned int desc_avail;
};

struct vnic_dev;
struct vnic_stats;

void *vnic_dev_priv(struct vnic_dev *vdev);
unsigned int vnic_dev_get_res_count(struct vnic_dev *vdev,
	enum vnic_res_type type);
void __iomem *vnic_dev_get_res(struct vnic_dev *vdev, enum vnic_res_type type,
	unsigned int index);
dma_addr_t vnic_dev_get_res_bus_addr(struct vnic_dev *vdev,
	enum vnic_res_type type, unsigned int index);
unsigned int vnic_dev_desc_ring_size(struct vnic_dev_ring *ring,
	unsigned int desc_count, unsigned int desc_size);
void vnic_dev_clear_desc_ring(struct vnic_dev_ring *ring);
int vnic_dev_alloc_desc_ring(struct vnic_dev *vdev, struct vnic_dev_ring *ring,
	unsigned int desc_count, unsigned int desc_size);
void vnic_dev_free_desc_ring(struct vnic_dev *vdev,
	struct vnic_dev_ring *ring);
int vnic_dev_cmd(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
	u64 *a0, u64 *a1, int wait);
int vnic_dev_fw_info(struct vnic_dev *vdev,
	struct vnic_devcmd_fw_info **fw_info);
int vnic_dev_hw_version(struct vnic_dev *vdev,
	enum vnic_dev_hw_version *hw_ver);
int vnic_dev_spec(struct vnic_dev *vdev, unsigned int offset, unsigned int size,
	void *value);
int vnic_dev_stats_clear(struct vnic_dev *vdev);
int vnic_dev_stats_dump(struct vnic_dev *vdev, struct vnic_stats **stats);
int vnic_dev_hang_notify(struct vnic_dev *vdev);
void vnic_dev_packet_filter(struct vnic_dev *vdev, int directed, int multicast,
	int broadcast, int promisc, int allmulti);
void vnic_dev_add_addr(struct vnic_dev *vdev, u8 *addr);
void vnic_dev_del_addr(struct vnic_dev *vdev, u8 *addr);
int vnic_dev_mac_addr(struct vnic_dev *vdev, u8 *mac_addr);
int vnic_dev_raise_intr(struct vnic_dev *vdev, u16 intr);
int vnic_dev_notify_set(struct vnic_dev *vdev, u16 intr);
void vnic_dev_notify_unset(struct vnic_dev *vdev);
int vnic_dev_link_status(struct vnic_dev *vdev);
u32 vnic_dev_port_speed(struct vnic_dev *vdev);
u32 vnic_dev_msg_lvl(struct vnic_dev *vdev);
u32 vnic_dev_mtu(struct vnic_dev *vdev);
u32 vnic_dev_link_down_cnt(struct vnic_dev *vdev);
u32 vnic_dev_notify_status(struct vnic_dev *vdev);
int vnic_dev_close(struct vnic_dev *vdev);
int vnic_dev_enable(struct vnic_dev *vdev);
int vnic_dev_disable(struct vnic_dev *vdev);
int vnic_dev_open(struct vnic_dev *vdev, int arg);
int vnic_dev_open_done(struct vnic_dev *vdev, int *done);
int vnic_dev_init(struct vnic_dev *vdev, int arg);
int vnic_dev_soft_reset(struct vnic_dev *vdev, int arg);
int vnic_dev_soft_reset_done(struct vnic_dev *vdev, int *done);
void vnic_dev_set_intr_mode(struct vnic_dev *vdev,
	enum vnic_dev_intr_mode intr_mode);
enum vnic_dev_intr_mode vnic_dev_get_intr_mode(struct vnic_dev *vdev);
void vnic_dev_unregister(struct vnic_dev *vdev);
struct vnic_dev *vnic_dev_register(struct vnic_dev *vdev,
	void *priv, struct pci_dev *pdev, struct vnic_dev_bar *bar,
	unsigned int num_bars);

#endif /* _VNIC_DEV_H_ */
Commit	Line	Data
01f2e4ea SF	1	/*
	2	* Copyright 2008 Cisco Systems, Inc. All rights reserved.
	3	* Copyright 2007 Nuova Systems, Inc. All rights reserved.
	4	*
	5	* This program is free software; you may redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; version 2 of the License.
	8	*
	9	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	10	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	11	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	12	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	13	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	14	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	15	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	16	* SOFTWARE.
	17	*
	18	*/
	19
	20	#ifndef _VNIC_DEV_H_
	21	#define _VNIC_DEV_H_
	22
	23	#include "vnic_resource.h"
	24	#include "vnic_devcmd.h"
	25
	26	#ifndef VNIC_PADDR_TARGET
	27	#define VNIC_PADDR_TARGET 0x0000000000000000ULL
	28	#endif
	29
55ed31e6 DM	30	#ifndef readq
	31	static inline u64 readq(void __iomem *reg)
	32	{
	33	return (((u64)readl(reg + 0x4UL) << 32) \|
	34	(u64)readl(reg));
	35	}
	36
	37	static inline void writeq(u64 val, void __iomem *reg)
	38	{
	39	writel(val & 0xffffffff, reg);
	40	writel(val >> 32, reg + 0x4UL);
	41	}
	42	#endif
	43
4badc385 SF	44	enum vnic_dev_hw_version {
	45	VNIC_DEV_HW_VER_UNKNOWN,
	46	VNIC_DEV_HW_VER_A1,
	47	VNIC_DEV_HW_VER_A2,
	48	};
	49
01f2e4ea SF	50	enum vnic_dev_intr_mode {
	51	VNIC_DEV_INTR_MODE_UNKNOWN,
	52	VNIC_DEV_INTR_MODE_INTX,
	53	VNIC_DEV_INTR_MODE_MSI,
	54	VNIC_DEV_INTR_MODE_MSIX,
	55	};
	56
	57	struct vnic_dev_bar {
	58	void __iomem *vaddr;
	59	dma_addr_t bus_addr;
	60	unsigned long len;
	61	};
	62
	63	struct vnic_dev_ring {
	64	void *descs;
	65	size_t size;
	66	dma_addr_t base_addr;
	67	size_t base_align;
	68	void *descs_unaligned;
	69	size_t size_unaligned;
	70	dma_addr_t base_addr_unaligned;
	71	unsigned int desc_size;
	72	unsigned int desc_count;
	73	unsigned int desc_avail;
	74	};
	75
	76	struct vnic_dev;
	77	struct vnic_stats;
	78
	79	void vnic_dev_priv(struct vnic_dev vdev);
	80	unsigned int vnic_dev_get_res_count(struct vnic_dev *vdev,
	81	enum vnic_res_type type);
	82	void __iomem vnic_dev_get_res(struct vnic_dev vdev, enum vnic_res_type type,
	83	unsigned int index);
27e6c7d3 SF	84	dma_addr_t vnic_dev_get_res_bus_addr(struct vnic_dev *vdev,
27e6c7d3 SF	85	enum vnic_res_type type, unsigned int index);
01f2e4ea SF	86	unsigned int vnic_dev_desc_ring_size(struct vnic_dev_ring *ring,
	87	unsigned int desc_count, unsigned int desc_size);
	88	void vnic_dev_clear_desc_ring(struct vnic_dev_ring *ring);
	89	int vnic_dev_alloc_desc_ring(struct vnic_dev vdev, struct vnic_dev_ring ring,
	90	unsigned int desc_count, unsigned int desc_size);
	91	void vnic_dev_free_desc_ring(struct vnic_dev *vdev,
	92	struct vnic_dev_ring *ring);
	93	int vnic_dev_cmd(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
	94	u64 a0, u64 a1, int wait);
	95	int vnic_dev_fw_info(struct vnic_dev *vdev,
	96	struct vnic_devcmd_fw_info **fw_info);
4badc385 SF	97	int vnic_dev_hw_version(struct vnic_dev *vdev,
4badc385 SF	98	enum vnic_dev_hw_version *hw_ver);
01f2e4ea SF	99	int vnic_dev_spec(struct vnic_dev *vdev, unsigned int offset, unsigned int size,
	100	void *value);
	101	int vnic_dev_stats_clear(struct vnic_dev *vdev);
	102	int vnic_dev_stats_dump(struct vnic_dev vdev, struct vnic_stats *stats);
	103	int vnic_dev_hang_notify(struct vnic_dev *vdev);
	104	void vnic_dev_packet_filter(struct vnic_dev *vdev, int directed, int multicast,
	105	int broadcast, int promisc, int allmulti);
	106	void vnic_dev_add_addr(struct vnic_dev vdev, u8 addr);
	107	void vnic_dev_del_addr(struct vnic_dev vdev, u8 addr);
	108	int vnic_dev_mac_addr(struct vnic_dev vdev, u8 mac_addr);
d73149f5	109	int vnic_dev_raise_intr(struct vnic_dev *vdev, u16 intr);
01f2e4ea SF	110	int vnic_dev_notify_set(struct vnic_dev *vdev, u16 intr);
	111	void vnic_dev_notify_unset(struct vnic_dev *vdev);
	112	int vnic_dev_link_status(struct vnic_dev *vdev);
	113	u32 vnic_dev_port_speed(struct vnic_dev *vdev);
	114	u32 vnic_dev_msg_lvl(struct vnic_dev *vdev);
	115	u32 vnic_dev_mtu(struct vnic_dev *vdev);
4cdc44a2 SF	116	u32 vnic_dev_link_down_cnt(struct vnic_dev *vdev);
4cdc44a2 SF	117	u32 vnic_dev_notify_status(struct vnic_dev *vdev);
01f2e4ea SF	118	int vnic_dev_close(struct vnic_dev *vdev);
	119	int vnic_dev_enable(struct vnic_dev *vdev);
	120	int vnic_dev_disable(struct vnic_dev *vdev);
	121	int vnic_dev_open(struct vnic_dev *vdev, int arg);
	122	int vnic_dev_open_done(struct vnic_dev vdev, int done);
	123	int vnic_dev_init(struct vnic_dev *vdev, int arg);
	124	int vnic_dev_soft_reset(struct vnic_dev *vdev, int arg);
	125	int vnic_dev_soft_reset_done(struct vnic_dev vdev, int done);
	126	void vnic_dev_set_intr_mode(struct vnic_dev *vdev,
	127	enum vnic_dev_intr_mode intr_mode);
	128	enum vnic_dev_intr_mode vnic_dev_get_intr_mode(struct vnic_dev *vdev);
	129	void vnic_dev_unregister(struct vnic_dev *vdev);
	130	struct vnic_dev vnic_dev_register(struct vnic_dev vdev,
27e6c7d3 SF	131	void priv, struct pci_dev pdev, struct vnic_dev_bar *bar,
27e6c7d3 SF	132	unsigned int num_bars);
01f2e4ea SF	133
01f2e4ea SF	134	#endif /* _VNIC_DEV_H_ */