sys/bus/u4b/usb_mbuf.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_MBUF_H_
  28 #define _USB_MBUF_H_
  29
  30 /*
  31  * The following structure defines a minimum re-implementation of the
  32  * mbuf system in the kernel.
  33  */
  34 struct usb_mbuf {
  35         uint8_t *cur_data_ptr;
  36         uint8_t *min_data_ptr;
  37         struct usb_mbuf *usb_nextpkt;
  38         struct usb_mbuf *usb_next;
  39
  40         usb_size_t cur_data_len;
  41         usb_size_t max_data_len;
  42         uint8_t last_packet:1;
  43         uint8_t unused:7;
  44 };
  45
  46 #define USB_IF_ENQUEUE(ifq, m) do {             \
  47     (m)->usb_nextpkt = NULL;                    \
  48     if ((ifq)->ifq_tail == NULL)                \
  49         (ifq)->ifq_head = (m);                  \
  50     else                                        \
  51         (ifq)->ifq_tail->usb_nextpkt = (m);     \
  52     (ifq)->ifq_tail = (m);                      \
  53     (ifq)->ifq_len++;                           \
  54   } while (0)
  55
  56 #define USB_IF_DEQUEUE(ifq, m) do {                             \
  57     (m) = (ifq)->ifq_head;                                      \
  58     if (m) {                                                    \
  59         if (((ifq)->ifq_head = (m)->usb_nextpkt) == NULL) {     \
  60              (ifq)->ifq_tail = NULL;                            \
  61         }                                                       \
  62         (m)->usb_nextpkt = NULL;                                \
  63         (ifq)->ifq_len--;                                       \
  64     }                                                           \
  65   } while (0)
  66
  67 #define USB_IF_PREPEND(ifq, m) do {             \
  68       (m)->usb_nextpkt = (ifq)->ifq_head;       \
  69       if ((ifq)->ifq_tail == NULL) {            \
  70           (ifq)->ifq_tail = (m);                \
  71       }                                         \
  72       (ifq)->ifq_head = (m);                    \
  73       (ifq)->ifq_len++;                         \
  74   } while (0)
  75
  76 #define USB_IF_QFULL(ifq)   ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
  77 #define USB_IF_QLEN(ifq)    ((ifq)->ifq_len)
  78 #define USB_IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
  79
  80 #define USB_MBUF_RESET(m) do {                  \
  81     (m)->cur_data_ptr = (m)->min_data_ptr;      \
  82     (m)->cur_data_len = (m)->max_data_len;      \
  83     (m)->last_packet = 0;                       \
  84   } while (0)
  85
  86 /* prototypes */
  87 void   *usb_alloc_mbufs(struct malloc_type *type, struct usb_ifqueue *ifq,
  88             usb_size_t block_size, uint16_t nblocks);
  89
  90 #endif                                  /* _USB_MBUF_H_ */