/******************************************************************************
 * usbif.h
 * 
 * Unified block-device I/O interface for Xen guest OSes.
 * 
 * Copyright (c) 2003-2004, Keir Fraser
 */

#ifndef __SHARED_USBIF_H__
#define __SHARED_USBIF_H__

#define usbif_vdev_t   u16
#define usbif_sector_t u64

#define USBIF_OP_IO      0 /* Request IO to a device */
#define USBIF_OP_PROBE   1 /* Is there a device on this port? */
#define USBIF_OP_RESET   2 /* Reset a virtual USB port.       */

typedef struct {
    unsigned long  id;           /* private guest value, echoed in resp  */
    u8             operation;    /* USBIF_OP_???                         */
    u8  __pad1;
    usbif_vdev_t   port;         /* guest virtual USB port               */
    unsigned long  devnum :7;    /* Device address, as seen by the guest.*/
    unsigned long  endpoint :4;  /* Device endpoint.                         */
    unsigned long  direction :1; /* Pipe direction.                          */
    unsigned long  speed :1;     /* Pipe speed.                              */
    unsigned long  pipe_type :2; /* Pipe type (iso, bulk, int, ctrl)         */
    unsigned long  __pad2 :18;
    unsigned long  transfer_buffer; /* Machine address */
    unsigned long  length;          /* Buffer length */
    unsigned long  transfer_flags;  /* For now just pass Linux transfer
                                     * flags - this may change. */
    unsigned char setup[8];         /* Embed setup packets directly. */
    unsigned long  iso_schedule;    /* Machine address of transfer sched (iso
                                     * only) */
    unsigned long num_iso;        /* length of iso schedule */
    unsigned long timeout;        /* timeout in ms */
} usbif_request_t;

/* Data we need to pass:
 * - Transparently handle short packets or complain at us?
 */

typedef struct {
    unsigned long   id;              /* copied from request         */
    u8              operation;       /* copied from request         */
    u8              data;            /* Small chunk of in-band data */
    s16             status;          /* USBIF_RSP_???               */
    unsigned long   transfer_mutex;  /* Used for cancelling requests atomically. */
    unsigned long    length;         /* How much data we really got */
} usbif_response_t;

#define USBIF_RSP_ERROR  -1 /* non-specific 'error' */
#define USBIF_RSP_OKAY    0 /* non-specific 'okay'  */

DEFINE_RING_TYPES(usbif, usbif_request_t, usbif_response_t);

typedef struct {
    unsigned long length; /* IN = expected, OUT = actual */
    unsigned long buffer_offset;  /* IN offset in buffer specified in main
                                     packet */
    unsigned long status; /* OUT Status for this packet. */
} usbif_iso_t;

#endif /* __SHARED_USBIF_H__ */