dwc2var.h revision 1.5.18.1 1 /* $NetBSD: dwc2var.h,v 1.5.18.1 2019/06/10 22:08:33 christos Exp $ */
2
3 /*-
4 * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Nick Hudson
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 _DWC2VAR_H_
33 #define _DWC2VAR_H_
34
35 #include <sys/pool.h>
36
37 struct dwc2_hsotg;
38 struct dwc2_qtd;
39
40 struct dwc2_xfer {
41 struct usbd_xfer xfer; /* Needs to be first */
42
43 struct dwc2_hcd_urb *urb;
44
45 TAILQ_ENTRY(dwc2_xfer) xnext; /* list of complete xfers */
46 };
47
48 struct dwc2_pipe {
49 struct usbd_pipe pipe; /* Must be first */
50
51 /* Current transfer */
52 void *priv; /* QH */
53
54 /* DMA buffer for control endpoint requests */
55 usb_dma_t req_dma;
56 };
57
58
59 #define DWC2_BUS2SC(bus) ((bus)->ub_hcpriv)
60 #define DWC2_PIPE2SC(pipe) DWC2_BUS2SC((pipe)->up_dev->ud_bus)
61 #define DWC2_XFER2SC(xfer) DWC2_BUS2SC((xfer)->ux_bus)
62 #define DWC2_DPIPE2SC(d) DWC2_BUS2SC((d)->pipe.up_dev->ud_bus)
63
64 #define DWC2_XFER2DXFER(x) (struct dwc2_xfer *)(x)
65
66 #define DWC2_XFER2DPIPE(x) (struct dwc2_pipe *)(x)->ux_pipe;
67 #define DWC2_PIPE2DPIPE(p) (struct dwc2_pipe *)(p)
68
69
70 typedef struct dwc2_softc {
71 device_t sc_dev;
72
73 bus_space_tag_t sc_iot;
74 bus_space_handle_t sc_ioh;
75 bus_dma_tag_t sc_dmat;
76 struct dwc2_core_params *sc_params;
77 int (*sc_set_dma_addr)(device_t, bus_addr_t, int);
78
79 /*
80 * Private
81 */
82
83 struct usbd_bus sc_bus;
84 struct dwc2_hsotg *sc_hsotg;
85
86 kmutex_t sc_lock;
87
88 bool sc_hcdenabled;
89 void *sc_rhc_si;
90
91 struct usbd_xfer *sc_intrxfer;
92
93 device_t sc_child; /* /dev/usb# device */
94 char sc_dying;
95
96 TAILQ_HEAD(, dwc2_xfer) sc_complete; /* complete transfers */
97
98 pool_cache_t sc_xferpool;
99 pool_cache_t sc_qhpool;
100 pool_cache_t sc_qtdpool;
101
102 } dwc2_softc_t;
103
104 int dwc2_init(struct dwc2_softc *);
105 int dwc2_intr(void *);
106 int dwc2_detach(dwc2_softc_t *, int);
107 bool dwc2_shutdown(device_t, int);
108 void dwc2_childdet(device_t, device_t);
109 int dwc2_activate(device_t, enum devact);
110 bool dwc2_resume(device_t, const pmf_qual_t *);
111 bool dwc2_suspend(device_t, const pmf_qual_t *);
112
113 void dwc2_worker(struct work *, void *);
114
115 void dwc2_host_complete(struct dwc2_hsotg *, struct dwc2_qtd *,
116 int);
117
118 static inline void
119 dwc2_root_intr(dwc2_softc_t *sc)
120 {
121
122 softint_schedule(sc->sc_rhc_si);
123 }
124
125 #endif /* _DWC_OTGVAR_H_ */
126