| 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 host controller driver structure
|
|---|
| 33 | */
|
|---|
| 34 | #ifndef DRV_OHCI_HC_H
|
|---|
| 35 | #define DRV_OHCI_HC_H
|
|---|
| 36 |
|
|---|
| 37 | #include <fibril.h>
|
|---|
| 38 | #include <fibril_synch.h>
|
|---|
| 39 | #include <adt/list.h>
|
|---|
| 40 | #include <ddi.h>
|
|---|
| 41 |
|
|---|
| 42 | #include <usb/usb.h>
|
|---|
| 43 | #include <usb/host/hcd.h>
|
|---|
| 44 |
|
|---|
| 45 | #include "ohci_batch.h"
|
|---|
| 46 | #include "ohci_regs.h"
|
|---|
| 47 | #include "root_hub.h"
|
|---|
| 48 | #include "endpoint_list.h"
|
|---|
| 49 | #include "hw_struct/hcca.h"
|
|---|
| 50 |
|
|---|
| 51 | /** Main OHCI driver structure */
|
|---|
| 52 | typedef struct hc {
|
|---|
| 53 | /** Generic USB hc driver */
|
|---|
| 54 | hcd_t generic;
|
|---|
| 55 |
|
|---|
| 56 | /** Memory mapped I/O registers area */
|
|---|
| 57 | ohci_regs_t *registers;
|
|---|
| 58 | /** Host controller communication area structure */
|
|---|
| 59 | hcca_t *hcca;
|
|---|
| 60 |
|
|---|
| 61 | /** Transfer schedules */
|
|---|
| 62 | endpoint_list_t lists[4];
|
|---|
| 63 | /** List of active transfers */
|
|---|
| 64 | list_t pending_batches;
|
|---|
| 65 |
|
|---|
| 66 | /** Fibril for periodic checks if interrupts can't be used */
|
|---|
| 67 | fid_t interrupt_emulator;
|
|---|
| 68 |
|
|---|
| 69 | /** Guards schedule and endpoint manipulation */
|
|---|
| 70 | fibril_mutex_t guard;
|
|---|
| 71 |
|
|---|
| 72 | /** USB hub emulation structure */
|
|---|
| 73 | rh_t rh;
|
|---|
| 74 | } hc_t;
|
|---|
| 75 |
|
|---|
| 76 | size_t hc_irq_cmd_count(void);
|
|---|
| 77 | int hc_get_irq_commands(
|
|---|
| 78 | irq_cmd_t cmds[], size_t cmd_size, uintptr_t regs, size_t reg_size);
|
|---|
| 79 | int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun);
|
|---|
| 80 | int hc_init(hc_t *instance, uintptr_t regs, size_t reg_size, bool interrupts);
|
|---|
| 81 |
|
|---|
| 82 | /** Safely dispose host controller internal structures
|
|---|
| 83 | *
|
|---|
| 84 | * @param[in] instance Host controller structure to use.
|
|---|
| 85 | */
|
|---|
| 86 | static inline void hc_fini(hc_t *instance) { /* TODO: implement*/ };
|
|---|
| 87 |
|
|---|
| 88 | void hc_enqueue_endpoint(hc_t *instance, endpoint_t *ep);
|
|---|
| 89 | void hc_dequeue_endpoint(hc_t *instance, endpoint_t *ep);
|
|---|
| 90 |
|
|---|
| 91 | void hc_interrupt(hc_t *instance, uint32_t status);
|
|---|
| 92 | #endif
|
|---|
| 93 | /**
|
|---|
| 94 | * @}
|
|---|
| 95 | */
|
|---|
