source: mainline/uspace/drv/usbhub/usbhub.c@ e93e319

/*
 * 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 drvusbhub
 * @{
 */
/** @file
 * @brief usb hub main functionality
 */

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

#include <usb_iface.h>
#include <usb/ddfiface.h>
#include <usb/descriptor.h>
#include <usb/recognise.h>
#include <usb/request.h>
#include <usb/classes/hub.h>
#include <stdio.h>

#include "usbhub.h"
#include "usbhub_private.h"
#include "port_status.h"
#include "usb/usb.h"
#include "usb/pipes.h"
#include "usb/classes/classes.h"

static ddf_dev_ops_t hub_device_ops = {
        .interfaces[USB_DEV_IFACE] = &usb_iface_hub_impl
};

/** Hub status-change endpoint description
 *
 * For more see usb hub specification in 11.15.1 of
 */
static usb_endpoint_description_t status_change_endpoint_description = {
        .transfer_type = USB_TRANSFER_INTERRUPT,
        .direction = USB_DIRECTION_IN,
        .interface_class = USB_CLASS_HUB,
        .interface_subclass = 0,
        .interface_protocol = 0,
        .flags = 0
};

int usb_hub_control_loop(void * hub_info_param){
        usb_hub_info_t * hub_info = (usb_hub_info_t*)hub_info_param;
        int errorCode = EOK;

        while(errorCode == EOK){
                errorCode = usb_hub_check_hub_changes(hub_info);
                async_usleep(1000 * 1000 );/// \TODO proper number once
        }
        usb_log_error("something in ctrl loop went wrong, errno %d",errorCode);

        return 0;
}


//*********************************************
//
//  hub driver code, initialization
//
//*********************************************

/**
 * Initialize connnections to host controller, device, and device
 * control endpoint
 * @param hub
 * @param device
 * @return
 */
static int usb_hub_init_communication(usb_hub_info_t * hub){
        usb_log_debug("Initializing hub USB communication (hub->device->handle=%zu).\n", hub->device->handle);
        int opResult;
        opResult = usb_device_connection_initialize_from_device(
                        &hub->device_connection,
                        hub->device);
        if(opResult != EOK){
                usb_log_error("could not initialize connection to hc, errno %d",opResult);
                return opResult;
        }
        usb_log_debug("Initializing USB wire abstraction.\n");
        opResult = usb_hc_connection_initialize_from_device(&hub->connection,
                        hub->device);
        if(opResult != EOK){
                usb_log_error("could not initialize connection to device, errno %d",
                                opResult);
                return opResult;
        }
        usb_log_debug("Initializing default control pipe.\n");
        opResult = usb_endpoint_pipe_initialize_default_control(&hub->endpoints.control,
            &hub->device_connection);
        if(opResult != EOK){
                usb_log_error("could not initialize connection to device endpoint, errno %d",
                                opResult);
                return opResult;
        }

        opResult = usb_endpoint_pipe_probe_default_control(&hub->endpoints.control);
        if (opResult != EOK) {
                usb_log_error("failed probing endpoint 0, %d", opResult);
                return opResult;
        }

        return EOK;
}

/**
 * When entering this function, hub->endpoints.control should be active.
 * @param hub
 * @return
 */
static int usb_hub_process_configuration_descriptors(
        usb_hub_info_t * hub){
        if(hub==NULL) {
                return EINVAL;
        }
        int opResult;
        
        //device descriptor
        usb_standard_device_descriptor_t std_descriptor;
        opResult = usb_request_get_device_descriptor(&hub->endpoints.control,
            &std_descriptor);
        if(opResult!=EOK){
                usb_log_error("could not get device descriptor, %d",opResult);
                return opResult;
        }
        usb_log_info("hub has %d configurations",
                        std_descriptor.configuration_count);
        if(std_descriptor.configuration_count<1){
                usb_log_error("THERE ARE NO CONFIGURATIONS AVAILABLE");
                //shouldn`t I return?
        }

        /* Retrieve full configuration descriptor. */
        uint8_t *descriptors = NULL;
        size_t descriptors_size = 0;
        opResult = usb_request_get_full_configuration_descriptor_alloc(
            &hub->endpoints.control, 0,
            (void **) &descriptors, &descriptors_size);
        if (opResult != EOK) {
                usb_log_error("Could not get configuration descriptor: %s.\n",
                    str_error(opResult));
                return opResult;
        }
        usb_standard_configuration_descriptor_t *config_descriptor
            = (usb_standard_configuration_descriptor_t *) descriptors;

        /* Set configuration. */
        opResult = usb_request_set_configuration(&hub->endpoints.control,
            config_descriptor->configuration_number);

        if (opResult != EOK) {
                usb_log_error("Failed to set hub configuration: %s.\n",
                    str_error(opResult));
                return opResult;
        }
        usb_log_debug("\tused configuration %d",
                        config_descriptor->configuration_number);

        usb_endpoint_mapping_t endpoint_mapping[1] = {
                {
                        .pipe = &hub->endpoints.status_change,
                        .description = &status_change_endpoint_description,
                        .interface_no =
                            usb_device_get_assigned_interface(hub->device)
                }
        };
        opResult = usb_endpoint_pipe_initialize_from_configuration(
            endpoint_mapping, 1,
            descriptors, descriptors_size,
            &hub->device_connection);
        if (opResult != EOK) {
                usb_log_error("Failed to initialize status change pipe: %s",
                    str_error(opResult));
                return opResult;
        }
        if (!endpoint_mapping[0].present) {
                usb_log_error("Not accepting device, " \
                    "cannot understand what is happenning");
                return EREFUSED;
        }

        free(descriptors);
        return EOK;
        
}


