[linux.git] / drivers / scsi / fnic / vnic_cq.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_CQ_H_
#define _VNIC_CQ_H_

#include "cq_desc.h"
#include "vnic_dev.h"

/*
 * These defines avoid symbol clash between fnic and enic (Cisco 10G Eth
 * Driver) when both are built with CONFIG options =y
 */
#define vnic_cq_service fnic_cq_service
#define vnic_cq_free fnic_cq_free
#define vnic_cq_alloc fnic_cq_alloc
#define vnic_cq_init fnic_cq_init
#define vnic_cq_clean fnic_cq_clean

/* Completion queue control */
struct vnic_cq_ctrl {
	u64 ring_base;			/* 0x00 */
	u32 ring_size;			/* 0x08 */
	u32 pad0;
	u32 flow_control_enable;	/* 0x10 */
	u32 pad1;
	u32 color_enable;		/* 0x18 */
	u32 pad2;
	u32 cq_head;			/* 0x20 */
	u32 pad3;
	u32 cq_tail;			/* 0x28 */
	u32 pad4;
	u32 cq_tail_color;		/* 0x30 */
	u32 pad5;
	u32 interrupt_enable;		/* 0x38 */
	u32 pad6;
	u32 cq_entry_enable;		/* 0x40 */
	u32 pad7;
	u32 cq_message_enable;		/* 0x48 */
	u32 pad8;
	u32 interrupt_offset;		/* 0x50 */
	u32 pad9;
	u64 cq_message_addr;		/* 0x58 */
	u32 pad10;
};

struct vnic_cq {
	unsigned int index;
	struct vnic_dev *vdev;
	struct vnic_cq_ctrl __iomem *ctrl;	/* memory-mapped */
	struct vnic_dev_ring ring;
	unsigned int to_clean;
	unsigned int last_color;
};

static inline unsigned int vnic_cq_service(struct vnic_cq *cq,
	unsigned int work_to_do,
	int (*q_service)(struct vnic_dev *vdev, struct cq_desc *cq_desc,
	u8 type, u16 q_number, u16 completed_index, void *opaque),
	void *opaque)
{
	struct cq_desc *cq_desc;
	unsigned int work_done = 0;
	u16 q_number, completed_index;
	u8 type, color;

	cq_desc = (struct cq_desc *)((u8 *)cq->ring.descs +
		cq->ring.desc_size * cq->to_clean);
	cq_desc_dec(cq_desc, &type, &color,
		&q_number, &completed_index);

	while (color != cq->last_color) {

		if ((*q_service)(cq->vdev, cq_desc, type,
			q_number, completed_index, opaque))
			break;

		cq->to_clean++;
		if (cq->to_clean == cq->ring.desc_count) {
			cq->to_clean = 0;
			cq->last_color = cq->last_color ? 0 : 1;
		}

		cq_desc = (struct cq_desc *)((u8 *)cq->ring.descs +
			cq->ring.desc_size * cq->to_clean);
		cq_desc_dec(cq_desc, &type, &color,
			&q_number, &completed_index);

		work_done++;
		if (work_done >= work_to_do)
			break;
	}

	return work_done;
}

void vnic_cq_free(struct vnic_cq *cq);
int vnic_cq_alloc(struct vnic_dev *vdev, struct vnic_cq *cq, unsigned int index,
	unsigned int desc_count, unsigned int desc_size);
void vnic_cq_init(struct vnic_cq *cq, unsigned int flow_control_enable,
	unsigned int color_enable, unsigned int cq_head, unsigned int cq_tail,
	unsigned int cq_tail_color, unsigned int interrupt_enable,
	unsigned int cq_entry_enable, unsigned int message_enable,
	unsigned int interrupt_offset, u64 message_addr);
void vnic_cq_clean(struct vnic_cq *cq);

