xref: /freebsd/sys/dev/usb/usb_error.c (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifdef USB_GLOBAL_INCLUDE_FILE
29 #include USB_GLOBAL_INCLUDE_FILE
30 #else
31 #include <sys/stdint.h>
32 #include <sys/stddef.h>
33 #include <sys/param.h>
34 #include <sys/queue.h>
35 #include <sys/types.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/bus.h>
39 #include <sys/module.h>
40 #include <sys/lock.h>
41 #include <sys/mutex.h>
42 #include <sys/condvar.h>
43 #include <sys/sysctl.h>
44 #include <sys/sx.h>
45 #include <sys/unistd.h>
46 #include <sys/callout.h>
47 #include <sys/malloc.h>
48 #include <sys/priv.h>
49 
50 #include <dev/usb/usb.h>
51 #include <dev/usb/usbdi.h>
52 #endif			/* USB_GLOBAL_INCLUDE_FILE */
53 
54 static const char* usb_errstr_table[USB_ERR_MAX] = {
55 	[USB_ERR_NORMAL_COMPLETION]	= "USB_ERR_NORMAL_COMPLETION",
56 	[USB_ERR_PENDING_REQUESTS]	= "USB_ERR_PENDING_REQUESTS",
57 	[USB_ERR_NOT_STARTED]		= "USB_ERR_NOT_STARTED",
58 	[USB_ERR_INVAL]			= "USB_ERR_INVAL",
59 	[USB_ERR_NOMEM]			= "USB_ERR_NOMEM",
60 	[USB_ERR_CANCELLED]		= "USB_ERR_CANCELLED",
61 	[USB_ERR_BAD_ADDRESS]		= "USB_ERR_BAD_ADDRESS",
62 	[USB_ERR_BAD_BUFSIZE]		= "USB_ERR_BAD_BUFSIZE",
63 	[USB_ERR_BAD_FLAG]		= "USB_ERR_BAD_FLAG",
64 	[USB_ERR_NO_CALLBACK]		= "USB_ERR_NO_CALLBACK",
65 	[USB_ERR_IN_USE]		= "USB_ERR_IN_USE",
66 	[USB_ERR_NO_ADDR]		= "USB_ERR_NO_ADDR",
67 	[USB_ERR_NO_PIPE]		= "USB_ERR_NO_PIPE",
68 	[USB_ERR_ZERO_NFRAMES]		= "USB_ERR_ZERO_NFRAMES",
69 	[USB_ERR_ZERO_MAXP]		= "USB_ERR_ZERO_MAXP",
70 	[USB_ERR_SET_ADDR_FAILED]	= "USB_ERR_SET_ADDR_FAILED",
71 	[USB_ERR_NO_POWER]		= "USB_ERR_NO_POWER",
72 	[USB_ERR_TOO_DEEP]		= "USB_ERR_TOO_DEEP",
73 	[USB_ERR_IOERROR]		= "USB_ERR_IOERROR",
74 	[USB_ERR_NOT_CONFIGURED]	= "USB_ERR_NOT_CONFIGURED",
75 	[USB_ERR_TIMEOUT]		= "USB_ERR_TIMEOUT",
76 	[USB_ERR_SHORT_XFER]		= "USB_ERR_SHORT_XFER",
77 	[USB_ERR_STALLED]		= "USB_ERR_STALLED",
78 	[USB_ERR_INTERRUPTED]		= "USB_ERR_INTERRUPTED",
79 	[USB_ERR_DMA_LOAD_FAILED]	= "USB_ERR_DMA_LOAD_FAILED",
80 	[USB_ERR_BAD_CONTEXT]		= "USB_ERR_BAD_CONTEXT",
81 	[USB_ERR_NO_ROOT_HUB]		= "USB_ERR_NO_ROOT_HUB",
82 	[USB_ERR_NO_INTR_THREAD]	= "USB_ERR_NO_INTR_THREAD",
83 	[USB_ERR_NOT_LOCKED]		= "USB_ERR_NOT_LOCKED",
84 };
85 
86 /*------------------------------------------------------------------------*
87  *	usbd_errstr
88  *
89  * This function converts an USB error code into a string.
90  *------------------------------------------------------------------------*/
91 const char *
92 usbd_errstr(usb_error_t err)
93 {
94 	return (err < USB_ERR_MAX ? usb_errstr_table[err] : "USB_ERR_UNKNOWN");
95 }
96