xref: /dflybsd-src/sys/bus/u4b/usb_process.h (revision 141a761f752c56ba19e8f908d8b270739f5f4578)
1*141a761fSMarkus Pfeiffer /* $FreeBSD: head/sys/dev/usb/usb_process.h 263423 2014-03-20 13:53:24Z hselasky $ */
212bd3c8bSSascha Wildner /*-
312bd3c8bSSascha Wildner  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
412bd3c8bSSascha Wildner  *
512bd3c8bSSascha Wildner  * Redistribution and use in source and binary forms, with or without
612bd3c8bSSascha Wildner  * modification, are permitted provided that the following conditions
712bd3c8bSSascha Wildner  * are met:
812bd3c8bSSascha Wildner  * 1. Redistributions of source code must retain the above copyright
912bd3c8bSSascha Wildner  *    notice, this list of conditions and the following disclaimer.
1012bd3c8bSSascha Wildner  * 2. Redistributions in binary form must reproduce the above copyright
1112bd3c8bSSascha Wildner  *    notice, this list of conditions and the following disclaimer in the
1212bd3c8bSSascha Wildner  *    documentation and/or other materials provided with the distribution.
1312bd3c8bSSascha Wildner  *
1412bd3c8bSSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1512bd3c8bSSascha Wildner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1612bd3c8bSSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1712bd3c8bSSascha Wildner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1812bd3c8bSSascha Wildner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1912bd3c8bSSascha Wildner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2012bd3c8bSSascha Wildner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2112bd3c8bSSascha Wildner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2212bd3c8bSSascha Wildner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2312bd3c8bSSascha Wildner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2412bd3c8bSSascha Wildner  * SUCH DAMAGE.
2512bd3c8bSSascha Wildner  */
2612bd3c8bSSascha Wildner 
2712bd3c8bSSascha Wildner #ifndef _USB_PROCESS_H_
2812bd3c8bSSascha Wildner #define	_USB_PROCESS_H_
2912bd3c8bSSascha Wildner 
3012bd3c8bSSascha Wildner #include <sys/interrupt.h>
31722d05c3SSascha Wildner #include <sys/signalvar.h>
32722d05c3SSascha Wildner #include <sys/thread.h>
3312bd3c8bSSascha Wildner 
3412bd3c8bSSascha Wildner /* defines */
35722d05c3SSascha Wildner #define	USB_PRI_HIGH	TDPRI_INT_HIGH
36722d05c3SSascha Wildner #define	USB_PRI_MED	TDPRI_INT_MED
3712bd3c8bSSascha Wildner 
3812bd3c8bSSascha Wildner #define	USB_PROC_WAIT_TIMEOUT 2
3912bd3c8bSSascha Wildner #define	USB_PROC_WAIT_DRAIN   1
4012bd3c8bSSascha Wildner #define	USB_PROC_WAIT_NORMAL  0
4112bd3c8bSSascha Wildner 
4212bd3c8bSSascha Wildner /* structure prototypes */
4312bd3c8bSSascha Wildner 
4412bd3c8bSSascha Wildner struct usb_proc_msg;
458922de18SMarkus Pfeiffer struct usb_device;
4612bd3c8bSSascha Wildner 
4712bd3c8bSSascha Wildner /*
4812bd3c8bSSascha Wildner  * The following structure defines the USB process.
4912bd3c8bSSascha Wildner  */
5012bd3c8bSSascha Wildner struct usb_process {
5112bd3c8bSSascha Wildner 	TAILQ_HEAD(, usb_proc_msg) up_qhead;
5212bd3c8bSSascha Wildner 	struct cv up_cv;
5312bd3c8bSSascha Wildner 	struct cv up_drain;
5412bd3c8bSSascha Wildner 
5512bd3c8bSSascha Wildner 	struct thread *up_ptr;
5612bd3c8bSSascha Wildner 	struct thread *up_curtd;
57722d05c3SSascha Wildner 	struct lock *up_lock;
5812bd3c8bSSascha Wildner 
5912bd3c8bSSascha Wildner 	usb_size_t up_msg_num;
6012bd3c8bSSascha Wildner 
6112bd3c8bSSascha Wildner 	uint8_t	up_prio;
6212bd3c8bSSascha Wildner 	uint8_t	up_gone;
6312bd3c8bSSascha Wildner 	uint8_t	up_msleep;
6412bd3c8bSSascha Wildner 	uint8_t	up_csleep;
6512bd3c8bSSascha Wildner 	uint8_t	up_dsleep;
6612bd3c8bSSascha Wildner };
6712bd3c8bSSascha Wildner 
6812bd3c8bSSascha Wildner /* prototypes */
6912bd3c8bSSascha Wildner 
7012bd3c8bSSascha Wildner uint8_t	usb_proc_is_gone(struct usb_process *up);
71722d05c3SSascha Wildner int	usb_proc_create(struct usb_process *up, struct lock *p_lock,
7212bd3c8bSSascha Wildner 	    const char *pmesg, uint8_t prio);
7312bd3c8bSSascha Wildner void	usb_proc_drain(struct usb_process *up);
7412bd3c8bSSascha Wildner void	usb_proc_mwait(struct usb_process *up, void *pm0, void *pm1);
7512bd3c8bSSascha Wildner void	usb_proc_free(struct usb_process *up);
7612bd3c8bSSascha Wildner void   *usb_proc_msignal(struct usb_process *up, void *pm0, void *pm1);
7712bd3c8bSSascha Wildner void	usb_proc_rewakeup(struct usb_process *up);
78*141a761fSMarkus Pfeiffer int	usb_proc_is_called_from(struct usb_process *up);
7912bd3c8bSSascha Wildner 
8057bed822SMarkus Pfeiffer void	usb_proc_explore_mwait(struct usb_device *, void *, void *);
8157bed822SMarkus Pfeiffer void   *usb_proc_explore_msignal(struct usb_device *, void *, void *);
8257bed822SMarkus Pfeiffer void	usb_proc_explore_lock(struct usb_device *);
8357bed822SMarkus Pfeiffer void	usb_proc_explore_unlock(struct usb_device *);
8457bed822SMarkus Pfeiffer 
8512bd3c8bSSascha Wildner #endif					/* _USB_PROCESS_H_ */
86