source: mainline/uspace/lib/usbhost/src/iface.c@ 85a4350

/*
 * Copyright (c) 2011 Jan Vesely
 * 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
 * @brief HCD DDF interface implementation
 */

#include <ddf/driver.h>
#include <errno.h>

#include <usb/debug.h>
#include <usb/host/endpoint.h>
#include <usb/host/hcd.h>

/** Prepare generic usb_transfer_batch and schedule it.
 * @param fun DDF fun
 * @param target address and endpoint number.
 * @param setup_data Data to use in setup stage (Control communication type)
 * @param in Callback for device to host communication.
 * @param out Callback for host to device communication.
 * @param arg Callback parameter.
 * @param name Communication identifier (for nicer output).
 * @return Error code.
 */
static inline int send_batch(
    ddf_fun_t *fun, usb_target_t target, usb_direction_t direction,
    void *data, size_t size, uint64_t setup_data,
    usbhc_iface_transfer_in_callback_t in,
    usbhc_iface_transfer_out_callback_t out, void *arg, const char* name)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);

        endpoint_t *ep = usb_endpoint_manager_find_ep(&hcd->ep_manager,
            target.address, target.endpoint, direction);
        if (ep == NULL) {
                usb_log_error("Endpoint(%d:%d) not registered for %s.\n",
                    target.address, target.endpoint, name);
                return ENOENT;
        }

        usb_log_debug2("%s %d:%d %zu(%zu).\n",
            name, target.address, target.endpoint, size, ep->max_packet_size);

        const size_t bw = bandwidth_count_usb11(
            ep->speed, ep->transfer_type, size, ep->max_packet_size);
        /* Check if we have enough bandwidth reserved */
        if (ep->bandwidth < bw) {
                usb_log_error("Endpoint(%d:%d) %s needs %zu bw "
                    "but only %zu is reserved.\n",
                    ep->address, ep->endpoint, name, bw, ep->bandwidth);
                return ENOSPC;
        }
        if (!hcd->schedule) {
                usb_log_error("HCD does not implement scheduler.\n");
                return ENOTSUP;
        }

        /* No private data and no private data dtor */
        usb_transfer_batch_t *batch =
            usb_transfer_batch_create(ep, data, size, setup_data,
            in, out, arg, fun, NULL, NULL);
        if (!batch) {
                return ENOMEM;
        }

        const int ret = hcd->schedule(hcd, batch);
        if (ret != EOK)
                usb_transfer_batch_destroy(batch);

        return ret;
}

/** Calls ep_add_hook upon endpoint registration.
 * @param ep Endpoint to be registered.
 * @param arg hcd_t in disguise.
 * @return Error code.
 */
static int register_helper(endpoint_t *ep, void *arg)
{
        hcd_t *hcd = arg;
        assert(ep);
        assert(hcd);
        if (hcd->ep_add_hook)
                return hcd->ep_add_hook(hcd, ep);
        return EOK;
}

/** Calls ep_remove_hook upon endpoint removal.
 * @param ep Endpoint to be unregistered.
 * @param arg hcd_t in disguise.
 */
static void unregister_helper(endpoint_t *ep, void *arg)
{
        hcd_t *hcd = arg;
        assert(ep);
        assert(hcd);
        if (hcd->ep_remove_hook)
                hcd->ep_remove_hook(hcd, ep);
}

/** Calls ep_remove_hook upon endpoint removal. Prints warning.
 * @param ep Endpoint to be unregistered.
 * @param arg hcd_t in disguise.
 */
static void unregister_helper_warn(endpoint_t *ep, void *arg)
{
        hcd_t *hcd = arg;
        assert(ep);
        assert(hcd);
        usb_log_warning("Endpoint %d:%d %s was left behind, removing.\n",
            ep->address, ep->endpoint, usb_str_direction(ep->direction));
        if (hcd->ep_remove_hook)
                hcd->ep_remove_hook(hcd, ep);
}

/** Request address interface function.
 *
 * @param[in] fun DDF function that was called.
 * @param[in] address Pointer to preferred USB address.
 * @param[out] address Place to write a new address.
 * @param[in] strict Fail if the preferred address is not available.
 * @param[in] speed Speed to associate with the new default address.
 * @return Error code.
 */
static int request_address(
    ddf_fun_t *fun, usb_address_t *address, bool strict, usb_speed_t speed)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);
        assert(address);

        usb_log_debug("Address request: speed: %s, address: %d, strict: %s.\n",
            usb_str_speed(speed), *address, strict ? "YES" : "NO");
        return usb_device_manager_request_address(
            &hcd->dev_manager, address, strict, speed);
}

/** Bind address interface function.
 *
 * @param[in] fun DDF function that was called.
 * @param[in] address Address of the device
 * @param[in] handle Devman handle of the device driver.
 * @return Error code.
 */
static int bind_address(
    ddf_fun_t *fun, usb_address_t address, devman_handle_t handle)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);

        usb_log_debug("Address bind %d-%" PRIun ".\n", address, handle);
        return usb_device_manager_bind_address(
            &hcd->dev_manager, address, handle);
}

