source: mainline/uspace/lib/drv/generic/remote_usbhc.c@ b4292e7

/*
 * Copyright (c) 2010-2011 Vojtech Horky
 * 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 libdrv
 * @{
 */
/** @file
 */

#include <async.h>
#include <errno.h>
#include <assert.h>

#include "usbhc_iface.h"
#include "ddf/driver.h"

#define USB_MAX_PAYLOAD_SIZE 1020

/** IPC methods for communication with HC through DDF interface.
 *
 * Notes for async methods:
 *
 * Methods for sending data to device (OUT transactions)
 * - e.g. IPC_M_USBHC_INTERRUPT_OUT -
 * always use the same semantics:
 * - first, IPC call with given method is made
 *   - argument #1 is target address
 *   - argument #2 is target endpoint
 *   - argument #3 is max packet size of the endpoint
 * - this call is immediately followed by IPC data write (from caller)
 * - the initial call (and the whole transaction) is answer after the
 *   transaction is scheduled by the HC and acknowledged by the device
 *   or immediately after error is detected
 * - the answer carries only the error code
 *
 * Methods for retrieving data from device (IN transactions)
 * - e.g. IPC_M_USBHC_INTERRUPT_IN -
 * also use the same semantics:
 * - first, IPC call with given method is made
 *   - argument #1 is target address
 *   - argument #2 is target endpoint
 * - this call is immediately followed by IPC data read (async version)
 * - the call is not answered until the device returns some data (or until
 *   error occurs)
 *
 * Some special methods (NO-DATA transactions) do not send any data. These
 * might behave as both OUT or IN transactions because communication parts
 * where actual buffers are exchanged are omitted.
 **
 * For all these methods, wrap functions exists. Important rule: functions
 * for IN transactions have (as parameters) buffers where retrieved data
 * will be stored. These buffers must be already allocated and shall not be
 * touch until the transaction is completed
 * (e.g. not before calling usb_wait_for() with appropriate handle).
 * OUT transactions buffers can be freed immediately after call is dispatched
 * (i.e. after return from wrapping function).
 *
 */
typedef enum {
        /** Asks for address assignment by host controller.
         * Answer:
         * - ELIMIT - host controller run out of address
         * - EOK - address assigned
         * Answer arguments:
         * - assigned address
         *
         * The address must be released by via IPC_M_USBHC_RELEASE_ADDRESS.
         */
        IPC_M_USBHC_REQUEST_ADDRESS,

        /** Bind USB address with devman handle.
         * Parameters:
         * - USB address
         * - devman handle
         * Answer:
         * - EOK - address binded
         * - ENOENT - address is not in use
         */
        IPC_M_USBHC_BIND_ADDRESS,

        /** Get handle binded with given USB address.
         * Parameters
         * - USB address
         * Answer:
         * - EOK - address binded, first parameter is the devman handle
         * - ENOENT - address is not in use at the moment
         */
        IPC_M_USBHC_GET_HANDLE_BY_ADDRESS,

        /** Release address in use.
         * Arguments:
         * - address to be released
         * Answer:
         * - ENOENT - address not in use
         * - EPERM - trying to release default USB address
         */
        IPC_M_USBHC_RELEASE_ADDRESS,

        /** Register endpoint attributes at host controller.
         * This is used to reserve portion of USB bandwidth.
         * When speed is invalid, speed of the device is used.
         * Parameters:
         * - USB address + endpoint number
         *   - packed as ADDR << 16 + EP
         * - speed + transfer type + direction
         *   - packed as ( SPEED << 8 + TYPE ) << 8 + DIR
         * - maximum packet size + interval (in milliseconds)
         *   - packed as MPS << 16 + INT
         * Answer:
         * - EOK - reservation successful
         * - ELIMIT - not enough bandwidth to satisfy the request
         */
        IPC_M_USBHC_REGISTER_ENDPOINT,

        /** Revert endpoint registration.
         * Parameters:
         * - USB address
         * - endpoint number
         * - data direction
         * Answer:
         * - EOK - endpoint unregistered
         * - ENOENT - unknown endpoint
         */
        IPC_M_USBHC_UNREGISTER_ENDPOINT,

        /** Get data from device.
         * See explanation at usb_iface_funcs_t (IN transaction).
         */
        IPC_M_USBHC_READ,

        /** Send data to device.
         * See explanation at usb_iface_funcs_t (OUT transaction).
         */
        IPC_M_USBHC_WRITE,
} usbhc_iface_funcs_t;

