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#endif
35
36/* defines */
37#define USB_PRI_HIGHEST PI_SWI(SWI_TTY)
38#define USB_PRI_HIGH PI_SWI(SWI_NET)
39#define USB_PRI_MED PI_SWI(SWI_CAMBIO)
40
41#define USB_PROC_WAIT_TIMEOUT 2
42#define USB_PROC_WAIT_DRAIN 1
43#define USB_PROC_WAIT_NORMAL 0
44
45/* structure prototypes */
46
47struct usb_proc_msg;
48struct usb_device;
49
50/*
51 * The following structure defines the USB process.
52 */
53struct usb_process {
54 TAILQ_HEAD(, usb_proc_msg) up_qhead;
55 struct cv up_cv;
56 struct cv up_drain;
57
58 struct thread *up_ptr;
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
73uint8_t usb_proc_is_gone(struct usb_process *up);
74int usb_proc_create(struct usb_process *up, struct mtx *p_mtx,
75 const char *pmesg, uint8_t prio);
76void usb_proc_drain(struct usb_process *up);
77void usb_proc_mwait(struct usb_process *up, void *pm0, void *pm1);
78int usb_proc_mwait_sig(struct usb_process *up, void *pm0, void *pm1);
79void usb_proc_free(struct usb_process *up);
80void *usb_proc_msignal(struct usb_process *up, void *pm0, void *pm1);
81void usb_proc_rewakeup(struct usb_process *up);
82int usb_proc_is_called_from(struct usb_process *up);
83
84void usb_proc_explore_mwait(struct usb_device *, void *, void *);
85void *usb_proc_explore_msignal(struct usb_device *, void *, void *);
86void usb_proc_explore_lock(struct usb_device *);
87void usb_proc_explore_unlock(struct usb_device *);
88
89#endif /* _USB_PROCESS_H_ */