/**
 * Create hub representation from device information.
 * @param device
 * @return pointer to created structure or NULL in case of error
 */
usb_hub_info_t * usb_create_hub_info(ddf_dev_t * device) {
        usb_hub_info_t* result = usb_new(usb_hub_info_t);
        result->device = device;
        int opResult;
        opResult = usb_hub_init_communication(result);
        if(opResult != EOK){
                free(result);
                return NULL;
        }

        //result->device = device;
        result->port_count = -1;
        result->device = device;
        result->is_default_address_used = false;

        //result->usb_device = usb_new(usb_hcd_attached_device_info_t);
        size_t received_size;

        // get hub descriptor
        usb_log_debug("creating serialized descripton");
        void * serialized_descriptor = malloc(USB_HUB_MAX_DESCRIPTOR_SIZE);
        usb_hub_descriptor_t * descriptor;
        usb_log_debug("starting control transaction");
        usb_endpoint_pipe_start_session(&result->endpoints.control);
        opResult = usb_request_set_configuration(&result->endpoints.control, 1);
        assert(opResult == EOK);

        opResult = usb_request_get_descriptor(&result->endpoints.control,
                        USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_DEVICE,
                        USB_DESCTYPE_HUB,
                        0, 0, serialized_descriptor,
                        USB_HUB_MAX_DESCRIPTOR_SIZE, &received_size);
        usb_endpoint_pipe_end_session(&result->endpoints.control);

        if (opResult != EOK) {
                usb_log_error("failed when receiving hub descriptor, badcode = %d",
                                opResult);
                free(serialized_descriptor);
                free(result);
                return NULL;
        }
        usb_log_debug2("deserializing descriptor");
        descriptor = usb_deserialize_hub_desriptor(serialized_descriptor);
        if(descriptor==NULL){
                usb_log_warning("could not deserialize descriptor ");
                free(result);
                return NULL;
        }

        usb_log_info("setting port count to %d",descriptor->ports_count);
        result->port_count = descriptor->ports_count;
        result->attached_devs = (usb_hc_attached_device_t*)
            malloc((result->port_count+1) * sizeof(usb_hc_attached_device_t));
        int i;
        for(i=0;i<result->port_count+1;++i){
                result->attached_devs[i].handle=0;
                result->attached_devs[i].address=0;
        }
        usb_log_debug2("freeing data");
        free(serialized_descriptor);
        free(descriptor->devices_removable);
        free(descriptor);

        //finish

        usb_log_info("hub info created");

        return result;
}

/**
 * Create hub representation and add it into hub list
 * @param dev
 * @return
 */
