Nut/OS  4.10.3
API Reference
netbuf.h
Go to the documentation of this file.
00001 #ifndef _NET_NETBUF_H_
00002 #define _NET_NETBUF_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2003 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * -
00036  * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
00037  *
00038  * This file is distributed in the hope that it will be useful, but WITHOUT
00039  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00040  * FITNESS FOR A PARTICULAR PURPOSE.
00041  *
00042  * You can redistribute this file and/or modify it under the terms of the GNU
00043  * General Public License (GPL) as published by the Free Software Foundation;
00044  * either version 2 of the License, or (at your discretion) any later version.
00045  * See the accompanying file "copying-gpl.txt" for more details.
00046  *
00047  * As a special exception to the GPL, permission is granted for additional
00048  * uses of the text contained in this file.  See the accompanying file
00049  * "copying-liquorice.txt" for details.
00050  * -
00051  * Portions Copyright (c) 1983, 1993 by
00052  *  The Regents of the University of California.  All rights reserved.
00053  *
00054  * Redistribution and use in source and binary forms, with or without
00055  * modification, are permitted provided that the following conditions
00056  * are met:
00057  * 1. Redistributions of source code must retain the above copyright
00058  *    notice, this list of conditions and the following disclaimer.
00059  * 2. Redistributions in binary form must reproduce the above copyright
00060  *    notice, this list of conditions and the following disclaimer in the
00061  *    documentation and/or other materials provided with the distribution.
00062  * 3. Neither the name of the University nor the names of its contributors
00063  *    may be used to endorse or promote products derived from this software
00064  *    without specific prior written permission.
00065  *
00066  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00067  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00068  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00069  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00070  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00071  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00072  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00073  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00074  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00075  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00076  * SUCH DAMAGE.
00077  */
00078 
00079 /*
00080  * $Log$
00081  * Revision 1.5  2008/08/20 06:58:35  haraldkipp
00082  * Added a new flag to mark unicast packets.
00083  *
00084  * Revision 1.4  2008/08/11 06:59:59  haraldkipp
00085  * BSD types replaced by stdint types (feature request #1282721).
00086  *
00087  * Revision 1.3  2008/08/09 17:35:32  haraldkipp
00088  * Simplified NETBUF allocation and release.
00089  *
00090  * Revision 1.2  2008/04/18 13:31:59  haraldkipp
00091  * Changed size parameter from u_short to int, which is easier to handle
00092  * for 32-bit targets. You need to recompile your ARM code. No impact on
00093  * AVR expected
00094  * I changed u_int to int at some places to avoid some warnings during
00095  * compilation of Nut/Net.
00096  * libs.
00097  *
00098  * Revision 1.1.1.1  2003/05/09 14:41:07  haraldkipp
00099  * Initial using 3.2.1
00100  *
00101  * Revision 1.7  2003/05/06 18:43:03  harald
00102  * Cleanup
00103  *
00104  * Revision 1.6  2003/02/04 18:00:37  harald
00105  * Version 3 released
00106  *
00107  * Revision 1.5  2002/06/26 17:29:15  harald
00108  * First pre-release with 2.4 stack
00109  *
00110  */
00111 
00112 #include <sys/types.h>
00113 #include <stdint.h>
00114 
00124 
00125 
00126 /* lower bits may be used as ref-count, if ever needed */
00127 #define NBAF_REFCNT      0x07   
00129 #define NBAF_UNICAST     0x08   
00131 #define NBAF_DATALINK    0x10   
00132 #define NBAF_NETWORK     0x20   
00133 #define NBAF_TRANSPORT   0x40   
00134 #define NBAF_APPLICATION 0x80   
00135 #define NBAF_ALL         0xf0   
00140 typedef struct _NETBUF NETBUF;
00141 
00145 typedef struct _NBDATA NBDATA;
00146 
00151 struct _NBDATA {
00152     void *vp;   
00153     int  sz;    
00154 };
00155 
00160 struct _NETBUF {
00161     NETBUF *nb_next;    
00162     uint8_t nb_flags;   
00163     NBDATA nb_dl;       
00164     NBDATA nb_nw;       
00165     NBDATA nb_tp;       
00166     NBDATA nb_ap;       
00167     NETBUF *nb_ref;     
00168 };
00169 
00172 __BEGIN_DECLS
00173 
00174 extern NETBUF *NutNetBufAlloc(NETBUF *nb, uint8_t type, int size);
00175 extern NETBUF *NutNetBufClone(NETBUF *nb);
00176 extern NETBUF *NutNetBufClonePart(NETBUF *nb, uint8_t types);
00177 extern void NutNetBufFree(NETBUF *nb);
00178 extern int NutNetBufCollect(NETBUF * nbq, int total);
00179 
00180 __END_DECLS
00181 
00182 #endif