source: mainline/uspace/drv/usbhub/utils.c@ 8dd039a

/*
 * Copyright (c) 2010 Matus Dekanek
 * 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 libusb usb
 * @{
 */
/** @file
 * @brief various utilities
 */
#include <driver.h>
#include <bool.h>
#include <errno.h>

#include <usbhc_iface.h>
#include <usb/usbdrv.h>
#include <usb/descriptor.h>
#include <usb/devreq.h>
#include <usb/classes/hub.h>

#include "usbhub.h"
#include "usbhub_private.h"
#include "port_status.h"


size_t USB_HUB_MAX_DESCRIPTOR_SIZE = 71;

//*********************************************
//
//  various utils
//
//*********************************************

//hub descriptor utils

void * usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor) {
        //base size
        size_t size = 7;
        //variable size according to port count
        size_t var_size = descriptor->ports_count / 8 + ((descriptor->ports_count % 8 > 0) ? 1 : 0);
        size += 2 * var_size;
        uint8_t * result = (uint8_t*) malloc(size);
        //size
        result[0] = size;
        //descriptor type
        result[1] = USB_DESCTYPE_HUB;
        result[2] = descriptor->ports_count;
        /// @fixme handling of endianness??
        result[3] = descriptor->hub_characteristics / 256;
        result[4] = descriptor->hub_characteristics % 256;
        result[5] = descriptor->pwr_on_2_good_time;
        result[6] = descriptor->current_requirement;

        size_t i;
        for (i = 0; i < var_size; ++i) {
                result[7 + i] = descriptor->devices_removable[i];
        }
        for (i = 0; i < var_size; ++i) {
                result[7 + var_size + i] = 255;
        }
        return result;
}

usb_hub_descriptor_t * usb_deserialize_hub_desriptor(void * serialized_descriptor) {
        uint8_t * sdescriptor = (uint8_t*) serialized_descriptor;

        if (sdescriptor[1] != USB_DESCTYPE_HUB) {
                dprintf(1,"[usb_hub] wrong descriptor %x\n",sdescriptor[1]);
                return NULL;
        }

        usb_hub_descriptor_t * result = usb_new(usb_hub_descriptor_t);
        

        result->ports_count = sdescriptor[2];
        /// @fixme handling of endianness??
        result->hub_characteristics = sdescriptor[4] + 256 * sdescriptor[3];
        result->pwr_on_2_good_time = sdescriptor[5];
        result->current_requirement = sdescriptor[6];
        size_t var_size = result->ports_count / 8 + ((result->ports_count % 8 > 0)
                        ? 1 : 0);
        result->devices_removable = (uint8_t*) malloc(var_size);
        //printf("[usb_hub] getting removable devices data \n");
        size_t i;
        for (i = 0; i < var_size; ++i) {
                result->devices_removable[i] = sdescriptor[7 + i];
        }
        return result;
}

//control transactions

int usb_drv_sync_control_read(
                int phone, usb_target_t target,
                usb_device_request_setup_packet_t * request,
                void * rcvd_buffer, size_t rcvd_size, size_t * actual_size
                ) {
        usb_handle_t handle;
        int opResult;
        //setup
        opResult = usb_drv_async_control_read_setup(phone, target,
                        request, sizeof (usb_device_request_setup_packet_t),
                        &handle);
        if (opResult != EOK) {
                return opResult;
        }
        opResult = usb_drv_async_wait_for(handle);
        if (opResult != EOK) {
                return opResult;
        }
        //read
        opResult = usb_drv_async_control_read_data(phone, target,
                        rcvd_buffer, rcvd_size, actual_size,
                        &handle);
        if (opResult != EOK) {
                return opResult;
        }
        opResult = usb_drv_async_wait_for(handle);
        if (opResult != EOK) {
                return opResult;
        }
        //finalize
        opResult = usb_drv_async_control_read_status(phone, target,
                        &handle);
        if (opResult != EOK) {
                return opResult;
        }
        opResult = usb_drv_async_wait_for(handle);
        if (opResult != EOK) {
                return opResult;
        }
        return EOK;
}

int usb_drv_sync_control_write(
                int phone, usb_target_t target,
                usb_device_request_setup_packet_t * request,
                void * sent_buffer, size_t sent_size
                ) {
        usb_handle_t handle;
        int opResult;
        //setup
        opResult = usb_drv_async_control_write_setup(phone, target,
                        request, sizeof (usb_device_request_setup_packet_t),
                        &handle);
        if (opResult != EOK) {
                return opResult;
        }
        opResult = usb_drv_async_wait_for(handle);
        if (opResult != EOK) {
                return opResult;
        }
        //write
        opResult = usb_drv_async_control_write_data(phone, target,
                        sent_buffer, sent_size,
                        &handle);
        if (opResult != EOK) {
                return opResult;
        }
        opResult = usb_drv_async_wait_for(handle);
        if (opResult != EOK) {
                return opResult;
        }
        //finalize
        opResult = usb_drv_async_control_write_status(phone, target,
                        &handle);
        if (opResult != EOK) {
                return opResult;
        }
        opResult = usb_drv_async_wait_for(handle);
        if (opResult != EOK) {
                return opResult;
        }
        return EOK;
}


/*
 * method for testing port status bitmap
 
static void usb_hub_test_port_status(void) {
        printf("[usb_hub] -------------port status test---------\n");
        usb_port_status_t status = 0;

        //printf("original status %d (should be 0)\n",(uint32_t)status);
        usb_port_set_bit(&status, 1, 1);
        //printf("%d =?= 2\n",(uint32_t)status);
        if (status != 2) {
                printf("[usb_port_status] test failed: wrong set of bit 1\n");
                return;
        }
        usb_port_set_bit(&status, 3, 1);
        if (status != 10) {
                printf("[usb_port_status] test failed: wrong set of bit 3\n");
                return;
        }

        usb_port_set_bit(&status, 15, 1);
        if (status != 10 + (1 << 15)) {
                printf("[usb_port_status] test failed: wrong set of bit 15\n");
                return;
        }
        usb_port_set_bit(&status, 1, 0);
        if (status != 8 + (1 << 15)) {
                printf("[usb_port_status] test failed: wrong unset of bit 1\n");
                return;
        }
        int i;
        for (i = 0; i < 32; ++i) {
                if (i == 3 || i == 15) {
                        if (!usb_port_get_bit(&status, i)) {
                                printf("[usb_port_status] test failed: wrong bit at %d\n", i);
                        }
                } else {
                        if (usb_port_get_bit(&status, i)) {
                                printf("[usb_port_status] test failed: wrong bit at %d\n", i);
                        }
                }
        }

        printf("test ok\n");


        //printf("%d =?= 10\n",(uint32_t)status);

        //printf("this should be 0: %d \n",usb_port_get_bit(&status,0));
        //printf("this should be 1: %d \n",usb_port_get_bit(&status,1));
        //printf("this should be 0: %d \n",usb_port_get_bit(&status,2));
        //printf("this should be 1: %d \n",usb_port_get_bit(&status,3));
        //printf("this should be 0: %d \n",usb_port_get_bit(&status,4));

}
*/


/**
 * @}
 */