int usb_add_hub_device(ddf_dev_t *dev) {
        usb_log_info("add_hub_device(handle=%d)", (int) dev->handle);

        //dev->ops = &hub_device_ops;
        (void) hub_device_ops;

        usb_hub_info_t * hub_info = usb_create_hub_info(dev);
        if(!hub_info){
                return EINTR;
        }

        int opResult;

        //perform final configurations
        usb_endpoint_pipe_start_session(&hub_info->endpoints.control);
        // process descriptors
        opResult = usb_hub_process_configuration_descriptors(hub_info);
        if(opResult != EOK){
                usb_log_error("could not get configuration descriptors, %d",
                                opResult);
                return opResult;
        }
        //power ports
        usb_device_request_setup_packet_t request;
        int port;
        for (port = 1; port < hub_info->port_count+1; ++port) {
                usb_hub_set_power_port_request(&request, port);
                opResult = usb_endpoint_pipe_control_write(&hub_info->endpoints.control,
                                &request,sizeof(usb_device_request_setup_packet_t), NULL, 0);
                usb_log_info("powering port %d",port);
                if (opResult != EOK) {
                        usb_log_warning("something went wrong when setting hub`s %dth port", port);
                }
        }
        //ports powered, hub seems to be enabled
        usb_endpoint_pipe_end_session(&hub_info->endpoints.control);

        //add the hub to list
        //is this needed now?
        fibril_mutex_lock(&usb_hub_list_lock);
        usb_lst_append(&usb_hub_list, hub_info);
        fibril_mutex_unlock(&usb_hub_list_lock);
        usb_log_debug("hub info added to list");

        usb_log_debug("adding to ddf");
        ddf_fun_t *hub_fun = ddf_fun_create(dev, fun_exposed, "hub");
        assert(hub_fun != NULL);
        hub_fun->ops = NULL;

        int rc = ddf_fun_bind(hub_fun);
        assert(rc == EOK);
        rc = ddf_fun_add_to_class(hub_fun, "hub");
        assert(rc == EOK);

        fid_t fid = fibril_create(usb_hub_control_loop, hub_info);
        if (fid == 0) {
                usb_log_error("failed to start monitoring fibril for new hub");
                return ENOMEM;
        }
        fibril_add_ready(fid);

        usb_log_debug("hub fibril created");
        //(void)hub_info;
        //usb_hub_check_hub_changes();
        
        usb_log_info("hub dev added");
        //address is lost...
        usb_log_debug("\taddress %d, has %d ports ",
                        //hub_info->endpoints.control.,
                        hub_info->port_count);

        return EOK;
        //return ENOTSUP;
}


//*********************************************
//
//  hub driver code, main loop
//
//*********************************************

/**
 * release default address used by given hub
 *
 * Also unsets hub->is_default_address_used. Convenience wrapper function.
 * @note hub->connection MUST be open for communication
 * @param hub hub representation
 * @return error code
 */
static int usb_hub_release_default_address(usb_hub_info_t * hub){
        int opResult = usb_hc_release_default_address(&hub->connection);
        if(opResult!=EOK){
                usb_log_error("could not release default address, errno %d",opResult);
                return opResult;
        }
        hub->is_default_address_used = false;
        return EOK;
}

/**
 * Reset the port with new device and reserve the default address.
 * @param hc
 * @param port
 * @param target
 */
static void usb_hub_init_add_device(usb_hub_info_t * hub, uint16_t port,
                usb_speed_t speed) {
        //if this hub already uses default address, it cannot request it once more
        if(hub->is_default_address_used) return;
        int opResult = usb_hub_clear_port_feature(&hub->endpoints.control,
                                port, USB_HUB_FEATURE_C_PORT_CONNECTION);
        if(opResult != EOK){
                usb_log_warning("could not clear port-change-connection flag");
        }

        usb_device_request_setup_packet_t request;
        usb_log_info("some connection changed");
        assert(hub->endpoints.control.hc_phone);
        //get default address
        opResult = usb_hc_reserve_default_address(&hub->connection, speed);
        
        if (opResult != EOK) {
                usb_log_warning("cannot assign default address, it is probably used %d",
                                opResult);
                return;
        }
        hub->is_default_address_used = true;
        //reset port
        usb_hub_set_reset_port_request(&request, port);
        opResult = usb_endpoint_pipe_control_write(
                        &hub->endpoints.control,
                        &request,sizeof(usb_device_request_setup_packet_t),
                        NULL, 0
                        );
        if (opResult != EOK) {
                usb_log_error("something went wrong when reseting a port %d",opResult);
                //usb_hub_release_default_address(hc);
                usb_hub_release_default_address(hub);
        }
        return;
}

/**
 * Finalize adding new device after port reset
 * @param hc
 * @param port
 * @param target
 */
