2 * $OpenBSD: usb_port.h,v 1.18 2000/09/06 22:42:10 rahnds Exp $
3 * $NetBSD: usb_port.h,v 1.68 2005/07/30 06:14:50 skrll Exp $
4 * $FreeBSD: src/sys/dev/usb/usb_port.h,v 1.65 2003/11/09 23:54:21 joe Exp $
5 * $DragonFly: src/sys/bus/usb/usb_port.h,v 1.19 2007/07/02 07:07:08 hasso Exp $
8 /* Also already merged from NetBSD:
9 * $NetBSD: usb_port.h,v 1.57 2002/09/27 20:42:01 thorpej Exp $
10 * $NetBSD: usb_port.h,v 1.58 2002/10/01 01:25:26 thorpej Exp $
14 * Copyright (c) 1998 The NetBSD Foundation, Inc.
15 * All rights reserved.
17 * This code is derived from software contributed to The NetBSD Foundation
18 * by Lennart Augustsson (lennart@augustsson.net) at
19 * Carlstedt Research & Technology.
21 * Redistribution and use in source and binary forms, with or without
22 * modification, are permitted provided that the following conditions
24 * 1. Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
26 * 2. Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in the
28 * documentation and/or other materials provided with the distribution.
29 * 3. All advertising materials mentioning features or use of this software
30 * must display the following acknowledgement:
31 * This product includes software developed by the NetBSD
32 * Foundation, Inc. and its contributors.
33 * 4. Neither the name of The NetBSD Foundation nor the names of its
34 * contributors may be used to endorse or promote products derived
35 * from this software without specific prior written permission.
37 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
38 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
39 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
40 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
41 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
43 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
44 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
45 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
47 * POSSIBILITY OF SUCH DAMAGE.
54 * Macros to ease the import of USB drivers from other BSD systems.
60 #include <sys/malloc.h>
62 MALLOC_DECLARE(M_USB);
63 MALLOC_DECLARE(M_USBDEV);
64 MALLOC_DECLARE(M_USBHC);
72 #define device_ptr_t device_t
73 #define USBBASEDEVICE device_t
74 #define USBDEV(bdev) (bdev)
75 #define USBDEVNAME(bdev) device_get_nameunit(bdev)
76 #define USBDEVUNIT(bdev) device_get_unit(bdev)
77 #define USBDEVPTRNAME(bdev) device_get_nameunit(bdev)
78 #define USBGETSOFTC(bdev) (device_get_softc(bdev))
80 #define DECLARE_USB_DMA_T \
81 struct usb_dma_block; \
83 struct usb_dma_block *block; \
89 #define PROC_UNLOCK(p)
90 #define uio_procp uio_td
92 #define selwakeuppri(p, pri) selwakeup(p)
94 typedef struct thread *usb_proc_ptr;
96 #define config_pending_incr()
97 #define config_pending_decr()
99 #define usb_kthread_create(f, s) \
100 kthread_create(f, s, NULL, "dummy")
101 #define usb_kthread_create1(f, s, p, name, arg) \
102 kthread_create(f, s, p, name, arg)
103 #define usb_kthread_create2(f, s, p, name) \
104 kthread_create(f, s, p, name)
106 typedef struct callout usb_callout_t;
107 #define usb_callout_init(h) callout_init(&(h))
108 #define usb_callout(h, t, f, d) callout_reset(&(h), (t), (f), (d))
109 #define usb_uncallout(h, f, d) callout_stop(&(h))
111 #define clalloc(p, s, x) (clist_alloc_cblocks((p), (s), (s)), 0)
112 #define clfree(p) clist_free_cblocks((p))
115 #define PWR_SUSPEND 1
117 #define config_detach(dev, flag) device_delete_child(device_get_parent(dev), dev)
119 typedef struct malloc_type *usb_malloc_type;
121 #define USB_DECLARE_DRIVER_INIT(dname, init...) \
122 Static device_probe_t __CONCAT(dname,_match); \
123 Static device_attach_t __CONCAT(dname,_attach); \
124 Static device_detach_t __CONCAT(dname,_detach); \
126 Static devclass_t __CONCAT(dname,_devclass); \
128 Static device_method_t __CONCAT(dname,_methods)[] = { \
129 DEVMETHOD(device_probe, __CONCAT(dname,_match)), \
130 DEVMETHOD(device_attach, __CONCAT(dname,_attach)), \
131 DEVMETHOD(device_detach, __CONCAT(dname,_detach)), \
136 Static driver_t __CONCAT(dname,_driver) = { \
138 __CONCAT(dname,_methods), \
139 sizeof(struct __CONCAT(dname,_softc)) \
141 MODULE_DEPEND(dname, usb, 1, 1, 1)
144 #define METHODS_NONE {0,0}
145 #define USB_DECLARE_DRIVER(dname) USB_DECLARE_DRIVER_INIT(dname, METHODS_NONE)
147 #define USB_MATCH(dname) \
149 __CONCAT(dname,_match)(device_t self)
151 #define USB_MATCH_START(dname, uaa) \
152 struct usb_attach_arg *uaa = device_get_ivars(self)
154 #define USB_MATCH_SETUP \
157 #define USB_ATTACH(dname) \
159 __CONCAT(dname,_attach)(device_t self)
161 #define USB_ATTACH_START(dname, sc, uaa) \
162 struct __CONCAT(dname,_softc) *sc = device_get_softc(self); \
163 struct usb_attach_arg *uaa = device_get_ivars(self)
165 /* Returns from attach */
166 #define USB_ATTACH_ERROR_RETURN return ENXIO
167 #define USB_ATTACH_SUCCESS_RETURN return 0
169 #define USB_ATTACH_SETUP \
171 device_set_desc_copy(self, devinfo)
173 #define USB_DETACH(dname) \
175 __CONCAT(dname,_detach)(device_t self)
177 #define USB_DETACH_START(dname, sc) \
178 struct __CONCAT(dname,_softc) *sc = device_get_softc(self)
180 #define USB_GET_SC_OPEN(dname, unit, sc) \
181 sc = devclass_get_softc(__CONCAT(dname,_devclass), unit); \
185 #define USB_GET_SC(dname, unit, sc) \
186 sc = devclass_get_softc(__CONCAT(dname,_devclass), unit)
188 #define USB_DO_ATTACH(dev, bdev, parent, args, print, sub) \
189 (device_probe_and_attach((bdev)) == 0 ? (bdev) : 0)
191 /* conversion from one type of queue to the other */
192 #define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD
193 #define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD
194 #define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL
195 #define SIMPLEQ_NEXT STAILQ_NEXT
196 #define SIMPLEQ_FIRST STAILQ_FIRST
197 #define SIMPLEQ_HEAD STAILQ_HEAD
198 #define SIMPLEQ_EMPTY STAILQ_EMPTY
199 #define SIMPLEQ_FOREACH STAILQ_FOREACH
200 #define SIMPLEQ_INIT STAILQ_INIT
201 #define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER
202 #define SIMPLEQ_ENTRY STAILQ_ENTRY
204 #define logprintf kprintf
207 SYSCTL_DECL(_hw_usb);
210 #endif /* _USB_PORT_H */