xref: /freebsd/sys/dev/usb/usb_process.h (revision b3aaa0cc21c63d388230c7ef2a80abd631ff20d5)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef _USB2_PROCESS_H_
28 #define	_USB2_PROCESS_H_
29 
30 #include <sys/priority.h>
31 
32 /* defines */
33 #define	USB_PRI_HIGH PI_NET
34 #define	USB_PRI_MED PI_DISK
35 
36 #define	USB_PROC_WAIT_TIMEOUT 2
37 #define	USB_PROC_WAIT_DRAIN   1
38 #define	USB_PROC_WAIT_NORMAL  0
39 
40 /* structure prototypes */
41 
42 struct usb2_proc_msg;
43 
44 /* typedefs */
45 
46 typedef void (usb2_proc_callback_t)(struct usb2_proc_msg *hdr);
47 
48 /*
49  * The following structure defines the USB process message header.
50  */
51 struct usb2_proc_msg {
52 	TAILQ_ENTRY(usb2_proc_msg) pm_qentry;
53 	usb2_proc_callback_t *pm_callback;
54 	uint32_t pm_num;
55 };
56 
57 /*
58  * The following structure defines the USB process.
59  */
60 struct usb2_process {
61 	TAILQ_HEAD(, usb2_proc_msg) up_qhead;
62 	struct cv up_cv;
63 	struct cv up_drain;
64 
65 	struct proc *up_ptr;
66 	struct thread *up_curtd;
67 	struct mtx *up_mtx;
68 
69 	uint32_t up_msg_num;
70 
71 	uint8_t	up_prio;
72 	uint8_t	up_gone;
73 	uint8_t	up_msleep;
74 	uint8_t	up_csleep;
75 	uint8_t	up_dsleep;
76 };
77 
78 /* prototypes */
79 
80 uint8_t	usb2_proc_is_gone(struct usb2_process *up);
81 int	usb2_proc_create(struct usb2_process *up, struct mtx *p_mtx,
82 	    const char *pmesg, uint8_t prio);
83 void	usb2_proc_drain(struct usb2_process *up);
84 void	usb2_proc_mwait(struct usb2_process *up, void *pm0, void *pm1);
85 void	usb2_proc_free(struct usb2_process *up);
86 void   *usb2_proc_msignal(struct usb2_process *up, void *pm0, void *pm1);
87 
88 #endif					/* _USB2_PROCESS_H_ */
89