Index: uspace/drv/uhci-hcd/Makefile =================================================================== --- uspace/drv/uhci-hcd/Makefile (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ uspace/drv/uhci-hcd/Makefile (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -39,5 +39,5 @@ hc.c \ root_hub.c \ - uhci_struct/transfer_descriptor.c \ + hw_struct/transfer_descriptor.c \ pci.c \ batch.c Index: uspace/drv/uhci-hcd/batch.c =================================================================== --- uspace/drv/uhci-hcd/batch.c (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ uspace/drv/uhci-hcd/batch.c (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -40,6 +40,6 @@ #include "batch.h" #include "transfer_list.h" +#include "hw_struct/transfer_descriptor.h" #include "utils/malloc32.h" -#include "uhci_struct/transfer_descriptor.h" #define DEFAULT_ERROR_COUNT 3 Index: uspace/drv/uhci-hcd/batch.h =================================================================== --- uspace/drv/uhci-hcd/batch.h (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ uspace/drv/uhci-hcd/batch.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -42,5 +42,5 @@ #include -#include "uhci_struct/queue_head.h" +#include "hw_struct/queue_head.h" usb_transfer_batch_t * batch_get( Index: uspace/drv/uhci-hcd/hw_struct/link_pointer.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) +++ uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010 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 drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_LINK_POINTER_H +#define DRV_UHCI_LINK_POINTER_H + +/* UHCI link pointer, used by many data structures */ +typedef uint32_t link_pointer_t; + +#define LINK_POINTER_TERMINATE_FLAG (1 << 0) +#define LINK_POINTER_QUEUE_HEAD_FLAG (1 << 1) +#define LINK_POINTER_ZERO_BIT_FLAG (1 << 2) +#define LINK_POINTER_VERTICAL_FLAG (1 << 2) +#define LINK_POINTER_RESERVED_FLAG (1 << 3) + +#define LINK_POINTER_ADDRESS_MASK 0xfffffff0 /* upper 28 bits */ + +#define LINK_POINTER_QH(address) \ + ((address & LINK_POINTER_ADDRESS_MASK) | LINK_POINTER_QUEUE_HEAD_FLAG) + +#define LINK_POINTER_TD(address) \ + (address & LINK_POINTER_ADDRESS_MASK) + +#define LINK_POINTER_TERM \ + ((link_pointer_t)LINK_POINTER_TERMINATE_FLAG) + +#endif +/** + * @} + */ + Index: uspace/drv/uhci-hcd/hw_struct/queue_head.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) +++ uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2010 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 drv usbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_QH_H +#define DRV_UHCI_QH_H + +/* libc */ +#include + +#include "link_pointer.h" +#include "utils/malloc32.h" + +typedef struct queue_head { + volatile link_pointer_t next; + volatile link_pointer_t element; +} __attribute__((packed)) qh_t; +/*----------------------------------------------------------------------------*/ +/** Initialize queue head structure + * + * @param[in] instance qh_t structure to initialize. + * + * Sets both pointer to terminal NULL. + */ +static inline void qh_init(qh_t *instance) +{ + assert(instance); + + instance->element = 0 | LINK_POINTER_TERMINATE_FLAG; + instance->next = 0 | LINK_POINTER_TERMINATE_FLAG; +} +/*----------------------------------------------------------------------------*/ +/** Set queue head next pointer + * + * @param[in] instance qh_t structure to use. + * @param[in] pa Physical address of the next queue head. + * + * Adds proper flag. If the pointer is NULL or terminal, sets next to terminal + * NULL. + */ +static inline void qh_set_next_qh(qh_t *instance, uint32_t pa) +{ + /* Address is valid and not terminal */ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->next = LINK_POINTER_QH(pa); + } else { + instance->next = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to initialize. + * @param[in] pa Physical address of the next queue head. + * + * Adds proper flag. If the pointer is NULL or terminal, sets element + * to terminal NULL. + */ +static inline void qh_set_element_qh(qh_t *instance, uint32_t pa) +{ + /* Address is valid and not terminal */ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->element = LINK_POINTER_QH(pa); + } else { + instance->element = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to initialize. + * @param[in] pa Physical address of the TD structure. + * + * Adds proper flag. If the pointer is NULL or terminal, sets element + * to terminal NULL. + */ +static inline void qh_set_element_td(qh_t *instance, uint32_t pa) +{ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->element = LINK_POINTER_TD(pa); + } else { + instance->element = LINK_POINTER_TERM; + } +} + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c =================================================================== --- uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -0,0 +1,173 @@ +/* + * 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 drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include + +#include "transfer_descriptor.h" +#include "utils/malloc32.h" + +/** Initialize Transfer Descriptor + * + * @param[in] instance Memory place to initialize. + * @param[in] err_count Number of retries hc should attempt. + * @param[in] size Size of data source. + * @param[in] toggle Value of toggle bit. + * @param[in] iso True if TD represents Isochronous transfer. + * @param[in] low_speed Target device's speed. + * @param[in] target Address and endpoint receiving the transfer. + * @param[in] pid Packet identification (SETUP, IN or OUT). + * @param[in] buffer Source of data. + * @param[in] next Net TD in transaction. + * @return Error code. + * + * Uses a mix of supplied and default values. + * Implicit values: + * - all TDs have vertical flag set (makes transfers to endpoints atomic) + * - in the error field only active it is set + * - if the packet uses PID_IN and is not isochronous SPD is set + * + * Dumps 8 bytes of buffer if PID_SETUP is used. + */ +void td_init(td_t *instance, int err_count, size_t size, bool toggle, bool iso, + bool low_speed, usb_target_t target, usb_packet_id pid, void *buffer, + td_t *next) +{ + assert(instance); + assert(size < 1024); + assert((pid == USB_PID_SETUP) || (pid == USB_PID_IN) + || (pid == USB_PID_OUT)); + + const uint32_t next_pa = addr_to_phys(next); + assert((next_pa & LINK_POINTER_ADDRESS_MASK) == next_pa); + + instance->next = 0 + | LINK_POINTER_VERTICAL_FLAG + | (next_pa ? next_pa : LINK_POINTER_TERMINATE_FLAG); + + instance->status = 0 + | ((err_count & TD_STATUS_ERROR_COUNT_MASK) << TD_STATUS_ERROR_COUNT_POS) + | (low_speed ? TD_STATUS_LOW_SPEED_FLAG : 0) + | (iso ? TD_STATUS_ISOCHRONOUS_FLAG : 0) + | TD_STATUS_ERROR_ACTIVE; + + if (pid == USB_PID_IN && !iso) { + instance->status |= TD_STATUS_SPD_FLAG; + } + + instance->device = 0 + | (((size - 1) & TD_DEVICE_MAXLEN_MASK) << TD_DEVICE_MAXLEN_POS) + | (toggle ? TD_DEVICE_DATA_TOGGLE_ONE_FLAG : 0) + | ((target.address & TD_DEVICE_ADDRESS_MASK) << TD_DEVICE_ADDRESS_POS) + | ((target.endpoint & TD_DEVICE_ENDPOINT_MASK) << TD_DEVICE_ENDPOINT_POS) + | ((pid & TD_DEVICE_PID_MASK) << TD_DEVICE_PID_POS); + + instance->buffer_ptr = addr_to_phys(buffer); + + usb_log_debug2("Created TD(%p): %X:%X:%X:%X(%p).\n", + instance, instance->next, instance->status, instance->device, + instance->buffer_ptr, buffer); + td_print_status(instance); + if (pid == USB_PID_SETUP) { + usb_log_debug("SETUP BUFFER: %s\n", + usb_debug_str_buffer(buffer, 8, 8)); + } +} +/*----------------------------------------------------------------------------*/ +/** Convert TD status into standard error code + * + * @param[in] instance TD structure to use. + * @return Error code. + */ +int td_status(td_t *instance) +{ + assert(instance); + + /* this is hc internal error it should never be reported */ + if ((instance->status & TD_STATUS_ERROR_BIT_STUFF) != 0) + return EAGAIN; + + /* CRC or timeout error, like device not present or bad data, + * it won't be reported unless err count reached zero */ + if ((instance->status & TD_STATUS_ERROR_CRC) != 0) + return EBADCHECKSUM; + + /* hc does not end transaction on these, it should never be reported */ + if ((instance->status & TD_STATUS_ERROR_NAK) != 0) + return EAGAIN; + + /* buffer overrun or underrun */ + if ((instance->status & TD_STATUS_ERROR_BUFFER) != 0) + return ERANGE; + + /* device babble is something serious */ + if ((instance->status & TD_STATUS_ERROR_BABBLE) != 0) + return EIO; + + /* stall might represent err count reaching zero or stall response from + * the device, is err count reached zero, one of the above is reported*/ + if ((instance->status & TD_STATUS_ERROR_STALLED) != 0) + return ESTALL; + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Print values in status field (dw1) in a human readable way. + * + * @param[in] instance TD structure to use. + */ +void td_print_status(td_t *instance) +{ + assert(instance); + const uint32_t s = instance->status; + usb_log_debug2("TD(%p) status(%#x):%s %d,%s%s%s%s%s%s%s%s%s%s%s %d.\n", + instance, instance->status, + (s & TD_STATUS_SPD_FLAG) ? " SPD," : "", + (s >> TD_STATUS_ERROR_COUNT_POS) & TD_STATUS_ERROR_COUNT_MASK, + (s & TD_STATUS_LOW_SPEED_FLAG) ? " LOW SPEED," : "", + (s & TD_STATUS_ISOCHRONOUS_FLAG) ? " ISOCHRONOUS," : "", + (s & TD_STATUS_IOC_FLAG) ? " IOC," : "", + (s & TD_STATUS_ERROR_ACTIVE) ? " ACTIVE," : "", + (s & TD_STATUS_ERROR_STALLED) ? " STALLED," : "", + (s & TD_STATUS_ERROR_BUFFER) ? " BUFFER," : "", + (s & TD_STATUS_ERROR_BABBLE) ? " BABBLE," : "", + (s & TD_STATUS_ERROR_NAK) ? " NAK," : "", + (s & TD_STATUS_ERROR_CRC) ? " CRC/TIMEOUT," : "", + (s & TD_STATUS_ERROR_BIT_STUFF) ? " BIT_STUFF," : "", + (s & TD_STATUS_ERROR_RESERVED) ? " RESERVED," : "", + td_act_size(instance) + ); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -0,0 +1,161 @@ +/* + * 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 drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSFER_DESCRIPTOR_H +#define DRV_UHCI_TRANSFER_DESCRIPTOR_H + +#include +#include + +#include "link_pointer.h" + +/** UHCI Transfer Descriptor */ +typedef struct transfer_descriptor { + link_pointer_t next; + + volatile uint32_t status; +#define TD_STATUS_RESERVED_MASK 0xc000f800 +#define TD_STATUS_SPD_FLAG ( 1 << 29 ) +#define TD_STATUS_ERROR_COUNT_POS ( 27 ) +#define TD_STATUS_ERROR_COUNT_MASK ( 0x3 ) +#define TD_STATUS_LOW_SPEED_FLAG ( 1 << 26 ) +#define TD_STATUS_ISOCHRONOUS_FLAG ( 1 << 25 ) +#define TD_STATUS_IOC_FLAG ( 1 << 24 ) + +#define TD_STATUS_ERROR_ACTIVE ( 1 << 23 ) +#define TD_STATUS_ERROR_STALLED ( 1 << 22 ) +#define TD_STATUS_ERROR_BUFFER ( 1 << 21 ) +#define TD_STATUS_ERROR_BABBLE ( 1 << 20 ) +#define TD_STATUS_ERROR_NAK ( 1 << 19 ) +#define TD_STATUS_ERROR_CRC ( 1 << 18 ) +#define TD_STATUS_ERROR_BIT_STUFF ( 1 << 17 ) +#define TD_STATUS_ERROR_RESERVED ( 1 << 16 ) +#define TD_STATUS_ERROR_POS 16 +#define TD_STATUS_ERROR_MASK ( 0xff ) + +#define TD_STATUS_ACTLEN_POS 0 +#define TD_STATUS_ACTLEN_MASK 0x7ff + + volatile uint32_t device; +#define TD_DEVICE_MAXLEN_POS 21 +#define TD_DEVICE_MAXLEN_MASK ( 0x7ff ) +#define TD_DEVICE_RESERVED_FLAG ( 1 << 20 ) +#define TD_DEVICE_DATA_TOGGLE_ONE_FLAG ( 1 << 19 ) +#define TD_DEVICE_ENDPOINT_POS 15 +#define TD_DEVICE_ENDPOINT_MASK ( 0xf ) +#define TD_DEVICE_ADDRESS_POS 8 +#define TD_DEVICE_ADDRESS_MASK ( 0x7f ) +#define TD_DEVICE_PID_POS 0 +#define TD_DEVICE_PID_MASK ( 0xff ) + + volatile uint32_t buffer_ptr; + + /* there is 16 bytes of data available here, according to UHCI + * Design guide, according to linux kernel the hardware does not care, + * it just needs to be aligned, we don't use it anyway + */ +} __attribute__((packed)) td_t; + + +void td_init(td_t *instance, int error_count, size_t size, bool toggle, + bool iso, bool low_speed, usb_target_t target, usb_packet_id pid, + void *buffer, td_t *next); + +int td_status(td_t *instance); + +void td_print_status(td_t *instance); +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing actual size out of TD. + * + * @param[in] instance TD structure to use. + * @return Parsed actual size. + */ +static inline size_t td_act_size(td_t *instance) +{ + assert(instance); + const uint32_t s = instance->status; + return ((s >> TD_STATUS_ACTLEN_POS) + 1) & TD_STATUS_ACTLEN_MASK; +} +/*----------------------------------------------------------------------------*/ +/** Check whether less than max data were recieved and packet is marked as SPD. + * + * @param[in] instance TD structure to use. + * @return True if packet is short (less than max bytes and SPD set), false + * otherwise. + */ +static inline bool td_is_short(td_t *instance) +{ + const size_t act_size = td_act_size(instance); + const size_t max_size = + ((instance->device >> TD_DEVICE_MAXLEN_POS) + 1) + & TD_DEVICE_MAXLEN_MASK; + return + (instance->status | TD_STATUS_SPD_FLAG) && act_size < max_size; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing value of toggle bit. + * + * @param[in] instance TD structure to use. + * @return Toggle bit value. + */ +static inline int td_toggle(td_t *instance) +{ + assert(instance); + return (instance->device & TD_DEVICE_DATA_TOGGLE_ONE_FLAG) ? 1 : 0; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing value of active bit + * + * @param[in] instance TD structure to use. + * @return Active bit value. + */ +static inline bool td_is_active(td_t *instance) +{ + assert(instance); + return (instance->status & TD_STATUS_ERROR_ACTIVE) != 0; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for setting IOC bit. + * + * @param[in] instance TD structure to use. + */ +static inline void td_set_ioc(td_t *instance) +{ + assert(instance); + instance->status |= TD_STATUS_IOC_FLAG; +} +/*----------------------------------------------------------------------------*/ +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfer_list.h =================================================================== --- uspace/drv/uhci-hcd/transfer_list.h (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ uspace/drv/uhci-hcd/transfer_list.h (revision 87644b475e40058a32e8bf51a05dc7c729e2321d) @@ -37,7 +37,6 @@ #include -#include "uhci_struct/queue_head.h" - #include "batch.h" +#include "hw_struct/queue_head.h" typedef struct transfer_list Index: uspace/drv/uhci-hcd/uhci_struct/link_pointer.h =================================================================== --- uspace/drv/uhci-hcd/uhci_struct/link_pointer.h (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ (revision ) @@ -1,61 +1,0 @@ -/* - * Copyright (c) 2010 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 drvusbuhcihc - * @{ - */ -/** @file - * @brief UHCI driver - */ -#ifndef DRV_UHCI_LINK_POINTER_H -#define DRV_UHCI_LINK_POINTER_H - -/* UHCI link pointer, used by many data structures */ -typedef uint32_t link_pointer_t; - -#define LINK_POINTER_TERMINATE_FLAG (1 << 0) -#define LINK_POINTER_QUEUE_HEAD_FLAG (1 << 1) -#define LINK_POINTER_ZERO_BIT_FLAG (1 << 2) -#define LINK_POINTER_VERTICAL_FLAG (1 << 2) -#define LINK_POINTER_RESERVED_FLAG (1 << 3) - -#define LINK_POINTER_ADDRESS_MASK 0xfffffff0 /* upper 28 bits */ - -#define LINK_POINTER_QH(address) \ - ((address & LINK_POINTER_ADDRESS_MASK) | LINK_POINTER_QUEUE_HEAD_FLAG) - -#define LINK_POINTER_TD(address) \ - (address & LINK_POINTER_ADDRESS_MASK) - -#define LINK_POINTER_TERM \ - ((link_pointer_t)LINK_POINTER_TERMINATE_FLAG) - -#endif -/** - * @} - */ - Index: uspace/drv/uhci-hcd/uhci_struct/queue_head.h =================================================================== --- uspace/drv/uhci-hcd/uhci_struct/queue_head.h (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ (revision ) @@ -1,118 +1,0 @@ -/* - * Copyright (c) 2010 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 drv usbuhcihc - * @{ - */ -/** @file - * @brief UHCI driver - */ -#ifndef DRV_UHCI_QH_H -#define DRV_UHCI_QH_H - -/* libc */ -#include - -#include "link_pointer.h" -#include "utils/malloc32.h" - -typedef struct queue_head { - volatile link_pointer_t next; - volatile link_pointer_t element; -} __attribute__((packed)) qh_t; -/*----------------------------------------------------------------------------*/ -/** Initialize queue head structure - * - * @param[in] instance qh_t structure to initialize. - * - * Sets both pointer to terminal NULL. - */ -static inline void qh_init(qh_t *instance) -{ - assert(instance); - - instance->element = 0 | LINK_POINTER_TERMINATE_FLAG; - instance->next = 0 | LINK_POINTER_TERMINATE_FLAG; -} -/*----------------------------------------------------------------------------*/ -/** Set queue head next pointer - * - * @param[in] instance qh_t structure to use. - * @param[in] pa Physical address of the next queue head. - * - * Adds proper flag. If the pointer is NULL or terminal, sets next to terminal - * NULL. - */ -static inline void qh_set_next_qh(qh_t *instance, uint32_t pa) -{ - /* Address is valid and not terminal */ - if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { - instance->next = LINK_POINTER_QH(pa); - } else { - instance->next = LINK_POINTER_TERM; - } -} -/*----------------------------------------------------------------------------*/ -/** Set queue head element pointer - * - * @param[in] instance qh_t structure to initialize. - * @param[in] pa Physical address of the next queue head. - * - * Adds proper flag. If the pointer is NULL or terminal, sets element - * to terminal NULL. - */ -static inline void qh_set_element_qh(qh_t *instance, uint32_t pa) -{ - /* Address is valid and not terminal */ - if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { - instance->element = LINK_POINTER_QH(pa); - } else { - instance->element = LINK_POINTER_TERM; - } -} -/*----------------------------------------------------------------------------*/ -/** Set queue head element pointer - * - * @param[in] instance qh_t structure to initialize. - * @param[in] pa Physical address of the TD structure. - * - * Adds proper flag. If the pointer is NULL or terminal, sets element - * to terminal NULL. - */ -static inline void qh_set_element_td(qh_t *instance, uint32_t pa) -{ - if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { - instance->element = LINK_POINTER_TD(pa); - } else { - instance->element = LINK_POINTER_TERM; - } -} - -#endif -/** - * @} - */ Index: uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.c =================================================================== --- uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.c (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ (revision ) @@ -1,173 +1,0 @@ -/* - * 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 drvusbuhcihc - * @{ - */ -/** @file - * @brief UHCI driver - */ -#include -#include - -#include "transfer_descriptor.h" -#include "utils/malloc32.h" - -/** Initialize Transfer Descriptor - * - * @param[in] instance Memory place to initialize. - * @param[in] err_count Number of retries hc should attempt. - * @param[in] size Size of data source. - * @param[in] toggle Value of toggle bit. - * @param[in] iso True if TD represents Isochronous transfer. - * @param[in] low_speed Target device's speed. - * @param[in] target Address and endpoint receiving the transfer. - * @param[in] pid Packet identification (SETUP, IN or OUT). - * @param[in] buffer Source of data. - * @param[in] next Net TD in transaction. - * @return Error code. - * - * Uses a mix of supplied and default values. - * Implicit values: - * - all TDs have vertical flag set (makes transfers to endpoints atomic) - * - in the error field only active it is set - * - if the packet uses PID_IN and is not isochronous SPD is set - * - * Dumps 8 bytes of buffer if PID_SETUP is used. - */ -void td_init(td_t *instance, int err_count, size_t size, bool toggle, bool iso, - bool low_speed, usb_target_t target, usb_packet_id pid, void *buffer, - td_t *next) -{ - assert(instance); - assert(size < 1024); - assert((pid == USB_PID_SETUP) || (pid == USB_PID_IN) - || (pid == USB_PID_OUT)); - - const uint32_t next_pa = addr_to_phys(next); - assert((next_pa & LINK_POINTER_ADDRESS_MASK) == next_pa); - - instance->next = 0 - | LINK_POINTER_VERTICAL_FLAG - | (next_pa ? next_pa : LINK_POINTER_TERMINATE_FLAG); - - instance->status = 0 - | ((err_count & TD_STATUS_ERROR_COUNT_MASK) << TD_STATUS_ERROR_COUNT_POS) - | (low_speed ? TD_STATUS_LOW_SPEED_FLAG : 0) - | (iso ? TD_STATUS_ISOCHRONOUS_FLAG : 0) - | TD_STATUS_ERROR_ACTIVE; - - if (pid == USB_PID_IN && !iso) { - instance->status |= TD_STATUS_SPD_FLAG; - } - - instance->device = 0 - | (((size - 1) & TD_DEVICE_MAXLEN_MASK) << TD_DEVICE_MAXLEN_POS) - | (toggle ? TD_DEVICE_DATA_TOGGLE_ONE_FLAG : 0) - | ((target.address & TD_DEVICE_ADDRESS_MASK) << TD_DEVICE_ADDRESS_POS) - | ((target.endpoint & TD_DEVICE_ENDPOINT_MASK) << TD_DEVICE_ENDPOINT_POS) - | ((pid & TD_DEVICE_PID_MASK) << TD_DEVICE_PID_POS); - - instance->buffer_ptr = addr_to_phys(buffer); - - usb_log_debug2("Created TD(%p): %X:%X:%X:%X(%p).\n", - instance, instance->next, instance->status, instance->device, - instance->buffer_ptr, buffer); - td_print_status(instance); - if (pid == USB_PID_SETUP) { - usb_log_debug("SETUP BUFFER: %s\n", - usb_debug_str_buffer(buffer, 8, 8)); - } -} -/*----------------------------------------------------------------------------*/ -/** Convert TD status into standard error code - * - * @param[in] instance TD structure to use. - * @return Error code. - */ -int td_status(td_t *instance) -{ - assert(instance); - - /* this is hc internal error it should never be reported */ - if ((instance->status & TD_STATUS_ERROR_BIT_STUFF) != 0) - return EAGAIN; - - /* CRC or timeout error, like device not present or bad data, - * it won't be reported unless err count reached zero */ - if ((instance->status & TD_STATUS_ERROR_CRC) != 0) - return EBADCHECKSUM; - - /* hc does not end transaction on these, it should never be reported */ - if ((instance->status & TD_STATUS_ERROR_NAK) != 0) - return EAGAIN; - - /* buffer overrun or underrun */ - if ((instance->status & TD_STATUS_ERROR_BUFFER) != 0) - return ERANGE; - - /* device babble is something serious */ - if ((instance->status & TD_STATUS_ERROR_BABBLE) != 0) - return EIO; - - /* stall might represent err count reaching zero or stall response from - * the device, is err count reached zero, one of the above is reported*/ - if ((instance->status & TD_STATUS_ERROR_STALLED) != 0) - return ESTALL; - - return EOK; -} -/*----------------------------------------------------------------------------*/ -/** Print values in status field (dw1) in a human readable way. - * - * @param[in] instance TD structure to use. - */ -void td_print_status(td_t *instance) -{ - assert(instance); - const uint32_t s = instance->status; - usb_log_debug2("TD(%p) status(%#x):%s %d,%s%s%s%s%s%s%s%s%s%s%s %d.\n", - instance, instance->status, - (s & TD_STATUS_SPD_FLAG) ? " SPD," : "", - (s >> TD_STATUS_ERROR_COUNT_POS) & TD_STATUS_ERROR_COUNT_MASK, - (s & TD_STATUS_LOW_SPEED_FLAG) ? " LOW SPEED," : "", - (s & TD_STATUS_ISOCHRONOUS_FLAG) ? " ISOCHRONOUS," : "", - (s & TD_STATUS_IOC_FLAG) ? " IOC," : "", - (s & TD_STATUS_ERROR_ACTIVE) ? " ACTIVE," : "", - (s & TD_STATUS_ERROR_STALLED) ? " STALLED," : "", - (s & TD_STATUS_ERROR_BUFFER) ? " BUFFER," : "", - (s & TD_STATUS_ERROR_BABBLE) ? " BABBLE," : "", - (s & TD_STATUS_ERROR_NAK) ? " NAK," : "", - (s & TD_STATUS_ERROR_CRC) ? " CRC/TIMEOUT," : "", - (s & TD_STATUS_ERROR_BIT_STUFF) ? " BIT_STUFF," : "", - (s & TD_STATUS_ERROR_RESERVED) ? " RESERVED," : "", - td_act_size(instance) - ); -} -/** - * @} - */ Index: uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.h =================================================================== --- uspace/drv/uhci-hcd/uhci_struct/transfer_descriptor.h (revision b9fa0a962eaa3177326795702c1a444540e5cb24) +++ (revision ) @@ -1,161 +1,0 @@ -/* - * 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 drvusbuhcihc - * @{ - */ -/** @file - * @brief UHCI driver - */ -#ifndef DRV_UHCI_TRANSFER_DESCRIPTOR_H -#define DRV_UHCI_TRANSFER_DESCRIPTOR_H - -#include -#include - -#include "link_pointer.h" - -/** UHCI Transfer Descriptor */ -typedef struct transfer_descriptor { - link_pointer_t next; - - volatile uint32_t status; -#define TD_STATUS_RESERVED_MASK 0xc000f800 -#define TD_STATUS_SPD_FLAG ( 1 << 29 ) -#define TD_STATUS_ERROR_COUNT_POS ( 27 ) -#define TD_STATUS_ERROR_COUNT_MASK ( 0x3 ) -#define TD_STATUS_LOW_SPEED_FLAG ( 1 << 26 ) -#define TD_STATUS_ISOCHRONOUS_FLAG ( 1 << 25 ) -#define TD_STATUS_IOC_FLAG ( 1 << 24 ) - -#define TD_STATUS_ERROR_ACTIVE ( 1 << 23 ) -#define TD_STATUS_ERROR_STALLED ( 1 << 22 ) -#define TD_STATUS_ERROR_BUFFER ( 1 << 21 ) -#define TD_STATUS_ERROR_BABBLE ( 1 << 20 ) -#define TD_STATUS_ERROR_NAK ( 1 << 19 ) -#define TD_STATUS_ERROR_CRC ( 1 << 18 ) -#define TD_STATUS_ERROR_BIT_STUFF ( 1 << 17 ) -#define TD_STATUS_ERROR_RESERVED ( 1 << 16 ) -#define TD_STATUS_ERROR_POS 16 -#define TD_STATUS_ERROR_MASK ( 0xff ) - -#define TD_STATUS_ACTLEN_POS 0 -#define TD_STATUS_ACTLEN_MASK 0x7ff - - volatile uint32_t device; -#define TD_DEVICE_MAXLEN_POS 21 -#define TD_DEVICE_MAXLEN_MASK ( 0x7ff ) -#define TD_DEVICE_RESERVED_FLAG ( 1 << 20 ) -#define TD_DEVICE_DATA_TOGGLE_ONE_FLAG ( 1 << 19 ) -#define TD_DEVICE_ENDPOINT_POS 15 -#define TD_DEVICE_ENDPOINT_MASK ( 0xf ) -#define TD_DEVICE_ADDRESS_POS 8 -#define TD_DEVICE_ADDRESS_MASK ( 0x7f ) -#define TD_DEVICE_PID_POS 0 -#define TD_DEVICE_PID_MASK ( 0xff ) - - volatile uint32_t buffer_ptr; - - /* there is 16 bytes of data available here, according to UHCI - * Design guide, according to linux kernel the hardware does not care, - * it just needs to be aligned, we don't use it anyway - */ -} __attribute__((packed)) td_t; - - -void td_init(td_t *instance, int error_count, size_t size, bool toggle, - bool iso, bool low_speed, usb_target_t target, usb_packet_id pid, - void *buffer, td_t *next); - -int td_status(td_t *instance); - -void td_print_status(td_t *instance); -/*----------------------------------------------------------------------------*/ -/** Helper function for parsing actual size out of TD. - * - * @param[in] instance TD structure to use. - * @return Parsed actual size. - */ -static inline size_t td_act_size(td_t *instance) -{ - assert(instance); - const uint32_t s = instance->status; - return ((s >> TD_STATUS_ACTLEN_POS) + 1) & TD_STATUS_ACTLEN_MASK; -} -/*----------------------------------------------------------------------------*/ -/** Check whether less than max data were recieved and packet is marked as SPD. - * - * @param[in] instance TD structure to use. - * @return True if packet is short (less than max bytes and SPD set), false - * otherwise. - */ -static inline bool td_is_short(td_t *instance) -{ - const size_t act_size = td_act_size(instance); - const size_t max_size = - ((instance->device >> TD_DEVICE_MAXLEN_POS) + 1) - & TD_DEVICE_MAXLEN_MASK; - return - (instance->status | TD_STATUS_SPD_FLAG) && act_size < max_size; -} -/*----------------------------------------------------------------------------*/ -/** Helper function for parsing value of toggle bit. - * - * @param[in] instance TD structure to use. - * @return Toggle bit value. - */ -static inline int td_toggle(td_t *instance) -{ - assert(instance); - return (instance->device & TD_DEVICE_DATA_TOGGLE_ONE_FLAG) ? 1 : 0; -} -/*----------------------------------------------------------------------------*/ -/** Helper function for parsing value of active bit - * - * @param[in] instance TD structure to use. - * @return Active bit value. - */ -static inline bool td_is_active(td_t *instance) -{ - assert(instance); - return (instance->status & TD_STATUS_ERROR_ACTIVE) != 0; -} -/*----------------------------------------------------------------------------*/ -/** Helper function for setting IOC bit. - * - * @param[in] instance TD structure to use. - */ -static inline void td_set_ioc(td_t *instance) -{ - assert(instance); - instance->status |= TD_STATUS_IOC_FLAG; -} -/*----------------------------------------------------------------------------*/ -#endif -/** - * @} - */