ZG2100 Network interface source
lwip/include/lwip/udp.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
- Child:
- 1:3a7c15057192
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_UDP_H__ |
donatien | 0:b802fc31f1db | 33 | #define __LWIP_UDP_H__ |
donatien | 0:b802fc31f1db | 34 | |
donatien | 0:b802fc31f1db | 35 | #include "lwip/opt.h" |
donatien | 0:b802fc31f1db | 36 | |
donatien | 0:b802fc31f1db | 37 | #if LWIP_UDP /* 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/netif.h" |
donatien | 0:b802fc31f1db | 41 | #include "lwip/ip_addr.h" |
donatien | 0:b802fc31f1db | 42 | #include "lwip/ip.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 | #define UDP_HLEN 8 |
donatien | 0:b802fc31f1db | 49 | |
donatien | 0:b802fc31f1db | 50 | /* Fields are (of course) in network byte order. */ |
donatien | 0:b802fc31f1db | 51 | #ifdef PACK_STRUCT_USE_INCLUDES |
donatien | 0:b802fc31f1db | 52 | # include "arch/bpstruct.h" |
donatien | 0:b802fc31f1db | 53 | #endif |
donatien | 0:b802fc31f1db | 54 | PACK_STRUCT_BEGIN |
donatien | 0:b802fc31f1db | 55 | struct udp_hdr { |
donatien | 0:b802fc31f1db | 56 | PACK_STRUCT_FIELD(u16_t src); |
donatien | 0:b802fc31f1db | 57 | PACK_STRUCT_FIELD(u16_t dest); /* src/dest UDP ports */ |
donatien | 0:b802fc31f1db | 58 | PACK_STRUCT_FIELD(u16_t len); |
donatien | 0:b802fc31f1db | 59 | PACK_STRUCT_FIELD(u16_t chksum); |
donatien | 0:b802fc31f1db | 60 | } PACK_STRUCT_STRUCT; |
donatien | 0:b802fc31f1db | 61 | PACK_STRUCT_END |
donatien | 0:b802fc31f1db | 62 | #ifdef PACK_STRUCT_USE_INCLUDES |
donatien | 0:b802fc31f1db | 63 | # include "arch/epstruct.h" |
donatien | 0:b802fc31f1db | 64 | #endif |
donatien | 0:b802fc31f1db | 65 | |
donatien | 0:b802fc31f1db | 66 | #define UDP_FLAGS_NOCHKSUM 0x01U |
donatien | 0:b802fc31f1db | 67 | #define UDP_FLAGS_UDPLITE 0x02U |
donatien | 0:b802fc31f1db | 68 | #define UDP_FLAGS_CONNECTED 0x04U |
donatien | 0:b802fc31f1db | 69 | |
donatien | 0:b802fc31f1db | 70 | struct udp_pcb; |
donatien | 0:b802fc31f1db | 71 | |
donatien | 0:b802fc31f1db | 72 | /** Function prototype for udp pcb receive callback functions |
donatien | 0:b802fc31f1db | 73 | * addr and port are in same byte order as in the pcb |
donatien | 0:b802fc31f1db | 74 | * The callback is responsible for freeing the pbuf |
donatien | 0:b802fc31f1db | 75 | * if it's not used any more. |
donatien | 0:b802fc31f1db | 76 | * |
donatien | 0:b802fc31f1db | 77 | * ATTENTION: Be aware that 'addr' points into the pbuf 'p' so freeing this pbuf |
donatien | 0:b802fc31f1db | 78 | * makes 'addr' invalid, too. |
donatien | 0:b802fc31f1db | 79 | * |
donatien | 0:b802fc31f1db | 80 | * @param arg user supplied argument (udp_pcb.recv_arg) |
donatien | 0:b802fc31f1db | 81 | * @param pcb the udp_pcb which received data |
donatien | 0:b802fc31f1db | 82 | * @param p the packet buffer that was received |
donatien | 0:b802fc31f1db | 83 | * @param addr the remote IP address from which the packet was received |
donatien | 0:b802fc31f1db | 84 | * @param port the remote port from which the packet was received |
donatien | 0:b802fc31f1db | 85 | */ |
donatien | 0:b802fc31f1db | 86 | typedef void (*udp_recv_fn)(void *arg, struct udp_pcb *pcb, struct pbuf *p, |
donatien | 0:b802fc31f1db | 87 | ip_addr_t *addr, u16_t port); |
donatien | 0:b802fc31f1db | 88 | |
donatien | 0:b802fc31f1db | 89 | |
donatien | 0:b802fc31f1db | 90 | struct udp_pcb { |
donatien | 0:b802fc31f1db | 91 | /* Common members of all PCB types */ |
donatien | 0:b802fc31f1db | 92 | IP_PCB; |
donatien | 0:b802fc31f1db | 93 | |
donatien | 0:b802fc31f1db | 94 | /* Protocol specific PCB members */ |
donatien | 0:b802fc31f1db | 95 | |
donatien | 0:b802fc31f1db | 96 | struct udp_pcb *next; |
donatien | 0:b802fc31f1db | 97 | |
donatien | 0:b802fc31f1db | 98 | u8_t flags; |
donatien | 0:b802fc31f1db | 99 | /** ports are in host byte order */ |
donatien | 0:b802fc31f1db | 100 | u16_t local_port, remote_port; |
donatien | 0:b802fc31f1db | 101 | |
donatien | 0:b802fc31f1db | 102 | #if LWIP_IGMP |
donatien | 0:b802fc31f1db | 103 | /** outgoing network interface for multicast packets */ |
donatien | 0:b802fc31f1db | 104 | ip_addr_t multicast_ip; |
donatien | 0:b802fc31f1db | 105 | #endif /* LWIP_IGMP */ |
donatien | 0:b802fc31f1db | 106 | |
donatien | 0:b802fc31f1db | 107 | #if LWIP_UDPLITE |
donatien | 0:b802fc31f1db | 108 | /** used for UDP_LITE only */ |
donatien | 0:b802fc31f1db | 109 | u16_t chksum_len_rx, chksum_len_tx; |
donatien | 0:b802fc31f1db | 110 | #endif /* LWIP_UDPLITE */ |
donatien | 0:b802fc31f1db | 111 | |
donatien | 0:b802fc31f1db | 112 | /** receive callback function */ |
donatien | 0:b802fc31f1db | 113 | udp_recv_fn recv; |
donatien | 0:b802fc31f1db | 114 | /** user-supplied argument for the recv callback */ |
donatien | 0:b802fc31f1db | 115 | void *recv_arg; |
donatien | 0:b802fc31f1db | 116 | }; |
donatien | 0:b802fc31f1db | 117 | /* udp_pcbs export for exernal reference (e.g. SNMP agent) */ |
donatien | 0:b802fc31f1db | 118 | extern struct udp_pcb *udp_pcbs; |
donatien | 0:b802fc31f1db | 119 | |
donatien | 0:b802fc31f1db | 120 | /* The following functions is the application layer interface to the |
donatien | 0:b802fc31f1db | 121 | UDP code. */ |
donatien | 0:b802fc31f1db | 122 | struct udp_pcb * udp_new (void); |
donatien | 0:b802fc31f1db | 123 | void udp_remove (struct udp_pcb *pcb); |
donatien | 0:b802fc31f1db | 124 | err_t udp_bind (struct udp_pcb *pcb, ip_addr_t *ipaddr, |
donatien | 0:b802fc31f1db | 125 | u16_t port); |
donatien | 0:b802fc31f1db | 126 | err_t udp_connect (struct udp_pcb *pcb, ip_addr_t *ipaddr, |
donatien | 0:b802fc31f1db | 127 | u16_t port); |
donatien | 0:b802fc31f1db | 128 | void udp_disconnect (struct udp_pcb *pcb); |
donatien | 0:b802fc31f1db | 129 | void udp_recv (struct udp_pcb *pcb, udp_recv_fn recv, |
donatien | 0:b802fc31f1db | 130 | void *recv_arg); |
donatien | 0:b802fc31f1db | 131 | err_t udp_sendto_if (struct udp_pcb *pcb, struct pbuf *p, |
donatien | 0:b802fc31f1db | 132 | ip_addr_t *dst_ip, u16_t dst_port, |
donatien | 0:b802fc31f1db | 133 | struct netif *netif); |
donatien | 0:b802fc31f1db | 134 | err_t udp_sendto (struct udp_pcb *pcb, struct pbuf *p, |
donatien | 0:b802fc31f1db | 135 | ip_addr_t *dst_ip, u16_t dst_port); |
donatien | 0:b802fc31f1db | 136 | err_t udp_send (struct udp_pcb *pcb, struct pbuf *p); |
donatien | 0:b802fc31f1db | 137 | |
donatien | 0:b802fc31f1db | 138 | #define udp_flags(pcb) ((pcb)->flags) |
donatien | 0:b802fc31f1db | 139 | #define udp_setflags(pcb, f) ((pcb)->flags = (f)) |
donatien | 0:b802fc31f1db | 140 | |
donatien | 0:b802fc31f1db | 141 | /* The following functions are the lower layer interface to UDP. */ |
donatien | 0:b802fc31f1db | 142 | void udp_input (struct pbuf *p, struct netif *inp); |
donatien | 0:b802fc31f1db | 143 | |
donatien | 0:b802fc31f1db | 144 | #define udp_init() /* Compatibility define, not init needed. */ |
donatien | 0:b802fc31f1db | 145 | |
donatien | 0:b802fc31f1db | 146 | #if UDP_DEBUG |
donatien | 0:b802fc31f1db | 147 | void udp_debug_print(struct udp_hdr *udphdr); |
donatien | 0:b802fc31f1db | 148 | #else |
donatien | 0:b802fc31f1db | 149 | #define udp_debug_print(udphdr) |
donatien | 0:b802fc31f1db | 150 | #endif |
donatien | 0:b802fc31f1db | 151 | |
donatien | 0:b802fc31f1db | 152 | #ifdef __cplusplus |
donatien | 0:b802fc31f1db | 153 | } |
donatien | 0:b802fc31f1db | 154 | #endif |
donatien | 0:b802fc31f1db | 155 | |
donatien | 0:b802fc31f1db | 156 | #endif /* LWIP_UDP */ |
donatien | 0:b802fc31f1db | 157 | |
donatien | 0:b802fc31f1db | 158 | #endif /* __LWIP_UDP_H__ */ |