drivers/net/npe/include/IxOsBuffPoolMgt.h

   1 /**
   2  * @file IxOsBuffPoolMgt.h (Replaced by OSAL)
   3  *
   4  * @date 9 Oct 2002
   5  *
   6  * @brief This file contains the mbuf pool implementation API
   7  *
   8  *
   9  * @par
  10  * IXP400 SW Release version 2.0
  11  *
  12  * -- Copyright Notice --
  13  *
  14  * @par
  15  * Copyright 2001-2005, Intel Corporation.
  16  * All rights reserved.
  17  *
  18  * @par
  19  * SPDX-License-Identifier:     BSD-3-Clause
  20  * @par
  21  * -- End of Copyright Notice --
  22  * This module contains the implementation of the OS Services buffer pool
  23  * management service.  This module provides routines for creating pools
  24  * of buffers for exchange of network data, getting and returning buffers
  25  * from and to the pool, and some other utility functions.
  26  * <P>
  27  * Currently, the pool has 2 underlying implementations - one for the vxWorks
  28  * OS, and another which attempts to be OS-agnostic so that it can be used on
  29  * other OS's such as Linux.  The API is largely the same for all OS's,
  30  * but there are some differences to be aware of.  These are documented
  31  * in the API descriptions below.
  32  * <P>
  33  * The most significant difference is this: when this module is used with
  34  * the WindRiver VxWorks OS, it will create a pool of vxWorks "MBufs".
  35  * These can be used directly with the vxWorks "netBufLib" OS Library.
  36  * For other OS's, it will create a pool of generic buffers.  These may need
  37  * to be converted into other buffer types (sk_buff's in Linux, for example)
  38  * before being used with any built-in OS routines available for
  39  * manipulating network data buffers.
  40  *
  41  * @sa IxOsBuffMgt.h
  42  */
  43
  44 #ifndef IXOSBUFFPOOLMGT_H
  45 #define IXOSBUFFPOOLMGT_H
  46
  47 #include "IxOsalBackward.h"
  48
  49 #endif  /* IXOSBUFFPOOLMGT_H */
  50