1 /* $FreeBSD: releng/12.2/sys/dev/usb/usb_process.h 326255 2017-11-27 14:52:40Z pfg $ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 4 * 5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _USB_PROCESS_H_ 30 #define _USB_PROCESS_H_ 31 32 /* defines */ 33 #define USB_PRI_HIGHEST 1 34 #define USB_PRI_HIGH 2 35 #define USB_PRI_MED 5 36 37 #define USB_PROC_WAIT_TIMEOUT 2 38 #define USB_PROC_WAIT_DRAIN 1 39 #define USB_PROC_WAIT_NORMAL 0 40 41 /* structure prototypes */ 42 43 struct usb_proc_msg; 44 struct usb_device; 45 46 /* 47 * The following structure defines the USB process. 48 */ 49 struct usb_process { 50 TAILQ_HEAD(, usb_proc_msg) up_qhead; 51 struct cv up_cv; 52 struct cv up_drain; 53 54 #if (__FreeBSD_version >= 800000) 55 struct thread *up_ptr; 56 #else 57 struct proc *up_ptr; 58 #endif 59 struct thread *up_curtd; 60 struct mtx *up_mtx; 61 62 usb_size_t up_msg_num; 63 64 uint8_t up_prio; 65 uint8_t up_gone; 66 uint8_t up_msleep; 67 uint8_t up_csleep; 68 uint8_t up_dsleep; 69 }; 70 71 /* prototypes */ 72 73 uint8_t usb_proc_is_gone(struct usb_process *up); 74 int usb_proc_create(struct usb_process *up, struct mtx *p_mtx, 75 const char *pmesg, uint8_t prio); 76 void usb_proc_drain(struct usb_process *up); 77 void usb_proc_mwait(struct usb_process *up, void *pm0, void *pm1); 78 void usb_proc_free(struct usb_process *up); 79 void *usb_proc_msignal(struct usb_process *up, void *pm0, void *pm1); 80 void usb_proc_rewakeup(struct usb_process *up); 81 int usb_proc_is_called_from(struct usb_process *up); 82 83 void usb_proc_explore_mwait(struct usb_device *, void *, void *); 84 void *usb_proc_explore_msignal(struct usb_device *, void *, void *); 85 void usb_proc_explore_lock(struct usb_device *); 86 void usb_proc_explore_unlock(struct usb_device *); 87 unsigned int usb_os_task_creat(pthread_t *taskid, TSK_ENTRY_FUNC func, unsigned int prio, const char *nm, UINTPTR para); 88 unsigned int usb_os_task_delete(pthread_t taskid); 89 90 #endif /* _USB_PROCESS_H_ */ 91