sys/sys/mbpool.h

   1 /*
   2  * Copyright (c) 2003
   3  *      Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   4  *      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  * Author: Hartmut Brandt <harti@freebsd.org>
  28  *
  29  * This implements pools of DMA-able buffers that conserve DMA address space
  30  * by putting several buffers into one page and that allow to map between
  31  * 32-bit handles for the buffer and buffer addresses (to use 32-bit network
  32  * interfaces on 64bit machines). This assists network interfaces that may need
  33  * huge numbers of mbufs.
  34  *
  35  * $FreeBSD$
  36  */
  37 #ifndef _SYS_MBPOOL_H_
  38 #define _SYS_MBPOOL_H_
  39
  40 #ifdef _KERNEL
  41
  42 #include <sys/queue.h>
  43
  44 /* opaque */
  45 struct mbpool;
  46
  47 /* size of reserved area at end of each chunk */
  48 #define MBPOOL_TRAILER_SIZE     4
  49
  50 /* maximum value of max_pages */
  51 #define MBPOOL_MAX_MAXPAGES     ((1 << 14) - 1)
  52
  53 /* maximum number of chunks per page */
  54 #define MBPOOL_MAX_CHUNKS       (1 << 9)
  55
  56 /* initialize a pool */
  57 int mbp_create(struct mbpool **, const char *, bus_dma_tag_t, u_int,
  58         size_t, size_t);
  59
  60 /* destroy a pool */
  61 void mbp_destroy(struct mbpool *);
  62
  63 /* allocate a chunk and set used and on card */
  64 void *mbp_alloc(struct mbpool *, bus_addr_t *, uint32_t *);
  65
  66 /* free a chunk */
  67 void mbp_free(struct mbpool *, void *);
  68
  69 /* free a chunk that is an external mbuf */
  70 void mbp_ext_free(void *, void *);
  71
  72 /* free all buffers that are marked to be on the card */
  73 void mbp_card_free(struct mbpool *);
  74
  75 /* count used buffers and buffers on card */
  76 void mbp_count(struct mbpool *, u_int *, u_int *, u_int *);
  77
  78 /* get the buffer from a handle and clear card bit */
  79 void *mbp_get(struct mbpool *, uint32_t);
  80
  81 /* get the buffer from a handle and don't clear card bit */
  82 void *mbp_get_keep(struct mbpool *, uint32_t);
  83
  84 /* sync the chunk */
  85 void mbp_sync(struct mbpool *, uint32_t, bus_addr_t, bus_size_t, u_int);
  86
  87 #endif  /* _KERNEL */
  88 #endif  /* _SYS_MBPOOL_H_ */