sys/dev/usb/usb_process.h

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