/* $NetBSD: uhcivar.h,v 1.57 2020/03/15 07:56:19 skrll Exp $ */
/*
* Copyright (c) 1998 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Lennart Augustsson (lennart@augustsson.net) at
* Carlstedt Research & Technology.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _UHCIVAR_H_
#define _UHCIVAR_H_
#include <sys/pool.h>
/*
* To avoid having 1024 TDs for each isochronous transfer we introduce
* a virtual frame list. Every UHCI_VFRAMELIST_COUNT entries in the real
* frame list points to a non-active TD. These, in turn, form the
* starts of the virtual frame list. This also has the advantage that it
* simplifies linking in/out of TDs/QHs in the schedule.
* Furthermore, initially each of the inactive TDs point to an inactive
* QH that forms the start of the interrupt traffic for that slot.
* Each of these QHs point to the same QH that is the start of control
* traffic. This QH points at another QH which is the start of the
* bulk traffic.
*
* UHCI_VFRAMELIST_COUNT should be a power of 2 and <= UHCI_FRAMELIST_COUNT.
*/
#define UHCI_VFRAMELIST_COUNT 128
typedef struct uhci_soft_qh uhci_soft_qh_t;
typedef struct uhci_soft_td uhci_soft_td_t;
typedef union {
struct uhci_soft_qh *sqh;
struct uhci_soft_td *std;
} uhci_soft_td_qh_t;
struct uhci_xfer {
struct usbd_xfer ux_xfer;
enum {
UX_NONE, UX_CTRL, UX_BULK, UX_INTR, UX_ISOC
} ux_type;
/* ctrl/bulk/intr */
struct {
uhci_soft_td_t **ux_stds;
size_t ux_nstd;
};
union {
/* ctrl */
struct {
uhci_soft_td_t *ux_setup;
uhci_soft_td_t *ux_data;
uhci_soft_td_t *ux_stat;
};
/* bulk/intr/isoc */
struct {
uhci_soft_td_t *ux_stdstart;
uhci_soft_td_t *ux_stdend;
};
};
TAILQ_ENTRY(uhci_xfer) ux_list;
int ux_curframe;
bool ux_isdone; /* used only when DIAGNOSTIC is defined */
};
#define UHCI_BUS2SC(bus) ((bus)->ub_hcpriv)
#define UHCI_PIPE2SC(pipe) UHCI_BUS2SC((pipe)->up_dev->ud_bus)
#define UHCI_XFER2SC(xfer) UHCI_BUS2SC((xfer)->ux_bus)
#define UHCI_UPIPE2SC(d) UHCI_BUS2SC((d)->pipe.up_dev->ud_bus)
#define UHCI_XFER2UXFER(xfer) ((struct uhci_xfer *)(xfer))
#define UHCI_PIPE2UPIPE(pipe) ((struct uhci_pipe *)(pipe))
/*
* Extra information that we need for a TD.
*/
struct uhci_soft_td {
uhci_td_t td; /* The real TD, must be first */
uhci_soft_td_qh_t link; /* soft version of the td_link field */
uhci_physaddr_t physaddr; /* TD's physical address. */
usb_dma_t dma; /* TD's DMA infos */
int offs; /* TD's offset in usb_dma_t */
};
/*
* Make the size such that it is a multiple of UHCI_TD_ALIGN. This way
* we can pack a number of soft TD together and have the real TD well
* aligned.
* NOTE: Minimum size is 32 bytes.
*/
#define UHCI_STD_SIZE (roundup(sizeof(struct uhci_soft_td), UHCI_TD_ALIGN))
#define UHCI_STD_CHUNK 128 /*(PAGE_SIZE / UHCI_TD_SIZE)*/
/*
* Extra information that we need for a QH.
*/
struct uhci_soft_qh {
uhci_qh_t qh; /* The real QH, must be first */
uhci_soft_qh_t *hlink; /* soft version of qh_hlink */
uhci_soft_td_t *elink; /* soft version of qh_elink */
uhci_physaddr_t physaddr; /* QH's physical address. */
int pos; /* Timeslot position */
usb_dma_t dma; /* QH's DMA infos */
int offs; /* QH's offset in usb_dma_t */
};
/* See comment about UHCI_STD_SIZE. */
#define UHCI_SQH_SIZE (roundup(sizeof(struct uhci_soft_qh), UHCI_QH_ALIGN))
#define UHCI_SQH_CHUNK 128 /*(PAGE_SIZE / UHCI_QH_SIZE)*/
/*
* Information about an entry in the virtual frame list.
*/
struct uhci_vframe {
uhci_soft_td_t *htd; /* pointer to dummy TD */
uhci_soft_td_t *etd; /* pointer to last TD */
uhci_soft_qh_t *hqh; /* pointer to dummy QH */
uhci_soft_qh_t *eqh; /* pointer to last QH */
u_int bandwidth; /* max bandwidth used by this frame */
};
typedef struct uhci_softc {
device_t sc_dev;
struct usbd_bus sc_bus;
bus_space_tag_t iot;
bus_space_handle_t ioh;
bus_size_t sc_size;
kmutex_t sc_lock;
kmutex_t sc_intr_lock;
uhci_physaddr_t *sc_pframes;
usb_dma_t sc_dma;
struct uhci_vframe sc_vframes[UHCI_VFRAMELIST_COUNT];
uhci_soft_qh_t *sc_lctl_start; /* dummy QH for low speed control */
uhci_soft_qh_t *sc_lctl_end; /* last control QH */
uhci_soft_qh_t *sc_hctl_start; /* dummy QH for high speed control */
uhci_soft_qh_t *sc_hctl_end; /* last control QH */
uhci_soft_qh_t *sc_bulk_start; /* dummy QH for bulk */
uhci_soft_qh_t *sc_bulk_end; /* last bulk transfer */
uhci_soft_qh_t *sc_last_qh; /* dummy QH at the end */
uint32_t sc_loops; /* number of QHs that wants looping */
uhci_soft_td_t *sc_freetds; /* TD free list */
uhci_soft_qh_t *sc_freeqhs; /* QH free list */
pool_cache_t sc_xferpool; /* free xfer pool */
uint16_t sc_saved_frnum;
uint8_t sc_saved_sof;
char sc_isreset;
char sc_suspend;
char sc_dying;
TAILQ_HEAD(, uhci_xfer) sc_intrhead;
/* Info for the root hub interrupt "pipe". */
int sc_ival; /* time between root hub intrs */
struct usbd_xfer *sc_intr_xfer; /* root hub interrupt transfer */
struct callout sc_poll_handle;
device_t sc_child; /* /dev/usb# device */
} uhci_softc_t;
int uhci_init(uhci_softc_t *);
int uhci_intr(void *);
int uhci_detach(uhci_softc_t *, int);
void uhci_childdet(device_t, device_t);
int uhci_activate(device_t, enum devact);
bool uhci_resume(device_t, const pmf_qual_t *);
bool uhci_suspend(device_t, const pmf_qual_t *);
#endif /* _UHCIVAR_H_ */