driver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 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 LIBUSBDEV_DRIVER_H_
#define LIBUSBDEV_DRIVER_H_

#include <usb/dev/pipes.h>

typedef struct {
        usb_standard_device_descriptor_t device;
        uint8_t *configuration;
        size_t configuration_size;
} usb_device_descriptors_t;

typedef struct {
        usb_standard_interface_descriptor_t *interface;
        uint8_t *nested_descriptors;
        size_t nested_descriptors_size;
} usb_alternate_interface_descriptors_t;

typedef struct {
        usb_alternate_interface_descriptors_t *alternatives;
        size_t alternative_count;
        size_t current;
} usb_alternate_interfaces_t;

typedef struct {
        usb_pipe_t ctrl_pipe;
        usb_endpoint_mapping_t *pipes;
        size_t pipes_count;
        int interface_no;

        usb_alternate_interfaces_t *alternate_interfaces;

        usb_device_descriptors_t descriptors;

        ddf_dev_t *ddf_dev;
        void *driver_data;

        usb_device_connection_t wire;
} usb_device_t;

typedef struct {
        int (*add_device)(usb_device_t *);
} usb_driver_ops_t;

typedef struct {
        const char *name;
        usb_endpoint_description_t **endpoints;
        usb_driver_ops_t *ops;
} usb_driver_t;

int usb_driver_main(usb_driver_t *);

int usb_device_select_interface(usb_device_t *, uint8_t,
    usb_endpoint_description_t **);

int usb_device_retrieve_descriptors(usb_pipe_t *, usb_device_descriptors_t *);
int usb_device_create_pipes(ddf_dev_t *, usb_device_connection_t *,
    usb_endpoint_description_t **, uint8_t *, size_t, int, int,
    usb_endpoint_mapping_t **, size_t *);
int usb_device_destroy_pipes(ddf_dev_t *, usb_endpoint_mapping_t *, size_t);
int usb_device_create(ddf_dev_t *, usb_endpoint_description_t **, usb_device_t **, const char **);
void usb_device_destroy(usb_device_t *);

size_t usb_interface_count_alternates(uint8_t *, size_t, uint8_t);
int usb_alternate_interfaces_create(uint8_t *, size_t, int,
    usb_alternate_interfaces_t **);

#endif

---