| 1 | /*
|
|---|
| 2 | * Copyright (c) 2013 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 | /** @addtogroup drvusbohci
|
|---|
| 29 | * @{
|
|---|
| 30 | */
|
|---|
| 31 | /** @file
|
|---|
| 32 | * @brief OHCI driver
|
|---|
| 33 | */
|
|---|
| 34 | #ifndef DRV_OHCI_OHCI_RH_H
|
|---|
| 35 | #define DRV_OHCI_OHCI_RH_H
|
|---|
| 36 |
|
|---|
| 37 | #include <usb/usb.h>
|
|---|
| 38 | #include <usb/classes/hub.h>
|
|---|
| 39 | #include <usb/host/usb_transfer_batch.h>
|
|---|
| 40 | #include <usbvirt/virthub_base.h>
|
|---|
| 41 |
|
|---|
| 42 | #include "ohci_regs.h"
|
|---|
| 43 |
|
|---|
| 44 | enum {
|
|---|
| 45 | OHCI_MAX_PORTS = 15,
|
|---|
| 46 | };
|
|---|
| 47 |
|
|---|
| 48 | typedef struct {
|
|---|
| 49 | /** Virtual hub instance */
|
|---|
| 50 | virthub_base_t base;
|
|---|
| 51 | /** OHCI device registers */
|
|---|
| 52 | ohci_regs_t *registers;
|
|---|
| 53 | /** Number of downstream ports, OHCI limits this to 15 */
|
|---|
| 54 | unsigned port_count;
|
|---|
| 55 | /** USB hub descriptor describing the OHCI root hub */
|
|---|
| 56 | struct {
|
|---|
| 57 | usb_hub_descriptor_header_t header;
|
|---|
| 58 | uint8_t rempow[STATUS_BYTES(OHCI_MAX_PORTS) * 2];
|
|---|
| 59 | } __attribute__((packed)) hub_descriptor;
|
|---|
| 60 | /** interrupt transfer waiting for an actual interrupt to occur */
|
|---|
| 61 | usb_transfer_batch_t *unfinished_interrupt_transfer;
|
|---|
| 62 | } ohci_rh_t;
|
|---|
| 63 |
|
|---|
| 64 | int ohci_rh_init(ohci_rh_t *instance, ohci_regs_t *regs, const char *name);
|
|---|
| 65 | int ohci_rh_schedule(ohci_rh_t *instance, usb_transfer_batch_t *batch);
|
|---|
| 66 | int ohci_rh_interrupt(ohci_rh_t *instance);
|
|---|
| 67 |
|
|---|
| 68 | /** Get OHCI rh address.
|
|---|
| 69 | *
|
|---|
| 70 | * @param instance UHCI rh instance.
|
|---|
| 71 | * @return USB address assigned to the hub.
|
|---|
| 72 | * Wrapper for virtual hub address
|
|---|
| 73 | */
|
|---|
| 74 | static inline usb_address_t ohci_rh_get_address(ohci_rh_t *instance)
|
|---|
| 75 | {
|
|---|
| 76 | assert(instance);
|
|---|
| 77 | return virthub_base_get_address(&instance->base);
|
|---|
| 78 | }
|
|---|
| 79 | #endif
|
|---|
| 80 | /**
|
|---|
| 81 | * @}
|
|---|
| 82 | */
|
|---|
