usb_process.h (2990B) - Raw
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 #ifndef _USB_PROCESS_H_ 29 #define _USB_PROCESS_H_ 30 31 #ifndef USB_GLOBAL_INCLUDE_FILE 32 #include <sys/interrupt.h> 33 #include <sys/priority.h> 34 #include <sys/runq.h> 35 #endif 36 37 /* defines */ 38 #define USB_PRI_HIGHEST PI_SWI(SWI_TTY) 39 #define USB_PRI_HIGH PI_SWI(SWI_NET) 40 #define USB_PRI_MED PI_SWI(SWI_CAMBIO) 41 42 #define USB_PROC_WAIT_TIMEOUT 2 43 #define USB_PROC_WAIT_DRAIN 1 44 #define USB_PROC_WAIT_NORMAL 0 45 46 /* structure prototypes */ 47 48 struct usb_proc_msg; 49 struct usb_device; 50 51 /* 52 * The following structure defines the USB process. 53 */ 54 struct usb_process { 55 TAILQ_HEAD(, usb_proc_msg) up_qhead; 56 struct cv up_cv; 57 struct cv up_drain; 58 59 struct thread *up_ptr; 60 struct thread *up_curtd; 61 struct mtx *up_mtx; 62 63 usb_size_t up_msg_num; 64 65 uint8_t up_prio; 66 uint8_t up_gone; 67 uint8_t up_msleep; 68 uint8_t up_csleep; 69 uint8_t up_dsleep; 70 }; 71 72 /* prototypes */ 73 74 uint8_t usb_proc_is_gone(struct usb_process *up); 75 int usb_proc_create(struct usb_process *up, struct mtx *p_mtx, 76 const char *pmesg, uint8_t prio); 77 void usb_proc_drain(struct usb_process *up); 78 void usb_proc_mwait(struct usb_process *up, void *pm0, void *pm1); 79 void usb_proc_free(struct usb_process *up); 80 void *usb_proc_msignal(struct usb_process *up, void *pm0, void *pm1); 81 void usb_proc_rewakeup(struct usb_process *up); 82 int usb_proc_is_called_from(struct usb_process *up); 83 84 void usb_proc_explore_mwait(struct usb_device *, void *, void *); 85 void *usb_proc_explore_msignal(struct usb_device *, void *, void *); 86 void usb_proc_explore_lock(struct usb_device *); 87 void usb_proc_explore_unlock(struct usb_device *); 88 89 #endif /* _USB_PROCESS_H_ */