/*	$NetBSD: vhci.h,v 1.2 2020/03/31 16:34:25 maxv Exp $ */

/*
 * Copyright (c) 2019-2020 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Maxime Villard.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
 */


#define VHCI_PACKET_REQ_WITH_DATA 0x0001
#define VHCI_PACKET_REQ_UTOH 0x0002
#define VHCI_PACKET_IS_REQ 0x0100
#define VHCI_PACKET_IS_RES 0x0200
#define VHCI_PACKET_IS_DAT 0x0400

/* These two are pseudo requests.  The one called vhci_device_request_t is used
 * for BULK and INTERRUPT requests and the one called vhci_device_request_isoc_t
 * is used for ISOCHRONOUS requests.  The other one in the union, usb_device_request_t
 * is used for CONTROL requests, and is presented literally to the device.  The other
 * two are not passed literally, but the information is used to perform the request.
 */

typedef struct {
	uint16_t  flags;
	uint32_t length;
	uint8_t interval;
} vhci_device_request_t;

typedef struct {
	uint16_t  flags;
	uint16_t nframes;
	uint8_t interval;
} vhci_device_request_isoc_t;

typedef struct {
	int type;
#define VHCI_REQ_CTRL		0
#define VHCI_REQ_ISOCHRONOUS	1
#define VHCI_REQ_BULK		2
#define VHCI_REQ_INTERRUPT	3

	union {
		usb_device_request_t ctrl;
		vhci_device_request_t req;
		vhci_device_request_isoc_t reqisoc;
	} u;
} vhci_request_t;

/* This is a response packet.
 *
 * XXX - This is probably not complete enough to be used for a
 * device-to-host ISOCHRONOUS response as it is missing an
 * indicator of the number of frames.
 */

typedef struct {
	size_t size;
	uint8_t error;
} vhci_response_t;

/* Used to get some simple information about the current state
 * of VHCI.
 */

struct vhci_ioc_get_info {
	/* General. */
	size_t nports;

	/* Current port. */
	u_int port;
	int status;

	/* Current addr. */
	uint8_t addr;
};

/* Set the virtual port that read / write operations are to be
 * performed against.
 */

struct vhci_ioc_set_port {
	u_int port;
};

/* Set the address, also known as the USB end point that the read
 * and write operations are to be performed against.
 */

struct vhci_ioc_set_addr {
	uint8_t addr;
};

/* Used to get a peek at the head packet on one of the VHCI
 * queues.
 */

struct vhci_ioc_get_head {
	uint8_t what;
#define VHCI_HEAD_UTOH 1
#define VHCI_HEAD_HTOU 2
	size_t len;
	int ptype;
	int npkts;
	uint16_t flags;
};

/* If true change the protocol used by VHCI to require a response
 * packet for every request.  By default, VHCI uses its original
 * mode where the response is completed inside of the driver.  This
 * prevents any errors from being reported back for a lot of the requests.
 *
 * The second mode requires a reponse packet for every request and this can
 * be used to report a good tranfer or an error transfer.
 */

struct vhci_ioc_set_result_errors {
	bool result_errors;
};

#define VHCI_IOC_GET_INFO	_IOR('V', 0, struct vhci_ioc_get_info)
#define VHCI_IOC_SET_PORT	_IOW('V', 1, struct vhci_ioc_set_port)
#define VHCI_IOC_SET_ADDR	_IOW('V', 2, struct vhci_ioc_set_addr)
#define VHCI_IOC_USB_ATTACH	_IO ('V', 10)
#define VHCI_IOC_USB_DETACH	_IO ('V', 11)
#define VHCI_IOC_GET_HEAD	_IOWR('V', 12, struct vhci_ioc_get_head)
#define VHCI_IOC_SET_RES_ERR	_IOW('V', 13, struct vhci_ioc_set_result_errors)