source: mainline/uspace/drv/bus/usb/usbdiag/device.c@ 6a1211c

/*
 * Copyright (c) 2017 Petr Manek
 * 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 drvusbdiag
 * @{
 */
/**
 * @file
 * Code for managing debug device structures.
 */
#include <errno.h>
#include <str_error.h>
#include <macros.h>
#include <usb/debug.h>
#include <usbdiag_iface.h>

#include "device.h"

#define NAME "usbdiag"

static const usb_endpoint_description_t bulk_in_ep = {
        .transfer_type = USB_TRANSFER_BULK,
        .direction = USB_DIRECTION_IN,
        .interface_class = 0xDC,
        .interface_subclass = 0x00,
        .interface_protocol = 0x01,
        .flags = 0
};

static const usb_endpoint_description_t bulk_out_ep = {
        .transfer_type = USB_TRANSFER_BULK,
        .direction = USB_DIRECTION_OUT,
        .interface_class = 0xDC,
        .interface_subclass = 0x00,
        .interface_protocol = 0x01,
        .flags = 0
};

static int some_test(ddf_fun_t *fun, int x, int *y)
{
        int rc = EOK;
        usb_diag_dev_t *dev = ddf_fun_to_usb_diag_dev(fun);

        const size_t size = min(dev->bulk_in->desc.max_packet_size, dev->bulk_out->desc.max_packet_size);
        char *buffer = (char *) malloc(size);
        memset(buffer, 42, sizeof(buffer));

        // Write buffer to device.
        if ((rc = usb_pipe_write(dev->bulk_out, buffer, size))) {
                usb_log_error("Bulk OUT write failed. %s\n", str_error(rc));
        }

        // Read device's response.
        size_t remaining = size;
        size_t transferred;
        while (remaining > 0) {
                if ((rc = usb_pipe_read(dev->bulk_in, buffer + size - remaining, remaining, &transferred))) {
                        usb_log_error("Bulk IN read failed. %s\n", str_error(rc));
                        break;
                }

                if (transferred > remaining) {
                        usb_log_error("Bulk IN read more than expected.\n");
                        rc = EINVAL;
                        break;
                }

                remaining -= transferred;
        }

        // TODO: Check output?

        free(buffer);

        *y = x + 42;
        return rc;
}

static usbdiag_iface_t diag_interface = {
        .test = some_test,
};

static ddf_dev_ops_t diag_ops = {
        .interfaces[USBDIAG_DEV_IFACE] = &diag_interface
};

static int device_init(usb_diag_dev_t *dev)
{
        int rc;
        ddf_fun_t *fun = usb_device_ddf_fun_create(dev->usb_dev, fun_exposed, "tmon");
        if (!fun) {
                rc = ENOMEM;
                goto err;
        }

        ddf_fun_set_ops(fun, &diag_ops);
        dev->fun = fun;

        usb_endpoint_mapping_t *epm_out = usb_device_get_mapped_ep_desc(dev->usb_dev, &bulk_out_ep);
        usb_endpoint_mapping_t *epm_in = usb_device_get_mapped_ep_desc(dev->usb_dev, &bulk_in_ep);

        if (!epm_in || !epm_out || !epm_in->present || !epm_out->present) {
                usb_log_error("Required EPs were not mapped.\n");
                rc = ENOENT;
                goto err_fun;
        }

        dev->bulk_out = &epm_out->pipe;
        dev->bulk_in = &epm_in->pipe;

        return EOK;

err_fun:
        ddf_fun_destroy(fun);
err:
        return rc;
}

static void device_fini(usb_diag_dev_t *dev)
{
        ddf_fun_destroy(dev->fun);
}

int usb_diag_dev_create(usb_device_t *dev, usb_diag_dev_t **out_diag_dev)
{
        assert(dev);
        assert(out_diag_dev);

        usb_diag_dev_t *diag_dev = usb_device_data_alloc(dev, sizeof(usb_diag_dev_t));
        if (!diag_dev)
                return ENOMEM;

        diag_dev->usb_dev = dev;

        int err;
        if ((err = device_init(diag_dev)))
                goto err_init;

        *out_diag_dev = diag_dev;
        return EOK;

err_init:
        /* There is no usb_device_data_free. */
        return err;
}

void usb_diag_dev_destroy(usb_diag_dev_t *dev)
{
        assert(dev);

        device_fini(dev);
        /* There is no usb_device_data_free. */
}

/**
 * @}
 */