source: mainline/uspace/drv/bus/usb/usbhub/port_status.h@ 48a31be

/*
 * Copyright (c) 2010 Matus Dekanek
 * 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 drvusbhub
 * @{
 */

#ifndef HUB_PORT_STATUS_H
#define HUB_PORT_STATUS_H

#include <bool.h>
#include <sys/types.h>
#include <usb/dev/request.h>

/**
 * structure holding port status and changes flags.
 * should not be accessed directly, use supplied getter/setter methods.
 *
 * For more information refer to table 11-15 in
 * "Universal Serial Bus Specification Revision 1.1"
 *
 */
typedef uint32_t usb_port_status_t;
// TODO Mind the endiannes, changes are in the first byte of the second word
// status is in the first byte of the first word
#define USB_HUB_PORT_STATUS_CONNECTION (1 << (USB_HUB_FEATURE_PORT_CONNECTION))
#define USB_HUB_PORT_STATUS_ENABLED (1 << (USB_HUB_FEATURE_PORT_ENABLE))
#define USB_HUB_PORT_STATUS_SUSPEND (1 << (USB_HUB_FEATURE_PORT_SUSPEND))
#define USB_HUB_PORT_STATUS_OC (1 << (USB_HUB_FEATURE_PORT_OVER_CURRENT))
#define USB_HUB_PORT_STATUS_RESET (1 << (USB_HUB_FEATURE_PORT_RESET))
#define USB_HUB_PORT_STATUS_POWER (1 << (USB_HUB_FEATURE_PORT_POWER))
#define USB_HUB_PORT_STATUS_LOW_SPEED (1 << (USB_HUB_FEATURE_PORT_LOW_SPEED))
#define USB_HUB_PORT_STATUS_HIGH_SPEED (1 << 10)

#define USB_HUB_PORT_C_STATUS_CONNECTION \
    (1 << (USB_HUB_FEATURE_C_PORT_CONNECTION))
#define USB_HUB_PORT_C_STATUS_ENABLED \
    (1 << (USB_HUB_FEATURE_C_PORT_ENABLE))
#define USB_HUB_PORT_C_STATUS_SUSPEND \
    (1 << (USB_HUB_FEATURE_C_PORT_SUSPEND))
#define USB_HUB_PORT_C_STATUS_OC \
    (1 << (USB_HUB_FEATURE_C_PORT_OVER_CURRENT))
#define USB_HUB_PORT_C_STATUS_RESET \
    (1 << (USB_HUB_FEATURE_C_PORT_RESET))

/**
 * structure holding hub status and changes flags.
 *
 * For more information refer to table 11.16.2.5 in
 * "Universal Serial Bus Specification Revision 1.1"
 *
 */
typedef uint32_t usb_hub_status_t;
// TODO Mind the endiannes, changes are in the first byte of the second word
// status is in the first byte of the first word
#define USB_HUB_STATUS_OVER_CURRENT \
    (1 << (USB_HUB_FEATURE_HUB_OVER_CURRENT))
#define USB_HUB_STATUS_LOCAL_POWER \
    (1 << (USB_HUB_FEATURE_HUB_LOCAL_POWER))

#define USB_HUB_STATUS_C_OVER_CURRENT \
    (1 << (16 + USB_HUB_FEATURE_C_HUB_OVER_CURRENT))
#define USB_HUB_STATUS_C_LOCAL_POWER \
    (1 << (16 + USB_HUB_FEATURE_C_HUB_LOCAL_POWER))

/**
 * set the device request to be a port feature enable request
 * @param request
 * @param port
 * @param feature_selector
 */
static inline void usb_hub_set_enable_port_feature_request(
    usb_device_request_setup_packet_t *request, uint16_t port,
    uint16_t feature_selector) {
        request->index = port;
        request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE;
        request->request = USB_HUB_REQUEST_SET_FEATURE;
        request->value = feature_selector;
        request->length = 0;
}

/**
 * set the device request to be a port feature clear request
 * @param request
 * @param port
 * @param feature_selector
 */
static inline void usb_hub_set_disable_port_feature_request(
    usb_device_request_setup_packet_t *request, uint16_t port,
    uint16_t feature_selector
    ) {
        request->index = port;
        request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE;
        request->request = USB_HUB_REQUEST_CLEAR_FEATURE;
        request->value = feature_selector;
        request->length = 0;
}

/**
 * set the device request to be a port disable request
 * @param request
 * @param port
 */
static inline void usb_hub_set_reset_port_request(
    usb_device_request_setup_packet_t *request, uint16_t port
    ) {
        request->index = port;
        request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE;
        request->request = USB_HUB_REQUEST_SET_FEATURE;
        request->value = USB_HUB_FEATURE_PORT_RESET;
        request->length = 0;
}

/**
 * get i`th bit of port status
 * 
 * @param status
 * @param idx
 * @return
 */
static inline bool usb_port_is_status(usb_port_status_t status, int idx) {
        return (status & (1 << idx)) != 0;
}

/**
 * speed getter for port status
 *
 * @param status
 * @return speed of usb device (for more see usb specification)
 */
static inline usb_speed_t usb_port_speed(usb_port_status_t status) {
        if ((status & USB_HUB_PORT_STATUS_LOW_SPEED) != 0)
                return USB_SPEED_LOW;
        if ((status & USB_HUB_PORT_STATUS_HIGH_SPEED) != 0)
                return USB_SPEED_HIGH;
        return USB_SPEED_FULL;
}



#endif  /* HUB_PORT_STATUS_H */
/**
 * @}
 */