xref: /freebsd/sys/dev/usb/usb_dynamic.c (revision 718cf2ccb9956613756ab15d7a0e28f2c8e91cab)
102ac6454SAndrew Thompson /* $FreeBSD$ */
202ac6454SAndrew Thompson /*-
3*718cf2ccSPedro F. Giffuni  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4*718cf2ccSPedro F. Giffuni  *
502ac6454SAndrew Thompson  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
602ac6454SAndrew Thompson  *
702ac6454SAndrew Thompson  * Redistribution and use in source and binary forms, with or without
802ac6454SAndrew Thompson  * modification, are permitted provided that the following conditions
902ac6454SAndrew Thompson  * are met:
1002ac6454SAndrew Thompson  * 1. Redistributions of source code must retain the above copyright
1102ac6454SAndrew Thompson  *    notice, this list of conditions and the following disclaimer.
1202ac6454SAndrew Thompson  * 2. Redistributions in binary form must reproduce the above copyright
1302ac6454SAndrew Thompson  *    notice, this list of conditions and the following disclaimer in the
1402ac6454SAndrew Thompson  *    documentation and/or other materials provided with the distribution.
1502ac6454SAndrew Thompson  *
1602ac6454SAndrew Thompson  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1702ac6454SAndrew Thompson  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1802ac6454SAndrew Thompson  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1902ac6454SAndrew Thompson  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
2002ac6454SAndrew Thompson  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2102ac6454SAndrew Thompson  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2202ac6454SAndrew Thompson  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2302ac6454SAndrew Thompson  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2402ac6454SAndrew Thompson  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2502ac6454SAndrew Thompson  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2602ac6454SAndrew Thompson  * SUCH DAMAGE.
2702ac6454SAndrew Thompson  */
2802ac6454SAndrew Thompson 
29d2b99310SHans Petter Selasky #ifdef USB_GLOBAL_INCLUDE_FILE
30d2b99310SHans Petter Selasky #include USB_GLOBAL_INCLUDE_FILE
31d2b99310SHans Petter Selasky #else
32ed6d949aSAndrew Thompson #include <sys/stdint.h>
33ed6d949aSAndrew Thompson #include <sys/stddef.h>
34ed6d949aSAndrew Thompson #include <sys/param.h>
35ed6d949aSAndrew Thompson #include <sys/queue.h>
36ed6d949aSAndrew Thompson #include <sys/types.h>
37ed6d949aSAndrew Thompson #include <sys/systm.h>
38ed6d949aSAndrew Thompson #include <sys/kernel.h>
39ed6d949aSAndrew Thompson #include <sys/bus.h>
40ed6d949aSAndrew Thompson #include <sys/module.h>
41ed6d949aSAndrew Thompson #include <sys/lock.h>
42ed6d949aSAndrew Thompson #include <sys/mutex.h>
43ed6d949aSAndrew Thompson #include <sys/condvar.h>
44ed6d949aSAndrew Thompson #include <sys/sysctl.h>
45ed6d949aSAndrew Thompson #include <sys/sx.h>
46ed6d949aSAndrew Thompson #include <sys/unistd.h>
47ed6d949aSAndrew Thompson #include <sys/callout.h>
48ed6d949aSAndrew Thompson #include <sys/malloc.h>
49ed6d949aSAndrew Thompson #include <sys/priv.h>
50ed6d949aSAndrew Thompson 
5102ac6454SAndrew Thompson #include <dev/usb/usb.h>
52ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h>
5302ac6454SAndrew Thompson 
5402ac6454SAndrew Thompson #include <dev/usb/usb_core.h>
5502ac6454SAndrew Thompson #include <dev/usb/usb_process.h>
5602ac6454SAndrew Thompson #include <dev/usb/usb_device.h>
5702ac6454SAndrew Thompson #include <dev/usb/usb_dynamic.h>
582c79a775SHans Petter Selasky #include <dev/usb/usb_request.h>
59d2b99310SHans Petter Selasky #endif			/* USB_GLOBAL_INCLUDE_FILE */
6002ac6454SAndrew Thompson 
6102ac6454SAndrew Thompson /* function prototypes */
62a593f6b8SAndrew Thompson static usb_handle_req_t usb_temp_get_desc_w;
63a593f6b8SAndrew Thompson static usb_temp_setup_by_index_t usb_temp_setup_by_index_w;
648d59ecb2SHans Petter Selasky #if USB_HAVE_COMPAT_LINUX
658d59ecb2SHans Petter Selasky static usb_linux_free_device_t usb_linux_free_device_w;
668d59ecb2SHans Petter Selasky #endif
67a593f6b8SAndrew Thompson static usb_temp_unsetup_t usb_temp_unsetup_w;
683f37fb62SHans Petter Selasky static usb_test_quirk_t usb_test_quirk_w;
69a593f6b8SAndrew Thompson static usb_quirk_ioctl_t usb_quirk_ioctl_w;
7002ac6454SAndrew Thompson 
7102ac6454SAndrew Thompson /* global variables */
72a593f6b8SAndrew Thompson usb_handle_req_t *usb_temp_get_desc_p = &usb_temp_get_desc_w;
73a593f6b8SAndrew Thompson usb_temp_setup_by_index_t *usb_temp_setup_by_index_p = &usb_temp_setup_by_index_w;
748d59ecb2SHans Petter Selasky #if USB_HAVE_COMPAT_LINUX
758d59ecb2SHans Petter Selasky usb_linux_free_device_t *usb_linux_free_device_p = &usb_linux_free_device_w;
768d59ecb2SHans Petter Selasky #endif
77a593f6b8SAndrew Thompson usb_temp_unsetup_t *usb_temp_unsetup_p = &usb_temp_unsetup_w;
78a593f6b8SAndrew Thompson usb_test_quirk_t *usb_test_quirk_p = &usb_test_quirk_w;
79a593f6b8SAndrew Thompson usb_quirk_ioctl_t *usb_quirk_ioctl_p = &usb_quirk_ioctl_w;
80ff182db6SHans Petter Selasky devclass_t usb_devclass_ptr;
8102ac6454SAndrew Thompson 
82e0a69b51SAndrew Thompson static usb_error_t
83a593f6b8SAndrew Thompson usb_temp_setup_by_index_w(struct usb_device *udev, uint16_t index)
8402ac6454SAndrew Thompson {
8502ac6454SAndrew Thompson 	return (USB_ERR_INVAL);
8602ac6454SAndrew Thompson }
8702ac6454SAndrew Thompson 
883f37fb62SHans Petter Selasky static uint8_t
89a593f6b8SAndrew Thompson usb_test_quirk_w(const struct usbd_lookup_info *info, uint16_t quirk)
9002ac6454SAndrew Thompson {
9102ac6454SAndrew Thompson 	return (0);			/* no match */
9202ac6454SAndrew Thompson }
9302ac6454SAndrew Thompson 
9402ac6454SAndrew Thompson static int
95a593f6b8SAndrew Thompson usb_quirk_ioctl_w(unsigned long cmd, caddr_t data, int fflag, struct thread *td)
9602ac6454SAndrew Thompson {
9702ac6454SAndrew Thompson 	return (ENOIOCTL);
9802ac6454SAndrew Thompson }
9902ac6454SAndrew Thompson 
100e0a69b51SAndrew Thompson static usb_error_t
101a593f6b8SAndrew Thompson usb_temp_get_desc_w(struct usb_device *udev, struct usb_device_request *req, const void **pPtr, uint16_t *pLength)
10202ac6454SAndrew Thompson {
10302ac6454SAndrew Thompson 	/* stall */
104459d369eSAndrew Thompson 	return (USB_ERR_STALLED);
10502ac6454SAndrew Thompson }
10602ac6454SAndrew Thompson 
10702ac6454SAndrew Thompson static void
108a593f6b8SAndrew Thompson usb_temp_unsetup_w(struct usb_device *udev)
10902ac6454SAndrew Thompson {
1102c79a775SHans Petter Selasky 	usbd_free_config_desc(udev, udev->usb_template_ptr);
111a593f6b8SAndrew Thompson 	udev->usb_template_ptr = NULL;
11202ac6454SAndrew Thompson }
11302ac6454SAndrew Thompson 
1148d59ecb2SHans Petter Selasky #if USB_HAVE_COMPAT_LINUX
1158d59ecb2SHans Petter Selasky static void
1168d59ecb2SHans Petter Selasky usb_linux_free_device_w(struct usb_device *udev)
1178d59ecb2SHans Petter Selasky {
1188d59ecb2SHans Petter Selasky 	/* NOP */
1198d59ecb2SHans Petter Selasky }
1208d59ecb2SHans Petter Selasky #endif
1218d59ecb2SHans Petter Selasky 
12202ac6454SAndrew Thompson void
123a593f6b8SAndrew Thompson usb_quirk_unload(void *arg)
12402ac6454SAndrew Thompson {
12502ac6454SAndrew Thompson 	/* reset function pointers */
12602ac6454SAndrew Thompson 
127a593f6b8SAndrew Thompson 	usb_test_quirk_p = &usb_test_quirk_w;
128a593f6b8SAndrew Thompson 	usb_quirk_ioctl_p = &usb_quirk_ioctl_w;
12902ac6454SAndrew Thompson 
13002ac6454SAndrew Thompson 	/* wait for CPU to exit the loaded functions, if any */
13102ac6454SAndrew Thompson 
13202ac6454SAndrew Thompson 	/* XXX this is a tradeoff */
13302ac6454SAndrew Thompson 
13402ac6454SAndrew Thompson 	pause("WAIT", hz);
13502ac6454SAndrew Thompson }
13602ac6454SAndrew Thompson 
13702ac6454SAndrew Thompson void
138a593f6b8SAndrew Thompson usb_temp_unload(void *arg)
13902ac6454SAndrew Thompson {
14002ac6454SAndrew Thompson 	/* reset function pointers */
14102ac6454SAndrew Thompson 
142a593f6b8SAndrew Thompson 	usb_temp_get_desc_p = &usb_temp_get_desc_w;
143a593f6b8SAndrew Thompson 	usb_temp_setup_by_index_p = &usb_temp_setup_by_index_w;
144a593f6b8SAndrew Thompson 	usb_temp_unsetup_p = &usb_temp_unsetup_w;
14502ac6454SAndrew Thompson 
14602ac6454SAndrew Thompson 	/* wait for CPU to exit the loaded functions, if any */
14702ac6454SAndrew Thompson 
14802ac6454SAndrew Thompson 	/* XXX this is a tradeoff */
14902ac6454SAndrew Thompson 
15002ac6454SAndrew Thompson 	pause("WAIT", hz);
15102ac6454SAndrew Thompson }
15202ac6454SAndrew Thompson 
15302ac6454SAndrew Thompson void
154a593f6b8SAndrew Thompson usb_bus_unload(void *arg)
15502ac6454SAndrew Thompson {
15602ac6454SAndrew Thompson 	/* reset function pointers */
15702ac6454SAndrew Thompson 
158a593f6b8SAndrew Thompson 	usb_devclass_ptr = NULL;
15902ac6454SAndrew Thompson 
16002ac6454SAndrew Thompson 	/* wait for CPU to exit the loaded functions, if any */
16102ac6454SAndrew Thompson 
16202ac6454SAndrew Thompson 	/* XXX this is a tradeoff */
16302ac6454SAndrew Thompson 
16402ac6454SAndrew Thompson 	pause("WAIT", hz);
16502ac6454SAndrew Thompson }
1668d59ecb2SHans Petter Selasky 
1678d59ecb2SHans Petter Selasky #if USB_HAVE_COMPAT_LINUX
1688d59ecb2SHans Petter Selasky void
1698d59ecb2SHans Petter Selasky usb_linux_unload(void *arg)
1708d59ecb2SHans Petter Selasky {
1718d59ecb2SHans Petter Selasky 	/* reset function pointers */
1728d59ecb2SHans Petter Selasky 
1738d59ecb2SHans Petter Selasky 	usb_linux_free_device_p = &usb_linux_free_device_w;
1748d59ecb2SHans Petter Selasky 
1758d59ecb2SHans Petter Selasky 	/* wait for CPU to exit the loaded functions, if any */
1768d59ecb2SHans Petter Selasky 
1778d59ecb2SHans Petter Selasky 	/* XXX this is a tradeoff */
1788d59ecb2SHans Petter Selasky 
1798d59ecb2SHans Petter Selasky 	pause("WAIT", hz);
1808d59ecb2SHans Petter Selasky }
1818d59ecb2SHans Petter Selasky #endif
182