static void usb_hub_finalize_add_device( usb_hub_info_t * hub,
                uint16_t port, bool isLowSpeed) {

        int opResult;
        usb_log_info("finalizing add device");
        opResult = usb_hub_clear_port_feature(&hub->endpoints.control,
            port, USB_HUB_FEATURE_C_PORT_RESET);

        if (opResult != EOK) {
                usb_log_error("failed to clear port reset feature");
                usb_hub_release_default_address(hub);
                return;
        }
        //create connection to device
        usb_endpoint_pipe_t new_device_pipe;
        usb_device_connection_t new_device_connection;
        usb_device_connection_initialize_on_default_address(
                        &new_device_connection,
                        &hub->connection
                        );
        usb_endpoint_pipe_initialize_default_control(
                        &new_device_pipe,
                        &new_device_connection);
        usb_endpoint_pipe_probe_default_control(&new_device_pipe);
        /// \TODO get highspeed info
        usb_speed_t speed = isLowSpeed?USB_SPEED_LOW:USB_SPEED_FULL;


        /* Request address from host controller. */
        usb_address_t new_device_address = usb_hc_request_address(
                        &hub->connection,
                        speed
                        );
        if (new_device_address < 0) {
                usb_log_error("failed to get free USB address");
                opResult = new_device_address;
                usb_hub_release_default_address(hub);
                return;
        }
        usb_log_info("setting new address %d",new_device_address);
        //opResult = usb_drv_req_set_address(hc, USB_ADDRESS_DEFAULT,
        //    new_device_address);
        usb_endpoint_pipe_start_session(&new_device_pipe);
        opResult = usb_request_set_address(&new_device_pipe,new_device_address);
        usb_endpoint_pipe_end_session(&new_device_pipe);
        if (opResult != EOK) {
                usb_log_error("could not set address for new device %d",opResult);
                usb_hub_release_default_address(hub);
                return;
        }


        //opResult = usb_hub_release_default_address(hc);
        opResult = usb_hub_release_default_address(hub);
        if(opResult!=EOK){
                return;
        }

        devman_handle_t child_handle;
        //??
    opResult = usb_device_register_child_in_devman(new_device_address,
            hub->connection.hc_handle, hub->device, &child_handle,
            NULL, NULL, NULL);

        if (opResult != EOK) {
                usb_log_error("could not start driver for new device %d",opResult);
                return;
        }
        hub->attached_devs[port].handle = child_handle;
        hub->attached_devs[port].address = new_device_address;

        //opResult = usb_drv_bind_address(hc, new_device_address, child_handle);
        opResult = usb_hc_register_device(
                        &hub->connection,
                        &hub->attached_devs[port]);
        if (opResult != EOK) {
                usb_log_error("could not assign address of device in hcd %d",opResult);
                return;
        }
        usb_log_info("new device address %d, handle %zu",
            new_device_address, child_handle);

}

/**
 * Unregister device address in hc
 * @param hc
 * @param port
 * @param target
 */
static void usb_hub_removed_device(
    usb_hub_info_t * hub,uint16_t port) {

        int opResult = usb_hub_clear_port_feature(&hub->endpoints.control,
                                port, USB_HUB_FEATURE_C_PORT_CONNECTION);
        if(opResult != EOK){
                usb_log_warning("could not clear port-change-connection flag");
        }
        /** \TODO remove device from device manager - not yet implemented in
         * devide manager
         */
        
        //close address
        if(hub->attached_devs[port].address!=0){
                /*uncomment this code to use it when DDF allows device removal
                opResult = usb_hc_unregister_device(
                                &hub->connection, hub->attached_devs[port].address);
                if(opResult != EOK) {
                        dprintf(USB_LOG_LEVEL_WARNING, "could not release address of " \
                            "removed device: %d", opResult);
                }
                hub->attached_devs[port].address = 0;
                hub->attached_devs[port].handle = 0;
                 */
        }else{
                usb_log_warning("this is strange, disconnected device had no address");
                //device was disconnected before it`s port was reset - return default address
                usb_hub_release_default_address(hub);
        }
}


/**
 * Process over current condition on port.
 * 
 * Turn off the power on the port.
 *
 * @param hub
 * @param port
 */
static void usb_hub_over_current( usb_hub_info_t * hub,
                uint16_t port){
        int opResult;
        opResult = usb_hub_clear_port_feature(&hub->endpoints.control,
            port, USB_HUB_FEATURE_PORT_POWER);
        if(opResult!=EOK){
                usb_log_error("cannot power off port %d;  %d",
                                port, opResult);
        }
}

/**
 * Process interrupts on given hub port
 * @param hc
 * @param port
 * @param target
 */
