Home | History | Annotate | Line # | Download | only in usb
      1 /*	$NetBSD: ohcivar.h,v 1.64 2025/03/31 14:46:42 riastradh Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Lennart Augustsson (lennart (at) augustsson.net) at
      9  * Carlstedt Research & Technology.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30  * POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 #ifndef _OHCIVAR_H_
     34 #define _OHCIVAR_H_
     35 
     36 #include <sys/pool.h>
     37 
     38 typedef struct ohci_soft_ed {
     39 	ohci_ed_t *ed;
     40 	struct ohci_soft_ed *next;
     41 	ohci_physaddr_t physaddr;
     42 	usb_dma_t dma;
     43 	int offs;
     44 } ohci_soft_ed_t;
     45 
     46 
     47 typedef struct ohci_soft_td {
     48 	ohci_td_t *td;
     49 	struct ohci_soft_td *nexttd;	/* mirrors nexttd in TD */
     50 	struct ohci_soft_td *dnext;	/* next in done list */
     51 	struct ohci_soft_td **held;	/* where the ref to this std is held */
     52 	ohci_physaddr_t physaddr;
     53 	usb_dma_t dma;
     54 	int offs;
     55 	LIST_ENTRY(ohci_soft_td) hnext;	/* next on hash list */
     56 	struct usbd_xfer *xfer;
     57 	uint16_t len;
     58 	uint16_t flags;
     59 #define OHCI_CALL_DONE	0x0001
     60 #define OHCI_ADD_LEN	0x0002
     61 } ohci_soft_td_t;
     62 // #define OHCI_STD_SIZE (roundup(sizeof(struct ohci_soft_td), OHCI_TD_ALIGN))
     63 // #define OHCI_STD_CHUNK 128
     64 
     65 
     66 typedef struct ohci_soft_itd {
     67 	ohci_itd_t *itd;
     68 	struct ohci_soft_itd *nextitd;	/* mirrors nexttd in ITD */
     69 	struct ohci_soft_itd *dnext;	/* next in done list */
     70 	struct ohci_soft_itd **held;	/* where the ref to this sitd is held */
     71 	ohci_physaddr_t physaddr;
     72 	usb_dma_t dma;
     73 	int offs;
     74 	LIST_ENTRY(ohci_soft_itd) hnext;/* next on hash list */
     75 	struct usbd_xfer *xfer;
     76 	uint16_t flags;
     77 	bool isdone;	/* used only when DIAGNOSTIC is defined */
     78 } ohci_soft_itd_t;
     79 // #define OHCI_SITD_SIZE (roundup(sizeof(struct ohci_soft_itd), OHCI_ITD_ALIGN))
     80 // #define OHCI_SITD_CHUNK 64
     81 
     82 
     83 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
     84 
     85 #define OHCI_HASH_SIZE 128
     86 
     87 typedef struct ohci_softc {
     88 	device_t sc_dev;
     89 	struct usbd_bus sc_bus;
     90 	bus_space_tag_t iot;
     91 	bus_space_handle_t ioh;
     92 	bus_size_t sc_size;
     93 	bool sc_attached;
     94 
     95 	kmutex_t sc_lock;
     96 	kmutex_t sc_intr_lock;
     97 	void *sc_rhsc_si;
     98 
     99 	usb_dma_t sc_hccadma;
    100 	struct ohci_hcca *sc_hcca;
    101 	ohci_soft_ed_t *sc_eds[OHCI_NO_EDS];
    102 	u_int sc_bws[OHCI_NO_INTRS];
    103 
    104 	uint32_t sc_eintrs;
    105 	ohci_soft_ed_t *sc_isoc_head;
    106 	ohci_soft_ed_t *sc_ctrl_head;
    107 	ohci_soft_ed_t *sc_bulk_head;
    108 
    109 	LIST_HEAD(, ohci_soft_td)  sc_hash_tds[OHCI_HASH_SIZE];
    110 	LIST_HEAD(, ohci_soft_itd) sc_hash_itds[OHCI_HASH_SIZE];
    111 
    112 	TAILQ_HEAD(, ohci_xfer)	sc_abortingxfers;
    113 
    114 	int sc_noport;
    115 
    116 	int sc_endian;
    117 #define	OHCI_LITTLE_ENDIAN	0	/* typical (uninitialized default) */
    118 #define	OHCI_BIG_ENDIAN		1	/* big endian OHCI? never seen it */
    119 #define	OHCI_HOST_ENDIAN	2	/* if OHCI always matches CPU */
    120 
    121 	int sc_flags;
    122 #define OHCIF_SUPERIO		0x0001
    123 
    124 	kcondvar_t sc_abort_cv;
    125 
    126 	ohci_soft_ed_t *sc_freeeds;
    127 	ohci_soft_td_t *sc_freetds;
    128 	ohci_soft_itd_t *sc_freeitds;
    129 
    130 	pool_cache_t sc_xferpool;	/* free xfer pool */
    131 
    132 	struct usbd_xfer *sc_intrxfer;
    133 
    134 	uint32_t sc_control;		/* Preserved during suspend/standby */
    135 	uint32_t sc_intre;
    136 
    137 	u_int sc_overrun_cnt;
    138 	struct timeval sc_overrun_ntc;
    139 
    140 	struct callout sc_tmo_rhsc;
    141 	device_t sc_child;
    142 	char sc_dying;
    143 } ohci_softc_t;
    144 
    145 struct ohci_xfer {
    146 	struct usbd_xfer xfer;
    147 	uint32_t ox_abintrs;
    148 	TAILQ_ENTRY(ohci_xfer) ox_abnext;
    149 
    150 	/* ctrl */
    151 	ohci_soft_td_t *ox_setup;
    152 	ohci_soft_td_t *ox_stat;
    153 	union {
    154 		/* ctrl/bulk/intr */
    155 		struct {
    156 			ohci_soft_td_t **ox_stds;
    157 			size_t ox_nstd;
    158 		};
    159 		/* isoc */
    160 		struct {
    161 			ohci_soft_itd_t **ox_sitds;
    162 			size_t ox_nsitd;
    163 		};
    164 	};
    165 };
    166 
    167 #define OHCI_BUS2SC(bus)	((bus)->ub_hcpriv)
    168 #define OHCI_PIPE2SC(pipe)	OHCI_BUS2SC((pipe)->up_dev->ud_bus)
    169 #define OHCI_XFER2SC(xfer)	OHCI_BUS2SC((xfer)->ux_bus)
    170 
    171 #define OHCI_XFER2OXFER(xfer)	((struct ohci_xfer *)(xfer))
    172 #define OHCI_PIPE2OPIPE(pipe)	((struct ohci_pipe *)(pipe))
    173 
    174 int		ohci_init(ohci_softc_t *);
    175 int		ohci_intr(void *);
    176 void		ohci_detach(ohci_softc_t *);
    177 bool		ohci_shutdown(device_t, int);
    178 void		ohci_childdet(device_t, device_t);
    179 int		ohci_activate(device_t, enum devact);
    180 bool		ohci_resume(device_t, const pmf_qual_t *);
    181 bool		ohci_suspend(device_t, const pmf_qual_t *);
    182 
    183 #endif /* _OHCIVAR_H_ */
    184