#endif /* _VNIC_CQ_H_ */
Commit	Line	Data
5df6d737 AJ	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	#ifndef _VNIC_CQ_H_
	19	#define _VNIC_CQ_H_
	20
	21	#include "cq_desc.h"
	22	#include "vnic_dev.h"
	23
	24	/*
	25	* These defines avoid symbol clash between fnic and enic (Cisco 10G Eth
	26	* Driver) when both are built with CONFIG options =y
	27	*/
	28	#define vnic_cq_service fnic_cq_service
	29	#define vnic_cq_free fnic_cq_free
	30	#define vnic_cq_alloc fnic_cq_alloc
	31	#define vnic_cq_init fnic_cq_init
	32	#define vnic_cq_clean fnic_cq_clean
	33
	34	/* Completion queue control */
	35	struct vnic_cq_ctrl {
	36	u64 ring_base; /* 0x00 */
	37	u32 ring_size; /* 0x08 */
	38	u32 pad0;
	39	u32 flow_control_enable; /* 0x10 */
	40	u32 pad1;
	41	u32 color_enable; /* 0x18 */
	42	u32 pad2;
	43	u32 cq_head; /* 0x20 */
	44	u32 pad3;
	45	u32 cq_tail; /* 0x28 */
	46	u32 pad4;
	47	u32 cq_tail_color; /* 0x30 */
	48	u32 pad5;
	49	u32 interrupt_enable; /* 0x38 */
	50	u32 pad6;
	51	u32 cq_entry_enable; /* 0x40 */
	52	u32 pad7;
	53	u32 cq_message_enable; /* 0x48 */
	54	u32 pad8;
	55	u32 interrupt_offset; /* 0x50 */
	56	u32 pad9;
	57	u64 cq_message_addr; /* 0x58 */
	58	u32 pad10;
	59	};
	60
	61	struct vnic_cq {
	62	unsigned int index;
	63	struct vnic_dev *vdev;
	64	struct vnic_cq_ctrl __iomem ctrl; / memory-mapped */
65	struct vnic_dev_ring ring;
66	unsigned int to_clean;
67	unsigned int last_color;
68	};
69
70	static inline unsigned int vnic_cq_service(struct vnic_cq *cq,
71	unsigned int work_to_do,
72	int (q_service)(struct vnic_dev vdev, struct cq_desc *cq_desc,
73	u8 type, u16 q_number, u16 completed_index, void *opaque),
74	void *opaque)
75	{
76	struct cq_desc *cq_desc;
77	unsigned int work_done = 0;
78	u16 q_number, completed_index;
79	u8 type, color;
80
81	cq_desc = (struct cq_desc )((u8 )cq->ring.descs +
82	cq->ring.desc_size * cq->to_clean);
83	cq_desc_dec(cq_desc, &type, &color,
84	&q_number, &completed_index);
85
86	while (color != cq->last_color) {
87
88	if ((*q_service)(cq->vdev, cq_desc, type,
89	q_number, completed_index, opaque))
90	break;
91
92	cq->to_clean++;
93	if (cq->to_clean == cq->ring.desc_count) {
94	cq->to_clean = 0;
95	cq->last_color = cq->last_color ? 0 : 1;
96	}
97
98	cq_desc = (struct cq_desc )((u8 )cq->ring.descs +
99	cq->ring.desc_size * cq->to_clean);
100	cq_desc_dec(cq_desc, &type, &color,
101	&q_number, &completed_index);
102
103	work_done++;
104	if (work_done >= work_to_do)
105	break;
106	}
107
108	return work_done;
109	}
110
111	void vnic_cq_free(struct vnic_cq *cq);
112	int vnic_cq_alloc(struct vnic_dev vdev, struct vnic_cq cq, unsigned int index,
113	unsigned int desc_count, unsigned int desc_size);
114	void vnic_cq_init(struct vnic_cq *cq, unsigned int flow_control_enable,
115	unsigned int color_enable, unsigned int cq_head, unsigned int cq_tail,
116	unsigned int cq_tail_color, unsigned int interrupt_enable,
117	unsigned int cq_entry_enable, unsigned int message_enable,
118	unsigned int interrupt_offset, u64 message_addr);
119	void vnic_cq_clean(struct vnic_cq *cq);
120
121	#endif /* _VNIC_CQ_H_ */