112bd3c8bSSascha Wildner /* $FreeBSD$ */
212bd3c8bSSascha Wildner /*-
312bd3c8bSSascha Wildner * Copyright (c) 2001 The NetBSD Foundation, Inc.
412bd3c8bSSascha Wildner * All rights reserved.
512bd3c8bSSascha Wildner *
612bd3c8bSSascha Wildner * This code is derived from software contributed to The NetBSD Foundation
712bd3c8bSSascha Wildner * by Lennart Augustsson (lennart@augustsson.net).
812bd3c8bSSascha Wildner *
912bd3c8bSSascha Wildner * Redistribution and use in source and binary forms, with or without
1012bd3c8bSSascha Wildner * modification, are permitted provided that the following conditions
1112bd3c8bSSascha Wildner * are met:
1212bd3c8bSSascha Wildner * 1. Redistributions of source code must retain the above copyright
1312bd3c8bSSascha Wildner * notice, this list of conditions and the following disclaimer.
1412bd3c8bSSascha Wildner * 2. Redistributions in binary form must reproduce the above copyright
1512bd3c8bSSascha Wildner * notice, this list of conditions and the following disclaimer in the
1612bd3c8bSSascha Wildner * documentation and/or other materials provided with the distribution.
1712bd3c8bSSascha Wildner *
1812bd3c8bSSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
1912bd3c8bSSascha Wildner * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
2012bd3c8bSSascha Wildner * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
2112bd3c8bSSascha Wildner * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
2212bd3c8bSSascha Wildner * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2312bd3c8bSSascha Wildner * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2412bd3c8bSSascha Wildner * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2512bd3c8bSSascha Wildner * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2612bd3c8bSSascha Wildner * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2712bd3c8bSSascha Wildner * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2812bd3c8bSSascha Wildner * POSSIBILITY OF SUCH DAMAGE.
2912bd3c8bSSascha Wildner */
3012bd3c8bSSascha Wildner
3112bd3c8bSSascha Wildner #ifndef _EHCI_H_
3212bd3c8bSSascha Wildner #define _EHCI_H_
3312bd3c8bSSascha Wildner
3412bd3c8bSSascha Wildner #define EHCI_MAX_DEVICES MIN(USB_MAX_DEVICES, 128)
3512bd3c8bSSascha Wildner
3612bd3c8bSSascha Wildner /*
3712bd3c8bSSascha Wildner * Alignment NOTE: structures must be aligned so that the hardware can index
3812bd3c8bSSascha Wildner * without performing addition.
3912bd3c8bSSascha Wildner */
4012bd3c8bSSascha Wildner #define EHCI_FRAMELIST_ALIGN 0x1000 /* bytes */
4112bd3c8bSSascha Wildner #define EHCI_FRAMELIST_COUNT 1024 /* units */
4212bd3c8bSSascha Wildner #define EHCI_VIRTUAL_FRAMELIST_COUNT 128 /* units */
4312bd3c8bSSascha Wildner
4412bd3c8bSSascha Wildner #if ((8*EHCI_VIRTUAL_FRAMELIST_COUNT) < USB_MAX_HS_ISOC_FRAMES_PER_XFER)
4512bd3c8bSSascha Wildner #error "maximum number of high-speed isochronous frames is higher than supported!"
4612bd3c8bSSascha Wildner #endif
4712bd3c8bSSascha Wildner
4812bd3c8bSSascha Wildner #if (EHCI_VIRTUAL_FRAMELIST_COUNT < USB_MAX_FS_ISOC_FRAMES_PER_XFER)
4912bd3c8bSSascha Wildner #error "maximum number of full-speed isochronous frames is higher than supported!"
5012bd3c8bSSascha Wildner #endif
5112bd3c8bSSascha Wildner
5212bd3c8bSSascha Wildner /* Link types */
5312bd3c8bSSascha Wildner #define EHCI_LINK_TERMINATE 0x00000001
5412bd3c8bSSascha Wildner #define EHCI_LINK_TYPE(x) ((x) & 0x00000006)
5512bd3c8bSSascha Wildner #define EHCI_LINK_ITD 0x0
5612bd3c8bSSascha Wildner #define EHCI_LINK_QH 0x2
5712bd3c8bSSascha Wildner #define EHCI_LINK_SITD 0x4
5812bd3c8bSSascha Wildner #define EHCI_LINK_FSTN 0x6
5912bd3c8bSSascha Wildner #define EHCI_LINK_ADDR(x) ((x) &~ 0x1f)
6012bd3c8bSSascha Wildner
6112bd3c8bSSascha Wildner /* Structures alignment (bytes) */
6212bd3c8bSSascha Wildner #define EHCI_ITD_ALIGN 128
6312bd3c8bSSascha Wildner #define EHCI_SITD_ALIGN 64
6412bd3c8bSSascha Wildner #define EHCI_QTD_ALIGN 64
6512bd3c8bSSascha Wildner #define EHCI_QH_ALIGN 128
6612bd3c8bSSascha Wildner #define EHCI_FSTN_ALIGN 32
6712bd3c8bSSascha Wildner /* Data buffers are divided into one or more pages */
6812bd3c8bSSascha Wildner #define EHCI_PAGE_SIZE 0x1000
6912bd3c8bSSascha Wildner #if ((USB_PAGE_SIZE < EHCI_PAGE_SIZE) || (EHCI_PAGE_SIZE == 0) || \
7012bd3c8bSSascha Wildner (USB_PAGE_SIZE < EHCI_ITD_ALIGN) || (EHCI_ITD_ALIGN == 0) || \
7112bd3c8bSSascha Wildner (USB_PAGE_SIZE < EHCI_SITD_ALIGN) || (EHCI_SITD_ALIGN == 0) || \
7212bd3c8bSSascha Wildner (USB_PAGE_SIZE < EHCI_QTD_ALIGN) || (EHCI_QTD_ALIGN == 0) || \
7312bd3c8bSSascha Wildner (USB_PAGE_SIZE < EHCI_QH_ALIGN) || (EHCI_QH_ALIGN == 0) || \
7412bd3c8bSSascha Wildner (USB_PAGE_SIZE < EHCI_FSTN_ALIGN) || (EHCI_FSTN_ALIGN == 0))
7512bd3c8bSSascha Wildner #error "Invalid USB page size!"
7612bd3c8bSSascha Wildner #endif
7712bd3c8bSSascha Wildner
7812bd3c8bSSascha Wildner
7912bd3c8bSSascha Wildner /*
8012bd3c8bSSascha Wildner * Isochronous Transfer Descriptor. This descriptor is used for high speed
8112bd3c8bSSascha Wildner * transfers only.
8212bd3c8bSSascha Wildner */
8312bd3c8bSSascha Wildner struct ehci_itd {
8412bd3c8bSSascha Wildner volatile uint32_t itd_next;
8512bd3c8bSSascha Wildner volatile uint32_t itd_status[8];
8612bd3c8bSSascha Wildner #define EHCI_ITD_SET_LEN(x) ((x) << 16)
8712bd3c8bSSascha Wildner #define EHCI_ITD_GET_LEN(x) (((x) >> 16) & 0xFFF)
8812bd3c8bSSascha Wildner #define EHCI_ITD_IOC (1 << 15)
8912bd3c8bSSascha Wildner #define EHCI_ITD_SET_PG(x) ((x) << 12)
9012bd3c8bSSascha Wildner #define EHCI_ITD_GET_PG(x) (((x) >> 12) & 0x7)
9112bd3c8bSSascha Wildner #define EHCI_ITD_SET_OFFS(x) (x)
9212bd3c8bSSascha Wildner #define EHCI_ITD_GET_OFFS(x) (((x) >> 0) & 0xFFF)
93432d6d1aSMarkus Pfeiffer #define EHCI_ITD_ACTIVE (1U << 31)
9412bd3c8bSSascha Wildner #define EHCI_ITD_DATABUFERR (1 << 30)
9512bd3c8bSSascha Wildner #define EHCI_ITD_BABBLE (1 << 29)
9612bd3c8bSSascha Wildner #define EHCI_ITD_XACTERR (1 << 28)
9712bd3c8bSSascha Wildner volatile uint32_t itd_bp[7];
9812bd3c8bSSascha Wildner /* itd_bp[0] */
9912bd3c8bSSascha Wildner #define EHCI_ITD_SET_ADDR(x) (x)
10012bd3c8bSSascha Wildner #define EHCI_ITD_GET_ADDR(x) (((x) >> 0) & 0x7F)
10112bd3c8bSSascha Wildner #define EHCI_ITD_SET_ENDPT(x) ((x) << 8)
10212bd3c8bSSascha Wildner #define EHCI_ITD_GET_ENDPT(x) (((x) >> 8) & 0xF)
10312bd3c8bSSascha Wildner /* itd_bp[1] */
10412bd3c8bSSascha Wildner #define EHCI_ITD_SET_DIR_IN (1 << 11)
10512bd3c8bSSascha Wildner #define EHCI_ITD_SET_DIR_OUT (0 << 11)
10612bd3c8bSSascha Wildner #define EHCI_ITD_SET_MPL(x) (x)
10712bd3c8bSSascha Wildner #define EHCI_ITD_GET_MPL(x) (((x) >> 0) & 0x7FF)
10812bd3c8bSSascha Wildner volatile uint32_t itd_bp_hi[7];
10912bd3c8bSSascha Wildner /*
11012bd3c8bSSascha Wildner * Extra information needed:
11112bd3c8bSSascha Wildner */
11212bd3c8bSSascha Wildner uint32_t itd_self;
11312bd3c8bSSascha Wildner struct ehci_itd *next;
11412bd3c8bSSascha Wildner struct ehci_itd *prev;
11512bd3c8bSSascha Wildner struct ehci_itd *obj_next;
11612bd3c8bSSascha Wildner struct usb_page_cache *page_cache;
11712bd3c8bSSascha Wildner } __aligned(EHCI_ITD_ALIGN);
11812bd3c8bSSascha Wildner
11912bd3c8bSSascha Wildner typedef struct ehci_itd ehci_itd_t;
12012bd3c8bSSascha Wildner
12112bd3c8bSSascha Wildner /*
12212bd3c8bSSascha Wildner * Split Transaction Isochronous Transfer Descriptor. This descriptor is used
12312bd3c8bSSascha Wildner * for full speed transfers only.
12412bd3c8bSSascha Wildner */
12512bd3c8bSSascha Wildner struct ehci_sitd {
12612bd3c8bSSascha Wildner volatile uint32_t sitd_next;
12712bd3c8bSSascha Wildner volatile uint32_t sitd_portaddr;
12812bd3c8bSSascha Wildner #define EHCI_SITD_SET_DIR_OUT (0 << 31)
129432d6d1aSMarkus Pfeiffer #define EHCI_SITD_SET_DIR_IN (1U << 31)
13012bd3c8bSSascha Wildner #define EHCI_SITD_SET_ADDR(x) (x)
13112bd3c8bSSascha Wildner #define EHCI_SITD_GET_ADDR(x) ((x) & 0x7F)
13212bd3c8bSSascha Wildner #define EHCI_SITD_SET_ENDPT(x) ((x) << 8)
13312bd3c8bSSascha Wildner #define EHCI_SITD_GET_ENDPT(x) (((x) >> 8) & 0xF)
13412bd3c8bSSascha Wildner #define EHCI_SITD_GET_DIR(x) ((x) >> 31)
13512bd3c8bSSascha Wildner #define EHCI_SITD_SET_PORT(x) ((x) << 24)
13612bd3c8bSSascha Wildner #define EHCI_SITD_GET_PORT(x) (((x) >> 24) & 0x7F)
13712bd3c8bSSascha Wildner #define EHCI_SITD_SET_HUBA(x) ((x) << 16)
13812bd3c8bSSascha Wildner #define EHCI_SITD_GET_HUBA(x) (((x) >> 16) & 0x7F)
13912bd3c8bSSascha Wildner volatile uint32_t sitd_mask;
14012bd3c8bSSascha Wildner #define EHCI_SITD_SET_SMASK(x) (x)
14112bd3c8bSSascha Wildner #define EHCI_SITD_SET_CMASK(x) ((x) << 8)
14212bd3c8bSSascha Wildner volatile uint32_t sitd_status;
14312bd3c8bSSascha Wildner #define EHCI_SITD_COMPLETE_SPLIT (1<<1)
14412bd3c8bSSascha Wildner #define EHCI_SITD_START_SPLIT (0<<1)
14512bd3c8bSSascha Wildner #define EHCI_SITD_MISSED_MICRO_FRAME (1<<2)
14612bd3c8bSSascha Wildner #define EHCI_SITD_XACTERR (1<<3)
14712bd3c8bSSascha Wildner #define EHCI_SITD_BABBLE (1<<4)
14812bd3c8bSSascha Wildner #define EHCI_SITD_DATABUFERR (1<<5)
14912bd3c8bSSascha Wildner #define EHCI_SITD_ERROR (1<<6)
15012bd3c8bSSascha Wildner #define EHCI_SITD_ACTIVE (1<<7)
15112bd3c8bSSascha Wildner #define EHCI_SITD_IOC (1<<31)
15212bd3c8bSSascha Wildner #define EHCI_SITD_SET_LEN(len) ((len)<<16)
15312bd3c8bSSascha Wildner #define EHCI_SITD_GET_LEN(x) (((x)>>16) & 0x3FF)
15412bd3c8bSSascha Wildner volatile uint32_t sitd_bp[2];
15512bd3c8bSSascha Wildner volatile uint32_t sitd_back;
15612bd3c8bSSascha Wildner volatile uint32_t sitd_bp_hi[2];
15712bd3c8bSSascha Wildner /*
15812bd3c8bSSascha Wildner * Extra information needed:
15912bd3c8bSSascha Wildner */
16012bd3c8bSSascha Wildner uint32_t sitd_self;
16112bd3c8bSSascha Wildner struct ehci_sitd *next;
16212bd3c8bSSascha Wildner struct ehci_sitd *prev;
16312bd3c8bSSascha Wildner struct ehci_sitd *obj_next;
16412bd3c8bSSascha Wildner struct usb_page_cache *page_cache;
16512bd3c8bSSascha Wildner } __aligned(EHCI_SITD_ALIGN);
16612bd3c8bSSascha Wildner
16712bd3c8bSSascha Wildner typedef struct ehci_sitd ehci_sitd_t;
16812bd3c8bSSascha Wildner
16912bd3c8bSSascha Wildner /* Queue Element Transfer Descriptor */
17012bd3c8bSSascha Wildner struct ehci_qtd {
17112bd3c8bSSascha Wildner volatile uint32_t qtd_next;
17212bd3c8bSSascha Wildner volatile uint32_t qtd_altnext;
17312bd3c8bSSascha Wildner volatile uint32_t qtd_status;
17412bd3c8bSSascha Wildner #define EHCI_QTD_GET_STATUS(x) (((x) >> 0) & 0xff)
17512bd3c8bSSascha Wildner #define EHCI_QTD_SET_STATUS(x) ((x) << 0)
17612bd3c8bSSascha Wildner #define EHCI_QTD_ACTIVE 0x80
17712bd3c8bSSascha Wildner #define EHCI_QTD_HALTED 0x40
17812bd3c8bSSascha Wildner #define EHCI_QTD_BUFERR 0x20
17912bd3c8bSSascha Wildner #define EHCI_QTD_BABBLE 0x10
18012bd3c8bSSascha Wildner #define EHCI_QTD_XACTERR 0x08
18112bd3c8bSSascha Wildner #define EHCI_QTD_MISSEDMICRO 0x04
18212bd3c8bSSascha Wildner #define EHCI_QTD_SPLITXSTATE 0x02
18312bd3c8bSSascha Wildner #define EHCI_QTD_PINGSTATE 0x01
18412bd3c8bSSascha Wildner #define EHCI_QTD_STATERRS 0x74
18512bd3c8bSSascha Wildner #define EHCI_QTD_GET_PID(x) (((x) >> 8) & 0x3)
18612bd3c8bSSascha Wildner #define EHCI_QTD_SET_PID(x) ((x) << 8)
18712bd3c8bSSascha Wildner #define EHCI_QTD_PID_OUT 0x0
18812bd3c8bSSascha Wildner #define EHCI_QTD_PID_IN 0x1
18912bd3c8bSSascha Wildner #define EHCI_QTD_PID_SETUP 0x2
19012bd3c8bSSascha Wildner #define EHCI_QTD_GET_CERR(x) (((x) >> 10) & 0x3)
19112bd3c8bSSascha Wildner #define EHCI_QTD_SET_CERR(x) ((x) << 10)
19212bd3c8bSSascha Wildner #define EHCI_QTD_GET_C_PAGE(x) (((x) >> 12) & 0x7)
19312bd3c8bSSascha Wildner #define EHCI_QTD_SET_C_PAGE(x) ((x) << 12)
19412bd3c8bSSascha Wildner #define EHCI_QTD_GET_IOC(x) (((x) >> 15) & 0x1)
19512bd3c8bSSascha Wildner #define EHCI_QTD_IOC 0x00008000
19612bd3c8bSSascha Wildner #define EHCI_QTD_GET_BYTES(x) (((x) >> 16) & 0x7fff)
19712bd3c8bSSascha Wildner #define EHCI_QTD_SET_BYTES(x) ((x) << 16)
19812bd3c8bSSascha Wildner #define EHCI_QTD_GET_TOGGLE(x) (((x) >> 31) & 0x1)
19912bd3c8bSSascha Wildner #define EHCI_QTD_SET_TOGGLE(x) ((x) << 31)
20012bd3c8bSSascha Wildner #define EHCI_QTD_TOGGLE_MASK 0x80000000
20112bd3c8bSSascha Wildner #define EHCI_QTD_NBUFFERS 5
20212bd3c8bSSascha Wildner #define EHCI_QTD_PAYLOAD_MAX ((EHCI_QTD_NBUFFERS-1)*EHCI_PAGE_SIZE)
20312bd3c8bSSascha Wildner volatile uint32_t qtd_buffer[EHCI_QTD_NBUFFERS];
20412bd3c8bSSascha Wildner volatile uint32_t qtd_buffer_hi[EHCI_QTD_NBUFFERS];
20512bd3c8bSSascha Wildner /*
20612bd3c8bSSascha Wildner * Extra information needed:
20712bd3c8bSSascha Wildner */
20812bd3c8bSSascha Wildner struct ehci_qtd *alt_next;
20912bd3c8bSSascha Wildner struct ehci_qtd *obj_next;
21012bd3c8bSSascha Wildner struct usb_page_cache *page_cache;
21112bd3c8bSSascha Wildner uint32_t qtd_self;
21212bd3c8bSSascha Wildner uint16_t len;
21312bd3c8bSSascha Wildner } __aligned(EHCI_QTD_ALIGN);
21412bd3c8bSSascha Wildner
21512bd3c8bSSascha Wildner typedef struct ehci_qtd ehci_qtd_t;
21612bd3c8bSSascha Wildner
21712bd3c8bSSascha Wildner /* Queue Head Sub Structure */
21812bd3c8bSSascha Wildner struct ehci_qh_sub {
21912bd3c8bSSascha Wildner volatile uint32_t qtd_next;
22012bd3c8bSSascha Wildner volatile uint32_t qtd_altnext;
22112bd3c8bSSascha Wildner volatile uint32_t qtd_status;
22212bd3c8bSSascha Wildner volatile uint32_t qtd_buffer[EHCI_QTD_NBUFFERS];
22312bd3c8bSSascha Wildner volatile uint32_t qtd_buffer_hi[EHCI_QTD_NBUFFERS];
22412bd3c8bSSascha Wildner } __aligned(4);
22512bd3c8bSSascha Wildner
22612bd3c8bSSascha Wildner /* Queue Head */
22712bd3c8bSSascha Wildner struct ehci_qh {
22812bd3c8bSSascha Wildner volatile uint32_t qh_link;
22912bd3c8bSSascha Wildner volatile uint32_t qh_endp;
23012bd3c8bSSascha Wildner #define EHCI_QH_GET_ADDR(x) (((x) >> 0) & 0x7f) /* endpoint addr */
23112bd3c8bSSascha Wildner #define EHCI_QH_SET_ADDR(x) (x)
23212bd3c8bSSascha Wildner #define EHCI_QH_ADDRMASK 0x0000007f
23312bd3c8bSSascha Wildner #define EHCI_QH_GET_INACT(x) (((x) >> 7) & 0x01) /* inactivate on next */
23412bd3c8bSSascha Wildner #define EHCI_QH_INACT 0x00000080
23512bd3c8bSSascha Wildner #define EHCI_QH_GET_ENDPT(x) (((x) >> 8) & 0x0f) /* endpoint no */
23612bd3c8bSSascha Wildner #define EHCI_QH_SET_ENDPT(x) ((x) << 8)
23712bd3c8bSSascha Wildner #define EHCI_QH_GET_EPS(x) (((x) >> 12) & 0x03) /* endpoint speed */
23812bd3c8bSSascha Wildner #define EHCI_QH_SET_EPS(x) ((x) << 12)
23912bd3c8bSSascha Wildner #define EHCI_QH_SPEED_FULL 0x0
24012bd3c8bSSascha Wildner #define EHCI_QH_SPEED_LOW 0x1
24112bd3c8bSSascha Wildner #define EHCI_QH_SPEED_HIGH 0x2
24212bd3c8bSSascha Wildner #define EHCI_QH_GET_DTC(x) (((x) >> 14) & 0x01) /* data toggle control */
24312bd3c8bSSascha Wildner #define EHCI_QH_DTC 0x00004000
24412bd3c8bSSascha Wildner #define EHCI_QH_GET_HRECL(x) (((x) >> 15) & 0x01) /* head of reclamation */
24512bd3c8bSSascha Wildner #define EHCI_QH_HRECL 0x00008000
24612bd3c8bSSascha Wildner #define EHCI_QH_GET_MPL(x) (((x) >> 16) & 0x7ff) /* max packet len */
24712bd3c8bSSascha Wildner #define EHCI_QH_SET_MPL(x) ((x) << 16)
24812bd3c8bSSascha Wildner #define EHCI_QH_MPLMASK 0x07ff0000
24912bd3c8bSSascha Wildner #define EHCI_QH_GET_CTL(x) (((x) >> 27) & 0x01) /* control endpoint */
25012bd3c8bSSascha Wildner #define EHCI_QH_CTL 0x08000000
25112bd3c8bSSascha Wildner #define EHCI_QH_GET_NRL(x) (((x) >> 28) & 0x0f) /* NAK reload */
25212bd3c8bSSascha Wildner #define EHCI_QH_SET_NRL(x) ((x) << 28)
25312bd3c8bSSascha Wildner volatile uint32_t qh_endphub;
25412bd3c8bSSascha Wildner #define EHCI_QH_GET_SMASK(x) (((x) >> 0) & 0xff) /* intr sched mask */
25512bd3c8bSSascha Wildner #define EHCI_QH_SET_SMASK(x) ((x) << 0)
25612bd3c8bSSascha Wildner #define EHCI_QH_GET_CMASK(x) (((x) >> 8) & 0xff) /* split completion mask */
25712bd3c8bSSascha Wildner #define EHCI_QH_SET_CMASK(x) ((x) << 8)
25812bd3c8bSSascha Wildner #define EHCI_QH_GET_HUBA(x) (((x) >> 16) & 0x7f) /* hub address */
25912bd3c8bSSascha Wildner #define EHCI_QH_SET_HUBA(x) ((x) << 16)
26012bd3c8bSSascha Wildner #define EHCI_QH_GET_PORT(x) (((x) >> 23) & 0x7f) /* hub port */
26112bd3c8bSSascha Wildner #define EHCI_QH_SET_PORT(x) ((x) << 23)
26212bd3c8bSSascha Wildner #define EHCI_QH_GET_MULT(x) (((x) >> 30) & 0x03) /* pipe multiplier */
26312bd3c8bSSascha Wildner #define EHCI_QH_SET_MULT(x) ((x) << 30)
26412bd3c8bSSascha Wildner volatile uint32_t qh_curqtd;
26512bd3c8bSSascha Wildner struct ehci_qh_sub qh_qtd;
26612bd3c8bSSascha Wildner /*
26712bd3c8bSSascha Wildner * Extra information needed:
26812bd3c8bSSascha Wildner */
26912bd3c8bSSascha Wildner struct ehci_qh *next;
27012bd3c8bSSascha Wildner struct ehci_qh *prev;
27112bd3c8bSSascha Wildner struct ehci_qh *obj_next;
27212bd3c8bSSascha Wildner struct usb_page_cache *page_cache;
27312bd3c8bSSascha Wildner uint32_t qh_self;
27412bd3c8bSSascha Wildner } __aligned(EHCI_QH_ALIGN);
27512bd3c8bSSascha Wildner
27612bd3c8bSSascha Wildner typedef struct ehci_qh ehci_qh_t;
27712bd3c8bSSascha Wildner
27812bd3c8bSSascha Wildner /* Periodic Frame Span Traversal Node */
27912bd3c8bSSascha Wildner struct ehci_fstn {
28012bd3c8bSSascha Wildner volatile uint32_t fstn_link;
28112bd3c8bSSascha Wildner volatile uint32_t fstn_back;
28212bd3c8bSSascha Wildner } __aligned(EHCI_FSTN_ALIGN);
28312bd3c8bSSascha Wildner
28412bd3c8bSSascha Wildner typedef struct ehci_fstn ehci_fstn_t;
28512bd3c8bSSascha Wildner
28612bd3c8bSSascha Wildner struct ehci_hw_softc {
28712bd3c8bSSascha Wildner struct usb_page_cache pframes_pc;
28812bd3c8bSSascha Wildner struct usb_page_cache terminate_pc;
28912bd3c8bSSascha Wildner struct usb_page_cache async_start_pc;
29012bd3c8bSSascha Wildner struct usb_page_cache intr_start_pc[EHCI_VIRTUAL_FRAMELIST_COUNT];
29112bd3c8bSSascha Wildner struct usb_page_cache isoc_hs_start_pc[EHCI_VIRTUAL_FRAMELIST_COUNT];
29212bd3c8bSSascha Wildner struct usb_page_cache isoc_fs_start_pc[EHCI_VIRTUAL_FRAMELIST_COUNT];
29312bd3c8bSSascha Wildner
29412bd3c8bSSascha Wildner struct usb_page pframes_pg;
29512bd3c8bSSascha Wildner struct usb_page terminate_pg;
29612bd3c8bSSascha Wildner struct usb_page async_start_pg;
29712bd3c8bSSascha Wildner struct usb_page intr_start_pg[EHCI_VIRTUAL_FRAMELIST_COUNT];
29812bd3c8bSSascha Wildner struct usb_page isoc_hs_start_pg[EHCI_VIRTUAL_FRAMELIST_COUNT];
29912bd3c8bSSascha Wildner struct usb_page isoc_fs_start_pg[EHCI_VIRTUAL_FRAMELIST_COUNT];
30012bd3c8bSSascha Wildner };
30112bd3c8bSSascha Wildner
30212bd3c8bSSascha Wildner struct ehci_config_desc {
30312bd3c8bSSascha Wildner struct usb_config_descriptor confd;
30412bd3c8bSSascha Wildner struct usb_interface_descriptor ifcd;
30512bd3c8bSSascha Wildner struct usb_endpoint_descriptor endpd;
30612bd3c8bSSascha Wildner } __packed;
30712bd3c8bSSascha Wildner
30812bd3c8bSSascha Wildner union ehci_hub_desc {
30912bd3c8bSSascha Wildner struct usb_status stat;
31012bd3c8bSSascha Wildner struct usb_port_status ps;
31112bd3c8bSSascha Wildner struct usb_hub_descriptor hubd;
31212bd3c8bSSascha Wildner uint8_t temp[128];
31312bd3c8bSSascha Wildner };
31412bd3c8bSSascha Wildner
31512bd3c8bSSascha Wildner typedef struct ehci_softc {
31612bd3c8bSSascha Wildner struct ehci_hw_softc sc_hw;
31712bd3c8bSSascha Wildner struct usb_bus sc_bus; /* base device */
31812bd3c8bSSascha Wildner struct usb_callout sc_tmo_pcd;
31912bd3c8bSSascha Wildner struct usb_callout sc_tmo_poll;
32012bd3c8bSSascha Wildner union ehci_hub_desc sc_hub_desc;
32112bd3c8bSSascha Wildner
32212bd3c8bSSascha Wildner struct usb_device *sc_devices[EHCI_MAX_DEVICES];
32312bd3c8bSSascha Wildner struct resource *sc_io_res;
32412bd3c8bSSascha Wildner struct resource *sc_irq_res;
32512bd3c8bSSascha Wildner struct ehci_qh *sc_async_p_last;
32612bd3c8bSSascha Wildner struct ehci_qh *sc_intr_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT];
32712bd3c8bSSascha Wildner struct ehci_sitd *sc_isoc_fs_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT];
32812bd3c8bSSascha Wildner struct ehci_itd *sc_isoc_hs_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT];
32912bd3c8bSSascha Wildner void *sc_intr_hdl;
33012bd3c8bSSascha Wildner bus_size_t sc_io_size;
33112bd3c8bSSascha Wildner bus_space_tag_t sc_io_tag;
33212bd3c8bSSascha Wildner bus_space_handle_t sc_io_hdl;
33312bd3c8bSSascha Wildner
334*390c5130SMatthew Dillon uint32_t sc_terminate_self; /* TD short packet termination pointer */
33512bd3c8bSSascha Wildner uint32_t sc_eintrs;
33612bd3c8bSSascha Wildner
33712bd3c8bSSascha Wildner uint16_t sc_intr_stat[EHCI_VIRTUAL_FRAMELIST_COUNT];
33812bd3c8bSSascha Wildner uint16_t sc_id_vendor; /* vendor ID for root hub */
33912bd3c8bSSascha Wildner uint16_t sc_flags; /* chip specific flags */
34012bd3c8bSSascha Wildner #define EHCI_SCFLG_SETMODE 0x0001 /* set bridge mode again after init */
34112bd3c8bSSascha Wildner #define EHCI_SCFLG_FORCESPEED 0x0002 /* force speed */
34212bd3c8bSSascha Wildner #define EHCI_SCFLG_NORESTERM 0x0004 /* don't terminate reset sequence */
34312bd3c8bSSascha Wildner #define EHCI_SCFLG_BIGEDESC 0x0008 /* big-endian byte order descriptors */
34412bd3c8bSSascha Wildner #define EHCI_SCFLG_BIGEMMIO 0x0010 /* big-endian byte order MMIO */
34512bd3c8bSSascha Wildner #define EHCI_SCFLG_TT 0x0020 /* transaction translator present */
34612bd3c8bSSascha Wildner #define EHCI_SCFLG_LOSTINTRBUG 0x0040 /* workaround for VIA / ATI chipsets */
34712bd3c8bSSascha Wildner #define EHCI_SCFLG_IAADBUG 0x0080 /* workaround for nVidia chipsets */
34857bed822SMarkus Pfeiffer #define EHCI_SCFLG_DONTRESET 0x0100 /* don't reset ctrl. in ehci_init() */
34957bed822SMarkus Pfeiffer #define EHCI_SCFLG_DONEINIT 0x1000 /* ehci_init() has been called. */
35012bd3c8bSSascha Wildner
35112bd3c8bSSascha Wildner uint8_t sc_offs; /* offset to operational registers */
35212bd3c8bSSascha Wildner uint8_t sc_doorbell_disable; /* set on doorbell failure */
35312bd3c8bSSascha Wildner uint8_t sc_noport;
35412bd3c8bSSascha Wildner uint8_t sc_addr; /* device address */
35512bd3c8bSSascha Wildner uint8_t sc_conf; /* device configuration */
35612bd3c8bSSascha Wildner uint8_t sc_isreset;
35712bd3c8bSSascha Wildner uint8_t sc_hub_idata[8];
35812bd3c8bSSascha Wildner
35912bd3c8bSSascha Wildner char sc_vendor[16]; /* vendor string for root hub */
36012bd3c8bSSascha Wildner
36112bd3c8bSSascha Wildner } ehci_softc_t;
36212bd3c8bSSascha Wildner
36312bd3c8bSSascha Wildner #define EREAD1(sc, a) bus_space_read_1((sc)->sc_io_tag, (sc)->sc_io_hdl, (a))
36412bd3c8bSSascha Wildner #define EREAD2(sc, a) bus_space_read_2((sc)->sc_io_tag, (sc)->sc_io_hdl, (a))
36512bd3c8bSSascha Wildner #define EREAD4(sc, a) bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, (a))
36612bd3c8bSSascha Wildner #define EWRITE1(sc, a, x) \
36712bd3c8bSSascha Wildner bus_space_write_1((sc)->sc_io_tag, (sc)->sc_io_hdl, (a), (x))
36812bd3c8bSSascha Wildner #define EWRITE2(sc, a, x) \
36912bd3c8bSSascha Wildner bus_space_write_2((sc)->sc_io_tag, (sc)->sc_io_hdl, (a), (x))
37012bd3c8bSSascha Wildner #define EWRITE4(sc, a, x) \
37112bd3c8bSSascha Wildner bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, (a), (x))
37212bd3c8bSSascha Wildner #define EOREAD1(sc, a) \
37312bd3c8bSSascha Wildner bus_space_read_1((sc)->sc_io_tag, (sc)->sc_io_hdl, (sc)->sc_offs+(a))
37412bd3c8bSSascha Wildner #define EOREAD2(sc, a) \
37512bd3c8bSSascha Wildner bus_space_read_2((sc)->sc_io_tag, (sc)->sc_io_hdl, (sc)->sc_offs+(a))
37612bd3c8bSSascha Wildner #define EOREAD4(sc, a) \
37712bd3c8bSSascha Wildner bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, (sc)->sc_offs+(a))
37812bd3c8bSSascha Wildner #define EOWRITE1(sc, a, x) \
37912bd3c8bSSascha Wildner bus_space_write_1((sc)->sc_io_tag, (sc)->sc_io_hdl, (sc)->sc_offs+(a), (x))
38012bd3c8bSSascha Wildner #define EOWRITE2(sc, a, x) \
38112bd3c8bSSascha Wildner bus_space_write_2((sc)->sc_io_tag, (sc)->sc_io_hdl, (sc)->sc_offs+(a), (x))
38212bd3c8bSSascha Wildner #define EOWRITE4(sc, a, x) \
38312bd3c8bSSascha Wildner bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, (sc)->sc_offs+(a), (x))
38412bd3c8bSSascha Wildner
38512bd3c8bSSascha Wildner #ifdef USB_EHCI_BIG_ENDIAN_DESC
38612bd3c8bSSascha Wildner /*
38712bd3c8bSSascha Wildner * Handle byte order conversion between host and ``host controller''.
38812bd3c8bSSascha Wildner * Typically the latter is little-endian but some controllers require
38912bd3c8bSSascha Wildner * big-endian in which case we may need to manually swap.
39012bd3c8bSSascha Wildner */
39112bd3c8bSSascha Wildner static __inline uint32_t
htohc32(const struct ehci_softc * sc,const uint32_t v)39212bd3c8bSSascha Wildner htohc32(const struct ehci_softc *sc, const uint32_t v)
39312bd3c8bSSascha Wildner {
39412bd3c8bSSascha Wildner return sc->sc_flags & EHCI_SCFLG_BIGEDESC ? htobe32(v) : htole32(v);
39512bd3c8bSSascha Wildner }
39612bd3c8bSSascha Wildner
39712bd3c8bSSascha Wildner static __inline uint16_t
htohc16(const struct ehci_softc * sc,const uint16_t v)39812bd3c8bSSascha Wildner htohc16(const struct ehci_softc *sc, const uint16_t v)
39912bd3c8bSSascha Wildner {
40012bd3c8bSSascha Wildner return sc->sc_flags & EHCI_SCFLG_BIGEDESC ? htobe16(v) : htole16(v);
40112bd3c8bSSascha Wildner }
40212bd3c8bSSascha Wildner
40312bd3c8bSSascha Wildner static __inline uint32_t
hc32toh(const struct ehci_softc * sc,const uint32_t v)40412bd3c8bSSascha Wildner hc32toh(const struct ehci_softc *sc, const uint32_t v)
40512bd3c8bSSascha Wildner {
40612bd3c8bSSascha Wildner return sc->sc_flags & EHCI_SCFLG_BIGEDESC ? be32toh(v) : le32toh(v);
40712bd3c8bSSascha Wildner }
40812bd3c8bSSascha Wildner
40912bd3c8bSSascha Wildner static __inline uint16_t
hc16toh(const struct ehci_softc * sc,const uint16_t v)41012bd3c8bSSascha Wildner hc16toh(const struct ehci_softc *sc, const uint16_t v)
41112bd3c8bSSascha Wildner {
41212bd3c8bSSascha Wildner return sc->sc_flags & EHCI_SCFLG_BIGEDESC ? be16toh(v) : le16toh(v);
41312bd3c8bSSascha Wildner }
41412bd3c8bSSascha Wildner #else
41512bd3c8bSSascha Wildner /*
41612bd3c8bSSascha Wildner * Normal little-endian only conversion routines.
41712bd3c8bSSascha Wildner */
41812bd3c8bSSascha Wildner static __inline uint32_t
htohc32(const struct ehci_softc * sc,const uint32_t v)41912bd3c8bSSascha Wildner htohc32(const struct ehci_softc *sc, const uint32_t v)
42012bd3c8bSSascha Wildner {
42112bd3c8bSSascha Wildner return htole32(v);
42212bd3c8bSSascha Wildner }
42312bd3c8bSSascha Wildner
42412bd3c8bSSascha Wildner static __inline uint16_t
htohc16(const struct ehci_softc * sc,const uint16_t v)42512bd3c8bSSascha Wildner htohc16(const struct ehci_softc *sc, const uint16_t v)
42612bd3c8bSSascha Wildner {
42712bd3c8bSSascha Wildner return htole16(v);
42812bd3c8bSSascha Wildner }
42912bd3c8bSSascha Wildner
43012bd3c8bSSascha Wildner static __inline uint32_t
hc32toh(const struct ehci_softc * sc,const uint32_t v)43112bd3c8bSSascha Wildner hc32toh(const struct ehci_softc *sc, const uint32_t v)
43212bd3c8bSSascha Wildner {
43312bd3c8bSSascha Wildner return le32toh(v);
43412bd3c8bSSascha Wildner }
43512bd3c8bSSascha Wildner
43612bd3c8bSSascha Wildner static __inline uint16_t
hc16toh(const struct ehci_softc * sc,const uint16_t v)43712bd3c8bSSascha Wildner hc16toh(const struct ehci_softc *sc, const uint16_t v)
43812bd3c8bSSascha Wildner {
43912bd3c8bSSascha Wildner return le16toh(v);
44012bd3c8bSSascha Wildner }
44112bd3c8bSSascha Wildner #endif
44212bd3c8bSSascha Wildner
44312bd3c8bSSascha Wildner usb_bus_mem_cb_t ehci_iterate_hw_softc;
44412bd3c8bSSascha Wildner
44512bd3c8bSSascha Wildner usb_error_t ehci_reset(ehci_softc_t *sc);
44612bd3c8bSSascha Wildner usb_error_t ehci_init(ehci_softc_t *sc);
44712bd3c8bSSascha Wildner void ehci_detach(struct ehci_softc *sc);
44812bd3c8bSSascha Wildner void ehci_interrupt(ehci_softc_t *sc);
44912bd3c8bSSascha Wildner
45012bd3c8bSSascha Wildner #endif /* _EHCI_H_ */
451