pipes.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_PIPES_H_
#define LIBUSBDEV_PIPES_H_

#include <sys/types.h>
#include <usb/usb.h>
#include <usb/hc.h>
#include <usb/descriptor.h>
#include <ipc/devman.h>
#include <ddf/driver.h>
#include <fibril_synch.h>

typedef struct {
        devman_handle_t hc_handle;
        usb_address_t address;
} usb_device_connection_t;

typedef struct {
        fibril_mutex_t guard;

        usb_device_connection_t *wire;

        usb_endpoint_t endpoint_no;

        usb_transfer_type_t transfer_type;

        usb_direction_t direction;

        size_t max_packet_size;

        int hc_phone;

        fibril_mutex_t hc_phone_mutex;

        int refcount;
        int refcount_soft;

        bool auto_reset_halt;
} usb_pipe_t;


typedef struct {
        usb_transfer_type_t transfer_type;
        usb_direction_t direction;
        int interface_class;
        int interface_subclass;
        int interface_protocol;
        unsigned int flags;
} usb_endpoint_description_t;

typedef struct {
        usb_pipe_t *pipe;
        const usb_endpoint_description_t *description;
        int interface_no;
        int interface_setting;
        usb_standard_endpoint_descriptor_t *descriptor;
        usb_standard_interface_descriptor_t *interface;
        bool present;
} usb_endpoint_mapping_t;

int usb_device_connection_initialize_on_default_address(
    usb_device_connection_t *, usb_hc_connection_t *);
int usb_device_connection_initialize_from_device(usb_device_connection_t *,
    ddf_dev_t *);
int usb_device_connection_initialize(usb_device_connection_t *,
    devman_handle_t, usb_address_t);

int usb_device_get_assigned_interface(ddf_dev_t *);

int usb_pipe_initialize(usb_pipe_t *, usb_device_connection_t *,
    usb_endpoint_t, usb_transfer_type_t, size_t, usb_direction_t);
int usb_pipe_initialize_default_control(usb_pipe_t *,
    usb_device_connection_t *);
int usb_pipe_probe_default_control(usb_pipe_t *);
int usb_pipe_initialize_from_configuration(usb_endpoint_mapping_t *,
    size_t, uint8_t *, size_t, usb_device_connection_t *);
int usb_pipe_register_with_speed(usb_pipe_t *, usb_speed_t,
    unsigned int, usb_hc_connection_t *);
int usb_pipe_register(usb_pipe_t *, unsigned int, usb_hc_connection_t *);
int usb_pipe_unregister(usb_pipe_t *, usb_hc_connection_t *);

void usb_pipe_start_long_transfer(usb_pipe_t *);
void usb_pipe_end_long_transfer(usb_pipe_t *);

int usb_pipe_read(usb_pipe_t *, void *, size_t, size_t *);
int usb_pipe_write(usb_pipe_t *, void *, size_t);

int usb_pipe_control_read(usb_pipe_t *, void *, size_t,
    void *, size_t, size_t *);
int usb_pipe_control_write(usb_pipe_t *, void *, size_t,
    void *, size_t);

#endif

---