usbhc_iface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010 Vojtech Horky
 * 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 LIBDRV_USBHC_IFACE_H_
#define LIBDRV_USBHC_IFACE_H_

#include "ddf/driver.h"
#include <usb/usb.h>
#include <bool.h>


typedef enum {
        IPC_M_USBHC_REQUEST_ADDRESS,

        IPC_M_USBHC_BIND_ADDRESS,

        IPC_M_USBHC_GET_HANDLE_BY_ADDRESS,

        IPC_M_USBHC_RELEASE_ADDRESS,


        IPC_M_USBHC_INTERRUPT_OUT,

        IPC_M_USBHC_INTERRUPT_IN,

        IPC_M_USBHC_BULK_OUT,

        IPC_M_USBHC_BULK_IN,

        IPC_M_USBHC_CONTROL_WRITE,

        IPC_M_USBHC_CONTROL_READ,

        IPC_M_USBHC_REGISTER_ENDPOINT,

        IPC_M_USBHC_UNREGISTER_ENDPOINT
} usbhc_iface_funcs_t;

typedef void (*usbhc_iface_transfer_out_callback_t)(ddf_fun_t *,
    int, void *);

typedef void (*usbhc_iface_transfer_in_callback_t)(ddf_fun_t *,
    int, size_t, void *);


typedef int (*usbhc_iface_transfer_out_t)(ddf_fun_t *, usb_target_t,
    void *, size_t,
    usbhc_iface_transfer_out_callback_t, void *);

typedef usbhc_iface_transfer_out_t usbhc_iface_transfer_setup_t;

typedef int (*usbhc_iface_transfer_in_t)(ddf_fun_t *, usb_target_t,
    void *, size_t,
    usbhc_iface_transfer_in_callback_t, void *);

typedef struct {
        int (*request_address)(ddf_fun_t *, usb_speed_t, usb_address_t *);
        int (*bind_address)(ddf_fun_t *, usb_address_t, devman_handle_t);
        int (*find_by_address)(ddf_fun_t *, usb_address_t, devman_handle_t *);
        int (*release_address)(ddf_fun_t *, usb_address_t);

        int (*register_endpoint)(ddf_fun_t *,
            usb_address_t, usb_speed_t, usb_endpoint_t,
            usb_transfer_type_t, usb_direction_t, size_t, unsigned int);
        int (*unregister_endpoint)(ddf_fun_t *, usb_address_t, usb_endpoint_t,
            usb_direction_t);

        usbhc_iface_transfer_out_t interrupt_out;
        usbhc_iface_transfer_in_t interrupt_in;

        usbhc_iface_transfer_out_t bulk_out;
        usbhc_iface_transfer_in_t bulk_in;

        int (*control_write)(ddf_fun_t *, usb_target_t,
            void *, size_t, void *, size_t,
            usbhc_iface_transfer_out_callback_t, void *);

        int (*control_read)(ddf_fun_t *, usb_target_t,
            void *, size_t, void *, size_t,
            usbhc_iface_transfer_in_callback_t, void *);
} usbhc_iface_t;


#endif

---