blob: 4a983c79116559c520234d11f24bd3ce8dc5395d [file] [log] [blame]
Wolfgang Denkba94a1b2006-05-30 15:56:48 +02001/**
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 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
27 * 3. Neither the name of the Intel Corporation nor the names of its contributors
28 * may be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * @par
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
33 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
36 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 * SUCH DAMAGE.
43 *
44 * @par
45 * -- End of Copyright Notice --
46 * This module contains the implementation of the OS Services buffer pool
47 * management service. This module provides routines for creating pools
48 * of buffers for exchange of network data, getting and returning buffers
49 * from and to the pool, and some other utility functions.
50 * <P>
51 * Currently, the pool has 2 underlying implementations - one for the vxWorks
52 * OS, and another which attempts to be OS-agnostic so that it can be used on
53 * other OS's such as Linux. The API is largely the same for all OS's,
54 * but there are some differences to be aware of. These are documented
55 * in the API descriptions below.
56 * <P>
57 * The most significant difference is this: when this module is used with
58 * the WindRiver VxWorks OS, it will create a pool of vxWorks "MBufs".
59 * These can be used directly with the vxWorks "netBufLib" OS Library.
60 * For other OS's, it will create a pool of generic buffers. These may need
61 * to be converted into other buffer types (sk_buff's in Linux, for example)
62 * before being used with any built-in OS routines available for
63 * manipulating network data buffers.
64 *
65 * @sa IxOsBuffMgt.h
66 */
67
68#ifndef IXOSBUFFPOOLMGT_H
69#define IXOSBUFFPOOLMGT_H
70
71#include "IxOsalBackward.h"
72
73#endif /* IXOSBUFFPOOLMGT_H */
74