/** Find device handle by address interface function.
 *
 * @param[in] fun DDF function that was called.
 * @param[in] address Address in question.
 * @param[out] handle Where to store device handle if found.
 * @return Error code.
 */
static int find_by_address(ddf_fun_t *fun, usb_address_t address,
    devman_handle_t *handle)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);
        return usb_device_manager_get_info_by_address(
            &hcd->dev_manager, address, handle, NULL);
}

/** Release address interface function.
 *
 * @param[in] fun DDF function that was called.
 * @param[in] address USB address to be released.
 * @return Error code.
 */
static int release_address(ddf_fun_t *fun, usb_address_t address)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);
        usb_log_debug("Address release %d.\n", address);
        usb_device_manager_release_address(&hcd->dev_manager, address);
        usb_endpoint_manager_remove_address(&hcd->ep_manager, address,
            unregister_helper_warn, hcd);
        return EOK;
}

/** Register endpoint interface function.
 * @param fun DDF function.
 * @param address USB address of the device.
 * @param endpoint USB endpoint number to be registered.
 * @param transfer_type Endpoint's transfer type.
 * @param direction USB communication direction the endpoint is capable of.
 * @param max_packet_size Maximu size of packets the endpoint accepts.
 * @param interval Preferred timeout between communication.
 * @return Error code.
 */
static int register_endpoint(
    ddf_fun_t *fun, usb_address_t address, usb_endpoint_t endpoint,
    usb_transfer_type_t transfer_type, usb_direction_t direction,
    size_t max_packet_size, unsigned interval)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);
        const size_t size = max_packet_size;
        usb_speed_t speed = USB_SPEED_MAX;
        const int ret = usb_device_manager_get_info_by_address(
            &hcd->dev_manager, address, NULL, &speed);
        if (ret != EOK) {
                return ret;
        }

        usb_log_debug("Register endpoint %d:%d %s-%s %s %zuB %ums.\n",
            address, endpoint, usb_str_transfer_type(transfer_type),
            usb_str_direction(direction), usb_str_speed(speed),
            max_packet_size, interval);

        return usb_endpoint_manager_add_ep(&hcd->ep_manager, address, endpoint,
            direction, transfer_type, speed, max_packet_size, size,
            register_helper, hcd);
}

/** Unregister endpoint interface function.
 * @param fun DDF function.
 * @param address USB address of the endpoint.
 * @param endpoint USB endpoint number.
 * @param direction Communication direction of the enpdoint to unregister.
 * @return Error code.
 */
static int unregister_endpoint(
    ddf_fun_t *fun, usb_address_t address,
    usb_endpoint_t endpoint, usb_direction_t direction)
{
        assert(fun);
        hcd_t *hcd = fun_to_hcd(fun);
        assert(hcd);
        usb_log_debug("Unregister endpoint %d:%d %s.\n",
            address, endpoint, usb_str_direction(direction));
        return usb_endpoint_manager_remove_ep(&hcd->ep_manager, address,
            endpoint, direction, unregister_helper, hcd);
}

/** Inbound communication interface function.
 * @param fun DDF function.
 * @param target Communication target.
 * @param setup_data Data to use in setup stage (control transfers).
 * @param data Pointer to data buffer.
 * @param size Size of the data buffer.
 * @param callback Function to call on communication end.
 * @param arg Argument passed to the callback function.
 * @return Error code.
 */
static int usb_read(ddf_fun_t *fun, usb_target_t target, uint64_t setup_data,
    uint8_t *data, size_t size, usbhc_iface_transfer_in_callback_t callback,
    void *arg)
{
        return send_batch(fun, target, USB_DIRECTION_IN, data, size,
            setup_data, callback, NULL, arg, "READ");
}

/** Outbound communication interface function.
 * @param fun DDF function.
 * @param target Communication target.
 * @param setup_data Data to use in setup stage (control transfers).
 * @param data Pointer to data buffer.
 * @param size Size of the data buffer.
 * @param callback Function to call on communication end.
 * @param arg Argument passed to the callback function.
 * @return Error code.
 */
static int usb_write(ddf_fun_t *fun, usb_target_t target, uint64_t setup_data,
    const uint8_t *data, size_t size,
    usbhc_iface_transfer_out_callback_t callback, void *arg)
{
        return send_batch(fun, target, USB_DIRECTION_OUT, (uint8_t*)data, size,
            setup_data, NULL, callback, arg, "WRITE");
}

/** usbhc Interface implementation using hcd_t from libusbhost library. */
usbhc_iface_t hcd_iface = {
        .request_address = request_address,
        .bind_address = bind_address,
        .get_handle = find_by_address,
        .release_address = release_address,

        .register_endpoint = register_endpoint,
        .unregister_endpoint = unregister_endpoint,

        .read = usb_read,
        .write = usb_write,
};

/**
 * @}
 */