static void usb_hub_process_interrupt(usb_hub_info_t * hub, 
        uint16_t port) {
        usb_log_debug("interrupt at port %d", port);
        //determine type of change
        usb_endpoint_pipe_t *pipe = &hub->endpoints.control;
        
        int opResult;

        usb_port_status_t status;
        size_t rcvd_size;
        usb_device_request_setup_packet_t request;
        //int opResult;
        usb_hub_set_port_status_request(&request, port);
        //endpoint 0

        opResult = usb_endpoint_pipe_control_read(
                        pipe,
                        &request, sizeof(usb_device_request_setup_packet_t),
                        &status, 4, &rcvd_size
                        );
        if (opResult != EOK) {
                usb_log_error("could not get port status");
                return;
        }
        if (rcvd_size != sizeof (usb_port_status_t)) {
                usb_log_error("received status has incorrect size");
                return;
        }
        //something connected/disconnected
        if (usb_port_connect_change(&status)) {
                if (usb_port_dev_connected(&status)) {
                        usb_log_info("some connection changed");
                        usb_hub_init_add_device(hub, port, usb_port_speed(&status));
                } else {
                        usb_hub_removed_device(hub, port);
                }
        }
        //over current
        if (usb_port_overcurrent_change(&status)) {
                //check if it was not auto-resolved
                if(usb_port_over_current(&status)){
                        usb_hub_over_current(hub,port);
                }else{
                        usb_log_info("over current condition was auto-resolved on port %d",
                                        port);
                }
        }
        //port reset
        if (usb_port_reset_completed(&status)) {
                usb_log_info("port reset complete");
                if (usb_port_enabled(&status)) {
                        usb_hub_finalize_add_device(hub, port, usb_port_low_speed(&status));
                } else {
                        usb_log_warning("port reset, but port still not enabled");
                }
        }

        usb_port_set_connect_change(&status, false);
        usb_port_set_reset(&status, false);
        usb_port_set_reset_completed(&status, false);
        usb_port_set_dev_connected(&status, false);
        if (status>>16) {
                usb_log_info("there was some unsupported change on port %d: %X",
                                port,status);

        }
        /// \TODO handle other changes - is there any?
}

/**
 * Check changes on particular hub
 * @param hub_info_param pointer to usb_hub_info_t structure
 * @return error code if there is problem when initializing communication with
 * hub, EOK otherwise
 */
int usb_hub_check_hub_changes(usb_hub_info_t * hub_info){
        int opResult;
        opResult = usb_endpoint_pipe_start_session(&hub_info->endpoints.status_change);
        if(opResult != EOK){
                usb_log_error("could not initialize communication for hub; %d",
                                opResult);
                return opResult;
        }

        size_t port_count = hub_info->port_count;

        /// FIXME: count properly
        size_t byte_length = ((port_count+1) / 8) + 1;
                void *change_bitmap = malloc(byte_length);
        size_t actual_size;

        /*
         * Send the request.
         */
        opResult = usb_endpoint_pipe_read(
                        &hub_info->endpoints.status_change,
                        change_bitmap, byte_length, &actual_size
                        );

        if (opResult != EOK) {
                free(change_bitmap);
                usb_log_warning("something went wrong while getting status of hub");
                usb_endpoint_pipe_end_session(&hub_info->endpoints.status_change);
                return opResult;
        }
        unsigned int port;
        opResult = usb_endpoint_pipe_start_session(&hub_info->endpoints.control);
        if(opResult!=EOK){
                usb_log_error("could not start control pipe session %d", opResult);
                usb_endpoint_pipe_end_session(&hub_info->endpoints.status_change);
                return opResult;
        }
        opResult = usb_hc_connection_open(&hub_info->connection);
        if(opResult!=EOK){
                usb_log_error("could not start host controller session %d",
                                opResult);
                usb_endpoint_pipe_end_session(&hub_info->endpoints.control);
                usb_endpoint_pipe_end_session(&hub_info->endpoints.status_change);
                return opResult;
        }

        ///todo, opresult check, pre obe konekce
        for (port = 1; port < port_count+1; ++port) {
                bool interrupt =
                                (((uint8_t*) change_bitmap)[port / 8] >> (port % 8)) % 2;
                if (interrupt) {
                        usb_hub_process_interrupt(
                                hub_info, port);
                }
        }
        usb_hc_connection_close(&hub_info->connection);
        usb_endpoint_pipe_end_session(&hub_info->endpoints.control);
        usb_endpoint_pipe_end_session(&hub_info->endpoints.status_change);
        free(change_bitmap);
        return EOK;
}



/**
 * @}
 */