int usbhc_request_address(async_exch_t *exch, usb_address_t *address,
    bool strict, usb_speed_t speed)
{
        if (!exch || !address)
                return EINVAL;
        sysarg_t new_address;
        const int ret = async_req_4_1(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_REQUEST_ADDRESS, *address, strict, speed, &new_address);
        if (ret == EOK)
                *address = (usb_address_t)new_address;
        return ret;
}
/*----------------------------------------------------------------------------*/
int usbhc_bind_address(async_exch_t *exch, usb_address_t address,
    devman_handle_t handle)
{
        if (!exch)
                return EINVAL;
        return async_req_3_0(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_BIND_ADDRESS, address, handle);
}
/*----------------------------------------------------------------------------*/
int usbhc_get_handle(async_exch_t *exch, usb_address_t address,
    devman_handle_t *handle)
{
        if (!exch)
                return EINVAL;
        sysarg_t h;
        const int ret = async_req_2_1(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_GET_HANDLE_BY_ADDRESS, address, &h);
        if (ret == EOK && handle)
                *handle = (devman_handle_t)h;
        return ret;
}
/*----------------------------------------------------------------------------*/
int usbhc_release_address(async_exch_t *exch, usb_address_t address)
{
        if (!exch)
                return EINVAL;
        return async_req_2_0(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_RELEASE_ADDRESS, address);
}
/*----------------------------------------------------------------------------*/
int usbhc_register_endpoint(async_exch_t *exch, usb_address_t address,
    usb_endpoint_t endpoint, usb_transfer_type_t type,
    usb_direction_t direction, size_t mps, unsigned interval)
{
        if (!exch)
                return EINVAL;
        const usb_target_t target =
            {{ .address = address, .endpoint = endpoint }};
#define _PACK2(high, low) (((high & 0xffff) << 16) | (low & 0xffff))

        return async_req_4_0(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_REGISTER_ENDPOINT, target.packed,
            _PACK2(type, direction), _PACK2(mps, interval));

#undef _PACK2
}
/*----------------------------------------------------------------------------*/
int usbhc_unregister_endpoint(async_exch_t *exch, usb_address_t address,
    usb_endpoint_t endpoint, usb_direction_t direction)
{
        if (!exch)
                return EINVAL;
        return async_req_4_0(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_UNREGISTER_ENDPOINT, address, endpoint, direction);
}
/*----------------------------------------------------------------------------*/
int usbhc_read(async_exch_t *exch, usb_address_t address,
    usb_endpoint_t endpoint, uint64_t setup, void *data, size_t size,
    size_t *rec_size)
{
        if (size == 0 && setup == 0)
                return EOK;

        if (!exch)
                return EINVAL;
        const usb_target_t target =
            {{ .address = address, .endpoint = endpoint }};

        /* Make call identifying target USB device and type of transfer. */
        aid_t opening_request = async_send_4(exch,
            DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_READ, target.packed,
            (setup & UINT32_MAX), (setup >> 32), NULL);

        if (opening_request == 0) {
                return ENOMEM;
        }

        /* Retrieve the data. */
        ipc_call_t data_request_call;
        aid_t data_request =
            async_data_read(exch, data, size, &data_request_call);

        if (data_request == 0) {
                // FIXME: How to let the other side know that we want to abort?
                async_wait_for(opening_request, NULL);
                return ENOMEM;
        }

        /* Wait for the answer. */
        sysarg_t data_request_rc;
        sysarg_t opening_request_rc;
        async_wait_for(data_request, &data_request_rc);
        async_wait_for(opening_request, &opening_request_rc);

        if (data_request_rc != EOK) {
                /* Prefer the return code of the opening request. */
                if (opening_request_rc != EOK) {
                        return (int) opening_request_rc;
                } else {
                        return (int) data_request_rc;
                }
        }
        if (opening_request_rc != EOK) {
                return (int) opening_request_rc;
        }

        *rec_size = IPC_GET_ARG2(data_request_call);
        return EOK;
}
/*----------------------------------------------------------------------------*/
int usbhc_write(async_exch_t *exch, usb_address_t address,
    usb_endpoint_t endpoint, uint64_t setup, const void *data, size_t size)
{
        if (size == 0 && setup == 0)
                return EOK;

        if (!exch)
                return EINVAL;
        const usb_target_t target =
            {{ .address = address, .endpoint = endpoint }};

        aid_t opening_request = async_send_5(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
            IPC_M_USBHC_WRITE, target.packed, size,
            (setup & UINT32_MAX), (setup >> 32), NULL);

        if (opening_request == 0) {
                return ENOMEM;
        }

        /* Send the data if any. */
        if (size > 0) {
                const int ret = async_data_write_start(exch, data, size);
                if (ret != EOK) {
                        async_wait_for(opening_request, NULL);
                        return ret;
                }
        }

        /* Wait for the answer. */
        sysarg_t opening_request_rc;
        async_wait_for(opening_request, &opening_request_rc);

        return (int) opening_request_rc;
}
/*----------------------------------------------------------------------------*/

