source: mainline/uspace/lib/usbhost/include/usb/host/bus.h@ d23fab9

/*
 * Copyright (c) 2017 Ondrej Hlavaty <aearsis@eideo.cz>
 * 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.
 */
/** @addtogroup libusbhost
 * @{
 */
/** @file
 * Virtual base for usb bus implementations.
 *
 * The purpose of this structure is to keep information about connected devices
 * and endpoints, manage available bandwidth and the toggle bit flipping.
 *
 * The generic implementation is provided for USB 1 and 2 in usb2_bus.c. Some
 * details in [OUE]HCI are solved through overriding some functions. XHCI does
 * not need the bookkeeping functionality, because addresses are managed by HC
 * itself.
 */
#ifndef LIBUSBHOST_HOST_BUS_H
#define LIBUSBHOST_HOST_BUS_H

#include <usb/usb.h>
#include <usb/request.h>
#include <usb/host/hcd.h>

#include <assert.h>
#include <fibril_synch.h>
#include <stdbool.h>

typedef struct hcd hcd_t;
typedef struct endpoint endpoint_t;
typedef struct bus bus_t;
typedef struct ddf_fun ddf_fun_t;
typedef struct usb_transfer_batch usb_transfer_batch_t;

typedef struct device {
        /* Device tree keeping */
        link_t link;
        list_t devices;
        fibril_mutex_t guard;

        /* Associated DDF function, if any */
        ddf_fun_t *fun;

        /* Invalid for the roothub device */
        unsigned port;
        struct device *hub;

        /* Transaction translator */
        usb_tt_address_t tt;

        /* The following are not set by the library */
        usb_speed_t speed;
        usb_address_t address;

        /* This structure is meant to be extended by overriding. */
} device_t;

typedef struct {
        int (*enumerate_device)(bus_t *, hcd_t *, device_t *);
        int (*remove_device)(bus_t *, hcd_t *, device_t *);

        int (*online_device)(bus_t *, hcd_t *, device_t *);                     /**< Optional */
        int (*offline_device)(bus_t *, hcd_t *, device_t *);                    /**< Optional */

        /* The following operations are protected by a bus guard. */
        endpoint_t *(*create_endpoint)(bus_t *);
        int (*register_endpoint)(bus_t *, device_t *, endpoint_t *, const usb_endpoint_desc_t *);
        int (*unregister_endpoint)(bus_t *, endpoint_t *);
        endpoint_t *(*find_endpoint)(bus_t *, device_t*, usb_target_t, usb_direction_t);
        void (*destroy_endpoint)(endpoint_t *);                 /**< Optional */
        bool (*endpoint_get_toggle)(endpoint_t *);              /**< Optional */
        void (*endpoint_set_toggle)(endpoint_t *, bool);        /**< Optional */

        int (*request_address)(bus_t *, usb_address_t*, bool, usb_speed_t);
        int (*release_address)(bus_t *, usb_address_t);

        int (*reset_toggle)(bus_t *, usb_target_t, toggle_reset_mode_t);

        size_t (*count_bw) (endpoint_t *, size_t);

        usb_transfer_batch_t *(*create_batch)(bus_t *, endpoint_t *); /**< Optional */
        void (*destroy_batch)(usb_transfer_batch_t *);  /**< Optional */
} bus_ops_t;

/** Endpoint management structure */
typedef struct bus {
        /* Synchronization of ops */
        fibril_mutex_t guard;

        size_t device_size;

        /* Do not call directly, ops are synchronized. */
        bus_ops_t ops;

        /* This structure is meant to be extended by overriding. */
} bus_t;

void bus_init(bus_t *, size_t);
int device_init(device_t *);

int device_set_default_name(device_t *);

int bus_enumerate_device(bus_t *, hcd_t *, device_t *);
int bus_remove_device(bus_t *, hcd_t *, device_t *);

int bus_online_device(bus_t *, hcd_t *, device_t *);
int bus_offline_device(bus_t *, hcd_t *, device_t *);

int bus_add_endpoint(bus_t *, device_t *, const usb_endpoint_desc_t *, endpoint_t **);
endpoint_t *bus_find_endpoint(bus_t *, device_t *, usb_target_t, usb_direction_t);
int bus_remove_endpoint(bus_t *, endpoint_t *);

size_t bus_count_bw(endpoint_t *, size_t);

int bus_request_address(bus_t *, usb_address_t *, bool, usb_speed_t);
int bus_release_address(bus_t *, usb_address_t);


static inline int bus_reserve_default_address(bus_t *bus, usb_speed_t speed) {
        usb_address_t addr = USB_ADDRESS_DEFAULT;

        const int r = bus_request_address(bus, &addr, true, speed);
        assert(addr == USB_ADDRESS_DEFAULT);
        return r;
}

static inline int bus_release_default_address(bus_t *bus) {
        return bus_release_address(bus, USB_ADDRESS_DEFAULT);
}

int bus_reset_toggle(bus_t *, usb_target_t, bool);

#endif
/**
 * @}
 */