sys/bus/u4b/controller/ohci.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to The NetBSD Foundation
   7  * by Lennart Augustsson (lennart@augustsson.net) at
   8  * Carlstedt Research & Technology.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _OHCI_H_
  33 #define _OHCI_H_
  34
  35 #define OHCI_MAX_DEVICES MIN(USB_MAX_DEVICES, 128)
  36
  37 #define OHCI_NO_INTRS           32
  38 #define OHCI_HCCA_SIZE          256
  39
  40 /* Structures alignment (bytes) */
  41 #define OHCI_HCCA_ALIGN         256
  42 #define OHCI_ED_ALIGN           16
  43 #define OHCI_TD_ALIGN           16
  44 #define OHCI_ITD_ALIGN          32
  45
  46 #define OHCI_PAGE_SIZE          0x1000
  47 #define OHCI_PAGE(x)            ((x) &~ 0xfff)
  48 #define OHCI_PAGE_OFFSET(x)     ((x) & 0xfff)
  49 #define OHCI_PAGE_MASK(x)       ((x) & 0xfff)
  50
  51 #if     ((USB_PAGE_SIZE < OHCI_ED_ALIGN) || (OHCI_ED_ALIGN == 0) ||     \
  52         (USB_PAGE_SIZE < OHCI_TD_ALIGN) || (OHCI_TD_ALIGN == 0) ||      \
  53         (USB_PAGE_SIZE < OHCI_ITD_ALIGN) || (OHCI_ITD_ALIGN == 0) ||    \
  54         (USB_PAGE_SIZE < OHCI_PAGE_SIZE) || (OHCI_PAGE_SIZE == 0))
  55 #error  "Invalid USB page size!"
  56 #endif
  57
  58 #define OHCI_VIRTUAL_FRAMELIST_COUNT 128/* dummy */
  59
  60 #if (OHCI_VIRTUAL_FRAMELIST_COUNT < USB_MAX_FS_ISOC_FRAMES_PER_XFER)
  61 #error "maximum number of full-speed isochronous frames is higher than supported!"
  62 #endif
  63
  64 struct ohci_hcca {
  65         volatile uint32_t hcca_interrupt_table[OHCI_NO_INTRS];
  66         volatile uint32_t hcca_frame_number;
  67         volatile uint32_t hcca_done_head;
  68 #define OHCI_DONE_INTRS         1
  69 } __aligned(OHCI_HCCA_ALIGN);
  70
  71 typedef struct ohci_hcca ohci_hcca_t;
  72
  73 struct ohci_ed {
  74         volatile uint32_t ed_flags;
  75 #define OHCI_ED_GET_FA(s)       ((s) & 0x7f)
  76 #define OHCI_ED_ADDRMASK        0x0000007f
  77 #define OHCI_ED_SET_FA(s)       (s)
  78 #define OHCI_ED_GET_EN(s)       (((s) >> 7) & 0xf)
  79 #define OHCI_ED_SET_EN(s)       ((s) << 7)
  80 #define OHCI_ED_DIR_MASK        0x00001800
  81 #define OHCI_ED_DIR_TD          0x00000000
  82 #define OHCI_ED_DIR_OUT         0x00000800
  83 #define OHCI_ED_DIR_IN          0x00001000
  84 #define OHCI_ED_SPEED           0x00002000
  85 #define OHCI_ED_SKIP            0x00004000
  86 #define OHCI_ED_FORMAT_GEN      0x00000000
  87 #define OHCI_ED_FORMAT_ISO      0x00008000
  88 #define OHCI_ED_GET_MAXP(s)     (((s) >> 16) & 0x07ff)
  89 #define OHCI_ED_SET_MAXP(s)     ((s) << 16)
  90 #define OHCI_ED_MAXPMASK        (0x7ff << 16)
  91         volatile uint32_t ed_tailp;
  92         volatile uint32_t ed_headp;
  93 #define OHCI_HALTED             0x00000001
  94 #define OHCI_TOGGLECARRY        0x00000002
  95 #define OHCI_HEADMASK           0xfffffffc
  96         volatile uint32_t ed_next;
  97 /*
  98  * Extra information needed:
  99  */
 100         struct ohci_ed *next;
 101         struct ohci_ed *prev;
 102         struct ohci_ed *obj_next;
 103         struct usb_page_cache *page_cache;
 104         uint32_t ed_self;
 105 } __aligned(OHCI_ED_ALIGN);
 106
 107 typedef struct ohci_ed ohci_ed_t;
 108
 109 struct ohci_td {
 110         volatile uint32_t td_flags;
 111 #define OHCI_TD_R               0x00040000      /* Buffer Rounding  */
 112 #define OHCI_TD_DP_MASK         0x00180000      /* Direction / PID */
 113 #define OHCI_TD_SETUP           0x00000000
 114 #define OHCI_TD_OUT             0x00080000
 115 #define OHCI_TD_IN              0x00100000
 116 #define OHCI_TD_GET_DI(x)       (((x) >> 21) & 7)       /* Delay Interrupt */
 117 #define OHCI_TD_SET_DI(x)       ((x) << 21)
 118 #define OHCI_TD_NOINTR          0x00e00000
 119 #define OHCI_TD_INTR_MASK       0x00e00000
 120 #define OHCI_TD_TOGGLE_CARRY    0x00000000
 121 #define OHCI_TD_TOGGLE_0        0x02000000
 122 #define OHCI_TD_TOGGLE_1        0x03000000
 123 #define OHCI_TD_TOGGLE_MASK     0x03000000
 124 #define OHCI_TD_GET_EC(x)       (((x) >> 26) & 3)       /* Error Count */
 125 #define OHCI_TD_GET_CC(x)       ((x) >> 28)     /* Condition Code */
 126 #define OHCI_TD_SET_CC(x)       ((x) << 28)
 127 #define OHCI_TD_NOCC            0xf0000000
 128         volatile uint32_t td_cbp;       /* Current Buffer Pointer */
 129         volatile uint32_t td_next;      /* Next TD */
 130 #define OHCI_TD_NEXT_END        0
 131         volatile uint32_t td_be;        /* Buffer End */
 132 /*
 133  * Extra information needed:
 134  */
 135         struct ohci_td *obj_next;
 136         struct ohci_td *alt_next;
 137         struct usb_page_cache *page_cache;
 138         uint32_t td_self;
 139         uint16_t len;
 140 } __aligned(OHCI_TD_ALIGN);
 141
 142 typedef struct ohci_td ohci_td_t;
 143
 144 struct ohci_itd {
 145         volatile uint32_t itd_flags;
 146 #define OHCI_ITD_GET_SF(x)      ((x) & 0x0000ffff)
 147 #define OHCI_ITD_SET_SF(x)      ((x) & 0xffff)
 148 #define OHCI_ITD_GET_DI(x)      (((x) >> 21) & 7)       /* Delay Interrupt */
 149 #define OHCI_ITD_SET_DI(x)      ((x) << 21)
 150 #define OHCI_ITD_NOINTR         0x00e00000
 151 #define OHCI_ITD_GET_FC(x)      ((((x) >> 24) & 7)+1)   /* Frame Count */
 152 #define OHCI_ITD_SET_FC(x)      (((x)-1) << 24)
 153 #define OHCI_ITD_GET_CC(x)      ((x) >> 28)     /* Condition Code */
 154 #define OHCI_ITD_NOCC           0xf0000000
 155 #define OHCI_ITD_NOFFSET        8
 156         volatile uint32_t itd_bp0;      /* Buffer Page 0 */
 157         volatile uint32_t itd_next;     /* Next ITD */
 158         volatile uint32_t itd_be;       /* Buffer End */
 159         volatile uint16_t itd_offset[OHCI_ITD_NOFFSET]; /* Buffer offsets and
 160                                                          * Status */
 161 #define OHCI_ITD_PAGE_SELECT    0x00001000
 162 #define OHCI_ITD_MK_OFFS(len)   (0xe000 | ((len) & 0x1fff))
 163 #define OHCI_ITD_PSW_LENGTH(x)  ((x) & 0xfff)   /* Transfer length */
 164 #define OHCI_ITD_PSW_GET_CC(x)  ((x) >> 12)     /* Condition Code */
 165 /*
 166  * Extra information needed:
 167  */
 168         struct ohci_itd *obj_next;
 169         struct usb_page_cache *page_cache;
 170         uint32_t itd_self;
 171         uint8_t frames;
 172 } __aligned(OHCI_ITD_ALIGN);
 173
 174 typedef struct ohci_itd ohci_itd_t;
 175
 176 #define OHCI_CC_NO_ERROR                0
 177 #define OHCI_CC_CRC                     1
 178 #define OHCI_CC_BIT_STUFFING            2
 179 #define OHCI_CC_DATA_TOGGLE_MISMATCH    3
 180 #define OHCI_CC_STALL                   4
 181 #define OHCI_CC_DEVICE_NOT_RESPONDING   5
 182 #define OHCI_CC_PID_CHECK_FAILURE       6
 183 #define OHCI_CC_UNEXPECTED_PID          7
 184 #define OHCI_CC_DATA_OVERRUN            8
 185 #define OHCI_CC_DATA_UNDERRUN           9
 186 #define OHCI_CC_BUFFER_OVERRUN          12
 187 #define OHCI_CC_BUFFER_UNDERRUN         13
 188 #define OHCI_CC_NOT_ACCESSED            15
 189
 190 /* Some delay needed when changing certain registers. */
 191 #define OHCI_ENABLE_POWER_DELAY         5
 192 #define OHCI_READ_DESC_DELAY            5
 193
 194 #define OHCI_NO_EDS                     (2*OHCI_NO_INTRS)
 195
 196 struct ohci_hw_softc {
 197         struct usb_page_cache hcca_pc;
 198         struct usb_page_cache ctrl_start_pc;
 199         struct usb_page_cache bulk_start_pc;
 200         struct usb_page_cache isoc_start_pc;
 201         struct usb_page_cache intr_start_pc[OHCI_NO_EDS];
 202
 203         struct usb_page hcca_pg;
 204         struct usb_page ctrl_start_pg;
 205         struct usb_page bulk_start_pg;
 206         struct usb_page isoc_start_pg;
 207         struct usb_page intr_start_pg[OHCI_NO_EDS];
 208 };
 209
 210 struct ohci_config_desc {
 211         struct usb_config_descriptor confd;
 212         struct usb_interface_descriptor ifcd;
 213         struct usb_endpoint_descriptor endpd;
 214 } __packed;
 215
 216 union ohci_hub_desc {
 217         struct usb_status stat;
 218         struct usb_port_status ps;
 219         struct usb_hub_descriptor hubd;
 220         uint8_t temp[128];
 221 };
 222
 223 typedef struct ohci_softc {
 224         struct ohci_hw_softc sc_hw;
 225         struct usb_bus sc_bus;          /* base device */
 226         struct usb_callout sc_tmo_rhsc;
 227         union ohci_hub_desc sc_hub_desc;
 228
 229         struct usb_device *sc_devices[OHCI_MAX_DEVICES];
 230         struct resource *sc_io_res;
 231         struct resource *sc_irq_res;
 232         struct ohci_hcca *sc_hcca_p;
 233         struct ohci_ed *sc_ctrl_p_last;
 234         struct ohci_ed *sc_bulk_p_last;
 235         struct ohci_ed *sc_isoc_p_last;
 236         struct ohci_ed *sc_intr_p_last[OHCI_NO_EDS];
 237         void   *sc_intr_hdl;
 238         device_t sc_dev;
 239         bus_size_t sc_io_size;
 240         bus_space_tag_t sc_io_tag;
 241         bus_space_handle_t sc_io_hdl;
 242
 243         uint32_t sc_eintrs;             /* enabled interrupts */
 244
 245         uint16_t sc_intr_stat[OHCI_NO_EDS];
 246         uint16_t sc_id_vendor;
 247
 248         uint8_t sc_noport;
 249         uint8_t sc_addr;                /* device address */
 250         uint8_t sc_conf;                /* device configuration */
 251         uint8_t sc_hub_idata[32];
 252
 253         char    sc_vendor[16];
 254
 255 } ohci_softc_t;
 256
 257 usb_bus_mem_cb_t ohci_iterate_hw_softc;
 258
 259 usb_error_t ohci_init(ohci_softc_t *sc);
 260 void    ohci_detach(struct ohci_softc *sc);
 261 void    ohci_interrupt(ohci_softc_t *sc);
 262
 263 #endif                                  /* _OHCI_H_ */