static void remote_usbhc_request_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_bind_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_get_handle(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_release_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_register_endpoint(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_unregister_endpoint(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_read(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
static void remote_usbhc_write(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);
//static void remote_usbhc(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *);

/** Remote USB host controller interface operations. */
static remote_iface_func_ptr_t remote_usbhc_iface_ops[] = {
        [IPC_M_USBHC_REQUEST_ADDRESS] = remote_usbhc_request_address,
        [IPC_M_USBHC_RELEASE_ADDRESS] = remote_usbhc_release_address,
        [IPC_M_USBHC_BIND_ADDRESS] = remote_usbhc_bind_address,
        [IPC_M_USBHC_GET_HANDLE_BY_ADDRESS] = remote_usbhc_get_handle,

        [IPC_M_USBHC_REGISTER_ENDPOINT] = remote_usbhc_register_endpoint,
        [IPC_M_USBHC_UNREGISTER_ENDPOINT] = remote_usbhc_unregister_endpoint,

        [IPC_M_USBHC_READ] = remote_usbhc_read,
        [IPC_M_USBHC_WRITE] = remote_usbhc_write,
};

/** Remote USB host controller interface structure.
 */
remote_iface_t remote_usbhc_iface = {
        .method_count = sizeof(remote_usbhc_iface_ops) /
            sizeof(remote_usbhc_iface_ops[0]),
        .methods = remote_usbhc_iface_ops
};

typedef struct {
        ipc_callid_t caller;
        ipc_callid_t data_caller;
        void *buffer;
} async_transaction_t;

static void async_transaction_destroy(async_transaction_t *trans)
{
        if (trans == NULL) {
                return;
        }
        if (trans->buffer != NULL) {
                free(trans->buffer);
        }

        free(trans);
}

static async_transaction_t *async_transaction_create(ipc_callid_t caller)
{
        async_transaction_t *trans = malloc(sizeof(async_transaction_t));
        if (trans == NULL) {
                return NULL;
        }

        trans->caller = caller;
        trans->data_caller = 0;
        trans->buffer = NULL;

        return trans;
}
/*----------------------------------------------------------------------------*/
void remote_usbhc_request_address(ddf_fun_t *fun, void *iface,
    ipc_callid_t callid, ipc_call_t *call)
{
        const usbhc_iface_t *usb_iface = iface;

        if (!usb_iface->request_address) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        usb_address_t address = DEV_IPC_GET_ARG1(*call);
        const bool strict = DEV_IPC_GET_ARG2(*call);
        const usb_speed_t speed = DEV_IPC_GET_ARG3(*call);

        const int rc = usb_iface->request_address(fun, &address, strict, speed);
        if (rc != EOK) {
                async_answer_0(callid, rc);
        } else {
                async_answer_1(callid, EOK, (sysarg_t) address);
        }
}
/*----------------------------------------------------------------------------*/
void remote_usbhc_bind_address(ddf_fun_t *fun, void *iface,
    ipc_callid_t callid, ipc_call_t *call)
{
        const usbhc_iface_t *usb_iface = iface;

        if (!usb_iface->bind_address) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        const usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call);
        const devman_handle_t handle = (devman_handle_t) DEV_IPC_GET_ARG2(*call);

        const int ret = usb_iface->bind_address(fun, address, handle);
        async_answer_0(callid, ret);
}
/*----------------------------------------------------------------------------*/
void remote_usbhc_get_handle(ddf_fun_t *fun, void *iface,
    ipc_callid_t callid, ipc_call_t *call)
{
        const usbhc_iface_t *usb_iface = iface;

        if (!usb_iface->get_handle) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        const usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call);
        devman_handle_t handle;
        const int ret = usb_iface->get_handle(fun, address, &handle);

        if (ret == EOK) {
                async_answer_1(callid, ret, handle);
        } else {
                async_answer_0(callid, ret);
        }
}
/*----------------------------------------------------------------------------*/
void remote_usbhc_release_address(ddf_fun_t *fun, void *iface,
    ipc_callid_t callid, ipc_call_t *call)
{
        const usbhc_iface_t *usb_iface = iface;

        if (!usb_iface->release_address) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        const usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call);

        const int ret = usb_iface->release_address(fun, address);
        async_answer_0(callid, ret);
}
/*----------------------------------------------------------------------------*/
static void callback_out(ddf_fun_t *fun,
    int outcome, void *arg)
{
        async_transaction_t *trans = arg;

        async_answer_0(trans->caller, outcome);

        async_transaction_destroy(trans);
}
/*----------------------------------------------------------------------------*/
static void callback_in(ddf_fun_t *fun,
    int outcome, size_t actual_size, void *arg)
{
        async_transaction_t *trans = (async_transaction_t *)arg;

        if (outcome != EOK) {
                async_answer_0(trans->caller, outcome);
                if (trans->data_caller) {
                        async_answer_0(trans->data_caller, EINTR);
                }
                async_transaction_destroy(trans);
                return;
        }

        if (trans->data_caller) {
                async_data_read_finalize(trans->data_caller,
                    trans->buffer, actual_size);
        }

        async_answer_0(trans->caller, EOK);

        async_transaction_destroy(trans);
}
/*----------------------------------------------------------------------------*/
void remote_usbhc_register_endpoint(ddf_fun_t *fun, void *iface,
    ipc_callid_t callid, ipc_call_t *call)
{
        usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface;

        if (!usb_iface->register_endpoint) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

#define _INIT_FROM_HIGH_DATA2(type, var, arg_no) \
        type var = (type) (DEV_IPC_GET_ARG##arg_no(*call) >> 16)
#define _INIT_FROM_LOW_DATA2(type, var, arg_no) \
        type var = (type) (DEV_IPC_GET_ARG##arg_no(*call) & 0xffff)

        const usb_target_t target = { .packed = DEV_IPC_GET_ARG1(*call) };

        _INIT_FROM_HIGH_DATA2(usb_transfer_type_t, transfer_type, 2);
        _INIT_FROM_LOW_DATA2(usb_direction_t, direction, 2);

        _INIT_FROM_HIGH_DATA2(size_t, max_packet_size, 3);
        _INIT_FROM_LOW_DATA2(unsigned int, interval, 3);

#undef _INIT_FROM_HIGH_DATA2
#undef _INIT_FROM_LOW_DATA2

        int rc = usb_iface->register_endpoint(fun, target.address,
            target.endpoint, transfer_type, direction, max_packet_size, interval);

        async_answer_0(callid, rc);
}

void remote_usbhc_unregister_endpoint(ddf_fun_t *fun, void *iface,
    ipc_callid_t callid, ipc_call_t *call)
{
        usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface;

        if (!usb_iface->unregister_endpoint) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call);
        usb_endpoint_t endpoint = (usb_endpoint_t) DEV_IPC_GET_ARG2(*call);
        usb_direction_t direction = (usb_direction_t) DEV_IPC_GET_ARG3(*call);

        int rc = usb_iface->unregister_endpoint(fun,
            address, endpoint, direction);

        async_answer_0(callid, rc);
}

void remote_usbhc_read(
    ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call)
{
        assert(fun);
        assert(iface);
        assert(call);

        const usbhc_iface_t *hc_iface = iface;

        if (!hc_iface->read) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        const usb_target_t target = { .packed = DEV_IPC_GET_ARG1(*call) };
        const uint64_t setup =
            ((uint64_t)DEV_IPC_GET_ARG2(*call)) |
            (((uint64_t)DEV_IPC_GET_ARG3(*call)) << 32);

        async_transaction_t *trans = async_transaction_create(callid);
        if (trans == NULL) {
                async_answer_0(callid, ENOMEM);
                return;
        }

        size_t size = 0;
        if (!async_data_read_receive(&trans->data_caller, &size)) {
                async_answer_0(callid, EPARTY);
                return;
        }

        trans->buffer = malloc(size);
        if (trans->buffer == NULL) {
                async_answer_0(trans->data_caller, ENOMEM);
                async_answer_0(callid, ENOMEM);
                async_transaction_destroy(trans);
        }

        const int rc = hc_iface->read(
            fun, target, setup, trans->buffer, size, callback_in, trans);

        if (rc != EOK) {
                async_answer_0(trans->data_caller, rc);
                async_answer_0(callid, rc);
                async_transaction_destroy(trans);
        }
}
/*----------------------------------------------------------------------------*/
void remote_usbhc_write(
    ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call)
{
        assert(fun);
        assert(iface);
        assert(call);

        const usbhc_iface_t *hc_iface = iface;

        if (!hc_iface->write) {
                async_answer_0(callid, ENOTSUP);
                return;
        }

        const usb_target_t target = { .packed = DEV_IPC_GET_ARG1(*call) };
        const size_t data_buffer_len = DEV_IPC_GET_ARG2(*call);
        const uint64_t setup =
            ((uint64_t)DEV_IPC_GET_ARG3(*call)) |
            (((uint64_t)DEV_IPC_GET_ARG4(*call)) << 32);

        async_transaction_t *trans = async_transaction_create(callid);
        if (trans == NULL) {
                async_answer_0(callid, ENOMEM);
                return;
        }

        size_t size = 0;
        if (data_buffer_len > 0) {
                const int rc = async_data_write_accept(&trans->buffer, false,
                    1, USB_MAX_PAYLOAD_SIZE,
                    0, &size);

                if (rc != EOK) {
                        async_answer_0(callid, rc);
                        async_transaction_destroy(trans);
                        return;
                }
        }

        const int rc = hc_iface->write(
            fun, target, setup, trans->buffer, size, callback_out, trans);

        if (rc != EOK) {
                async_answer_0(callid, rc);
                async_transaction_destroy(trans);
        }
}
/**
 * @}
 */