sys/dev/usb/usb_process.h

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