| 1 | /*
|
|---|
| 2 | * Copyright (c) 2011 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_ROOT_HUB_H
|
|---|
| 35 | #define DRV_OHCI_ROOT_HUB_H
|
|---|
| 36 |
|
|---|
| 37 | #include <usb/usb.h>
|
|---|
| 38 | #include <usb/dev/driver.h>
|
|---|
| 39 |
|
|---|
| 40 | #include "ohci_regs.h"
|
|---|
| 41 | #include "batch.h"
|
|---|
| 42 |
|
|---|
| 43 | #define HUB_DESCRIPTOR_MAX_SIZE (7 + 2 + 2)
|
|---|
| 44 | #define INTERRUPT_BUFFER_MAX_SIZE 2
|
|---|
| 45 |
|
|---|
| 46 | /**
|
|---|
| 47 | * ohci root hub representation
|
|---|
| 48 | */
|
|---|
| 49 | typedef struct rh {
|
|---|
| 50 | /** pointer to ohci driver registers */
|
|---|
| 51 | ohci_regs_t *registers;
|
|---|
| 52 | /** usb address of the root hub */
|
|---|
| 53 | usb_address_t address;
|
|---|
| 54 | /** hub port count */
|
|---|
| 55 | size_t port_count;
|
|---|
| 56 | /** interrupt transfer waiting for an actual interrupt to occur */
|
|---|
| 57 | usb_transfer_batch_t *unfinished_interrupt_transfer;
|
|---|
| 58 | /** Interrupt mask of changes
|
|---|
| 59 | *
|
|---|
| 60 | * OHCI support max 15 ports (specs page 124) + one global bit, it
|
|---|
| 61 | * gives max 2 bytes.
|
|---|
| 62 | */
|
|---|
| 63 | uint8_t interrupt_buffer[INTERRUPT_BUFFER_MAX_SIZE];
|
|---|
| 64 | /** size of interrupt buffer */
|
|---|
| 65 | size_t interrupt_mask_size;
|
|---|
| 66 |
|
|---|
| 67 | /** Descriptors */
|
|---|
| 68 | struct {
|
|---|
| 69 | usb_standard_configuration_descriptor_t configuration;
|
|---|
| 70 | usb_standard_interface_descriptor_t interface;
|
|---|
| 71 | usb_standard_endpoint_descriptor_t endpoint;
|
|---|
| 72 | uint8_t hub[HUB_DESCRIPTOR_MAX_SIZE];
|
|---|
| 73 | } __attribute__ ((packed)) descriptors;
|
|---|
| 74 | /** size of hub descriptor */
|
|---|
| 75 | size_t hub_descriptor_size;
|
|---|
| 76 |
|
|---|
| 77 | } rh_t;
|
|---|
| 78 |
|
|---|
| 79 | void rh_init(rh_t *instance, ohci_regs_t *regs);
|
|---|
| 80 |
|
|---|
| 81 | int rh_request(rh_t *instance, usb_transfer_batch_t *request);
|
|---|
| 82 |
|
|---|
| 83 | void rh_interrupt(rh_t *instance);
|
|---|
| 84 | #endif
|
|---|
| 85 | /**
|
|---|
| 86 | * @}
|
|---|
| 87 | */
|
|---|
