/*
 * Copyright (c) 2017, Stefan Lankes, RWTH Aachen University
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    * Neither the name of the University nor the names of its contributors
 *      may be used to endorse or promote products derived from this
 *      software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __NET_VIOIF_H__
#define __NET_VIOIF_H__

#include <hermit/stddef.h>
#include <hermit/virtio_ring.h>

#define VIOIF_NUM_QUEUES	2

typedef struct
{
	struct vring vring;
	uint64_t virt_buffer;
	uint64_t phys_buffer;
	uint16_t last_seen_used;
} virt_queue_t;

/*
 * Helper struct to hold private data used to operate your ethernet interface.
 */
typedef struct vioif {
	struct eth_addr *ethaddr;
	/* Add whatever per-interface state that is needed here. */
	uint32_t		iomem;
	uint32_t		iobase;
	uint32_t		features;
	uint8_t			msix_enabled;
	uint8_t			irq;
	uint8_t			polling;
	virt_queue_t	queues[VIOIF_NUM_QUEUES];
} vioif_t;

/*
 * Initialize the network driver for the virtio network interface
 */
err_t vioif_init(struct netif* netif);

#endif