Angel David Yaguana Hernandez / EthernetNetIf

Dependents:   RTnoV3 RTnoV3_LED RTnoV3_Template RTnoV3_ADC ... more

LPC1768/lwip/include/lwip/raw.h@0:479ce5546098, 2011-12-31 (annotated)

Committer:
sherckuith
Date:
Sat Dec 31 11:25:27 2011 +0000
Revision:
0:479ce5546098
Ethernet

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sherckuith 0:479ce5546098 1 /*
sherckuith 0:479ce5546098 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
sherckuith 0:479ce5546098 3 * All rights reserved.
sherckuith 0:479ce5546098 4 *
sherckuith 0:479ce5546098 5 * Redistribution and use in source and binary forms, with or without modification,
sherckuith 0:479ce5546098 6 * are permitted provided that the following conditions are met:
sherckuith 0:479ce5546098 7 *
sherckuith 0:479ce5546098 8 * 1. Redistributions of source code must retain the above copyright notice,
sherckuith 0:479ce5546098 9 * this list of conditions and the following disclaimer.
sherckuith 0:479ce5546098 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
sherckuith 0:479ce5546098 11 * this list of conditions and the following disclaimer in the documentation
sherckuith 0:479ce5546098 12 * and/or other materials provided with the distribution.
sherckuith 0:479ce5546098 13 * 3. The name of the author may not be used to endorse or promote products
sherckuith 0:479ce5546098 14 * derived from this software without specific prior written permission.
sherckuith 0:479ce5546098 15 *
sherckuith 0:479ce5546098 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
sherckuith 0:479ce5546098 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
sherckuith 0:479ce5546098 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
sherckuith 0:479ce5546098 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
sherckuith 0:479ce5546098 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
sherckuith 0:479ce5546098 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
sherckuith 0:479ce5546098 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
sherckuith 0:479ce5546098 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
sherckuith 0:479ce5546098 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
sherckuith 0:479ce5546098 25 * OF SUCH DAMAGE.
sherckuith 0:479ce5546098 26 *
sherckuith 0:479ce5546098 27 * This file is part of the lwIP TCP/IP stack.
sherckuith 0:479ce5546098 28 *
sherckuith 0:479ce5546098 29 * Author: Adam Dunkels <adam@sics.se>
sherckuith 0:479ce5546098 30 *
sherckuith 0:479ce5546098 31 */
sherckuith 0:479ce5546098 32 #ifndef __LWIP_RAW_H__
sherckuith 0:479ce5546098 33 #define __LWIP_RAW_H__
sherckuith 0:479ce5546098 34
sherckuith 0:479ce5546098 35 #include "lwip/opt.h"
sherckuith 0:479ce5546098 36
sherckuith 0:479ce5546098 37 #if LWIP_RAW /* don't build if not configured for use in lwipopts.h */
sherckuith 0:479ce5546098 38
sherckuith 0:479ce5546098 39 #include "lwip/pbuf.h"
sherckuith 0:479ce5546098 40 #include "lwip/def.h"
sherckuith 0:479ce5546098 41 #include "lwip/ip.h"
sherckuith 0:479ce5546098 42 #include "lwip/ip_addr.h"
sherckuith 0:479ce5546098 43
sherckuith 0:479ce5546098 44 #ifdef __cplusplus
sherckuith 0:479ce5546098 45 extern "C" {
sherckuith 0:479ce5546098 46 #endif
sherckuith 0:479ce5546098 47
sherckuith 0:479ce5546098 48 struct raw_pcb;
sherckuith 0:479ce5546098 49
sherckuith 0:479ce5546098 50 /** Function prototype for raw pcb receive callback functions.
sherckuith 0:479ce5546098 51 * @param arg user supplied argument (raw_pcb.recv_arg)
sherckuith 0:479ce5546098 52 * @param pcb the raw_pcb which received data
sherckuith 0:479ce5546098 53 * @param p the packet buffer that was received
sherckuith 0:479ce5546098 54 * @param addr the remote IP address from which the packet was received
sherckuith 0:479ce5546098 55 * @return 1 if the packet was 'eaten' (aka. deleted),
sherckuith 0:479ce5546098 56 * 0 if the packet lives on
sherckuith 0:479ce5546098 57 * If returning 1, the callback is responsible for freeing the pbuf
sherckuith 0:479ce5546098 58 * if it's not used any more.
sherckuith 0:479ce5546098 59 */
sherckuith 0:479ce5546098 60 typedef u8_t (*raw_recv_fn)(void *arg, struct raw_pcb *pcb, struct pbuf *p,
sherckuith 0:479ce5546098 61 ip_addr_t *addr);
sherckuith 0:479ce5546098 62
sherckuith 0:479ce5546098 63 struct raw_pcb {
sherckuith 0:479ce5546098 64 /* Common members of all PCB types */
sherckuith 0:479ce5546098 65 IP_PCB;
sherckuith 0:479ce5546098 66
sherckuith 0:479ce5546098 67 struct raw_pcb *next;
sherckuith 0:479ce5546098 68
sherckuith 0:479ce5546098 69 u8_t protocol;
sherckuith 0:479ce5546098 70
sherckuith 0:479ce5546098 71 /** receive callback function */
sherckuith 0:479ce5546098 72 raw_recv_fn recv;
sherckuith 0:479ce5546098 73 /* user-supplied argument for the recv callback */
sherckuith 0:479ce5546098 74 void *recv_arg;
sherckuith 0:479ce5546098 75 };
sherckuith 0:479ce5546098 76
sherckuith 0:479ce5546098 77 /* The following functions is the application layer interface to the
sherckuith 0:479ce5546098 78 RAW code. */
sherckuith 0:479ce5546098 79 struct raw_pcb * raw_new (u8_t proto);
sherckuith 0:479ce5546098 80 void raw_remove (struct raw_pcb *pcb);
sherckuith 0:479ce5546098 81 err_t raw_bind (struct raw_pcb *pcb, ip_addr_t *ipaddr);
sherckuith 0:479ce5546098 82 err_t raw_connect (struct raw_pcb *pcb, ip_addr_t *ipaddr);
sherckuith 0:479ce5546098 83
sherckuith 0:479ce5546098 84 void raw_recv (struct raw_pcb *pcb, raw_recv_fn recv, void *recv_arg);
sherckuith 0:479ce5546098 85 err_t raw_sendto (struct raw_pcb *pcb, struct pbuf *p, ip_addr_t *ipaddr);
sherckuith 0:479ce5546098 86 err_t raw_send (struct raw_pcb *pcb, struct pbuf *p);
sherckuith 0:479ce5546098 87
sherckuith 0:479ce5546098 88 /* The following functions are the lower layer interface to RAW. */
sherckuith 0:479ce5546098 89 u8_t raw_input (struct pbuf *p, struct netif *inp);
sherckuith 0:479ce5546098 90 #define raw_init() /* Compatibility define, not init needed. */
sherckuith 0:479ce5546098 91
sherckuith 0:479ce5546098 92 #ifdef __cplusplus
sherckuith 0:479ce5546098 93 }
sherckuith 0:479ce5546098 94 #endif
sherckuith 0:479ce5546098 95
sherckuith 0:479ce5546098 96 #endif /* LWIP_RAW */
sherckuith 0:479ce5546098 97
sherckuith 0:479ce5546098 98 #endif /* __LWIP_RAW_H__ */