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 #include <sys/interrupt.h>
  31 #include <sys/priority.h>
  32 #include <sys/runq.h>
  33
  34 /* defines */
  35 #define USB_PRI_HIGH    PI_SWI(SWI_NET)
  36 #define USB_PRI_MED     PI_SWI(SWI_CAMBIO)
  37
  38 #define USB_PROC_WAIT_TIMEOUT 2
  39 #define USB_PROC_WAIT_DRAIN   1
  40 #define USB_PROC_WAIT_NORMAL  0
  41
  42 /* structure prototypes */
  43
  44 struct usb_proc_msg;
  45 struct usb_device;
  46
  47 /*
  48  * The following structure defines the USB process.
  49  */
  50 struct usb_process {
  51         TAILQ_HEAD(, usb_proc_msg) up_qhead;
  52         struct cv up_cv;
  53         struct cv up_drain;
  54
  55 #if (__FreeBSD_version >= 800000)
  56         struct thread *up_ptr;
  57 #else
  58         struct proc *up_ptr;
  59 #endif
  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
  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
  88 #endif                                  /* _USB_PROCESS_H_ */