| 1 | /*
|
|---|
| 2 | * Copyright (c) 2010 Jan Vesely
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup drvusbuhci
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * @brief UHCI driver
|
|---|
| 34 | */
|
|---|
| 35 | #ifndef DRV_UHCI_UHCI_H
|
|---|
| 36 | #define DRV_UHCI_UHCI_H
|
|---|
| 37 |
|
|---|
| 38 | #include <fibril.h>
|
|---|
| 39 |
|
|---|
| 40 | #include <usb/addrkeep.h>
|
|---|
| 41 | #include <usbhc_iface.h>
|
|---|
| 42 |
|
|---|
| 43 | #include "transfer_list.h"
|
|---|
| 44 |
|
|---|
| 45 | typedef struct uhci_regs {
|
|---|
| 46 | uint16_t usbcmd;
|
|---|
| 47 | #define UHCI_CMD_MAX_PACKET (1 << 7)
|
|---|
| 48 | #define UHCI_CMD_CONFIGURE (1 << 6)
|
|---|
| 49 | #define UHCI_CMD_DEBUG (1 << 5)
|
|---|
| 50 | #define UHCI_CMD_FORCE_GLOBAL_RESUME (1 << 4)
|
|---|
| 51 | #define UHCI_CMD_FORCE_GLOBAL_SUSPEND (1 << 3)
|
|---|
| 52 | #define UHCI_CMD_GLOBAL_RESET (1 << 2)
|
|---|
| 53 | #define UHCI_CMD_HCRESET (1 << 1)
|
|---|
| 54 | #define UHCI_CMD_RUN_STOP (1 << 0)
|
|---|
| 55 |
|
|---|
| 56 | uint16_t usbsts;
|
|---|
| 57 | #define UHCI_STATUS_HALTED (1 << 5)
|
|---|
| 58 | #define UHCI_STATUS_PROCESS_ERROR (1 << 4)
|
|---|
| 59 | #define UHCI_STATUS_SYSTEM_ERROR (1 << 3)
|
|---|
| 60 | #define UHCI_STATUS_RESUME (1 << 2)
|
|---|
| 61 | #define UHCI_STATUS_ERROR_INTERRUPT (1 << 1)
|
|---|
| 62 | #define UHCI_STATUS_INTERRUPT (1 << 0)
|
|---|
| 63 |
|
|---|
| 64 | uint16_t usbintr;
|
|---|
| 65 | uint16_t frnum;
|
|---|
| 66 | uint32_t flbaseadd;
|
|---|
| 67 | uint8_t sofmod;
|
|---|
| 68 | } regs_t;
|
|---|
| 69 |
|
|---|
| 70 | #define TRANSFER_QUEUES 4
|
|---|
| 71 | #define UHCI_FRAME_LIST_COUNT 1024
|
|---|
| 72 | #define UHCI_CLEANER_TIMEOUT 1000000
|
|---|
| 73 | #define UHCI_DEBUGER_TIMEOUT 500000
|
|---|
| 74 |
|
|---|
| 75 | typedef struct uhci {
|
|---|
| 76 | usb_address_keeping_t address_manager;
|
|---|
| 77 | volatile regs_t *registers;
|
|---|
| 78 |
|
|---|
| 79 | link_pointer_t *frame_list;
|
|---|
| 80 |
|
|---|
| 81 | transfer_list_t transfers[TRANSFER_QUEUES];
|
|---|
| 82 | fid_t cleaner;
|
|---|
| 83 | fid_t debug_checker;
|
|---|
| 84 | } uhci_t;
|
|---|
| 85 |
|
|---|
| 86 | /* init uhci specifics in device.driver_data */
|
|---|
| 87 | int uhci_init(uhci_t *instance, void *regs, size_t reg_size);
|
|---|
| 88 |
|
|---|
| 89 | int uhci_fini(uhci_t *device);
|
|---|
| 90 |
|
|---|
| 91 | int uhci_transfer(
|
|---|
| 92 | uhci_t *instance,
|
|---|
| 93 | device_t *dev,
|
|---|
| 94 | usb_target_t target,
|
|---|
| 95 | usb_transfer_type_t transfer_type,
|
|---|
| 96 | bool toggle,
|
|---|
| 97 | usb_packet_id pid,
|
|---|
| 98 | void *buffer, size_t size,
|
|---|
| 99 | usbhc_iface_transfer_out_callback_t callback_out,
|
|---|
| 100 | usbhc_iface_transfer_in_callback_t callback_in,
|
|---|
| 101 | void *arg );
|
|---|
| 102 |
|
|---|
| 103 | static inline uhci_t * dev_to_uhci(device_t *dev)
|
|---|
| 104 | { return (uhci_t*)dev->driver_data; }
|
|---|
| 105 |
|
|---|
| 106 | #endif
|
|---|
| 107 | /**
|
|---|
| 108 | * @}
|
|---|
| 109 | */
|
|---|
