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