mbed unsupported / lwip

A version of LWIP, provided for backwards compatibility.

Dependents:   AA_DemoBoard DemoBoard HelloServerDemo DemoBoard_RangeIndicator ... more

trunk/Core/lwIP/include/lwip/udp.h@0:5e1631496985, 2012-05-08 (annotated)

Committer:
root@mbed.org
Date:
Tue May 08 15:32:10 2012 +0100
Revision:
0:5e1631496985
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
root@mbed.org 0:5e1631496985 1 /*
root@mbed.org 0:5e1631496985 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
root@mbed.org 0:5e1631496985 3 * All rights reserved.
root@mbed.org 0:5e1631496985 4 *
root@mbed.org 0:5e1631496985 5 * Redistribution and use in source and binary forms, with or without modification,
root@mbed.org 0:5e1631496985 6 * are permitted provided that the following conditions are met:
root@mbed.org 0:5e1631496985 7 *
root@mbed.org 0:5e1631496985 8 * 1. Redistributions of source code must retain the above copyright notice,
root@mbed.org 0:5e1631496985 9 * this list of conditions and the following disclaimer.
root@mbed.org 0:5e1631496985 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
root@mbed.org 0:5e1631496985 11 * this list of conditions and the following disclaimer in the documentation
root@mbed.org 0:5e1631496985 12 * and/or other materials provided with the distribution.
root@mbed.org 0:5e1631496985 13 * 3. The name of the author may not be used to endorse or promote products
root@mbed.org 0:5e1631496985 14 * derived from this software without specific prior written permission.
root@mbed.org 0:5e1631496985 15 *
root@mbed.org 0:5e1631496985 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
root@mbed.org 0:5e1631496985 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
root@mbed.org 0:5e1631496985 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
root@mbed.org 0:5e1631496985 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
root@mbed.org 0:5e1631496985 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
root@mbed.org 0:5e1631496985 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
root@mbed.org 0:5e1631496985 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
root@mbed.org 0:5e1631496985 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
root@mbed.org 0:5e1631496985 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
root@mbed.org 0:5e1631496985 25 * OF SUCH DAMAGE.
root@mbed.org 0:5e1631496985 26 *
root@mbed.org 0:5e1631496985 27 * This file is part of the lwIP TCP/IP stack.
root@mbed.org 0:5e1631496985 28 *
root@mbed.org 0:5e1631496985 29 * Author: Adam Dunkels <adam@sics.se>
root@mbed.org 0:5e1631496985 30 *
root@mbed.org 0:5e1631496985 31 */
root@mbed.org 0:5e1631496985 32 #ifndef __LWIP_UDP_H__
root@mbed.org 0:5e1631496985 33 #define __LWIP_UDP_H__
root@mbed.org 0:5e1631496985 34
root@mbed.org 0:5e1631496985 35 #include "lwip/opt.h"
root@mbed.org 0:5e1631496985 36
root@mbed.org 0:5e1631496985 37 #if LWIP_UDP /* don't build if not configured for use in lwipopts.h */
root@mbed.org 0:5e1631496985 38
root@mbed.org 0:5e1631496985 39 #include "lwip/pbuf.h"
root@mbed.org 0:5e1631496985 40 #include "lwip/netif.h"
root@mbed.org 0:5e1631496985 41 #include "lwip/ip_addr.h"
root@mbed.org 0:5e1631496985 42 #include "lwip/ip.h"
root@mbed.org 0:5e1631496985 43
root@mbed.org 0:5e1631496985 44 #ifdef __cplusplus
root@mbed.org 0:5e1631496985 45 extern "C" {
root@mbed.org 0:5e1631496985 46 #endif
root@mbed.org 0:5e1631496985 47
root@mbed.org 0:5e1631496985 48 #define UDP_HLEN 8
root@mbed.org 0:5e1631496985 49
root@mbed.org 0:5e1631496985 50 /* Fields are (of course) in network byte order. */
root@mbed.org 0:5e1631496985 51 #ifdef PACK_STRUCT_USE_INCLUDES
root@mbed.org 0:5e1631496985 52 # include "arch/bpstruct.h"
root@mbed.org 0:5e1631496985 53 #endif
root@mbed.org 0:5e1631496985 54 PACK_STRUCT_BEGIN
root@mbed.org 0:5e1631496985 55 struct udp_hdr {
root@mbed.org 0:5e1631496985 56 PACK_STRUCT_FIELD(u16_t src);
root@mbed.org 0:5e1631496985 57 PACK_STRUCT_FIELD(u16_t dest); /* src/dest UDP ports */
root@mbed.org 0:5e1631496985 58 PACK_STRUCT_FIELD(u16_t len);
root@mbed.org 0:5e1631496985 59 PACK_STRUCT_FIELD(u16_t chksum);
root@mbed.org 0:5e1631496985 60 } PACK_STRUCT_STRUCT;
root@mbed.org 0:5e1631496985 61 PACK_STRUCT_END
root@mbed.org 0:5e1631496985 62 #ifdef PACK_STRUCT_USE_INCLUDES
root@mbed.org 0:5e1631496985 63 # include "arch/epstruct.h"
root@mbed.org 0:5e1631496985 64 #endif
root@mbed.org 0:5e1631496985 65
root@mbed.org 0:5e1631496985 66 #define UDP_FLAGS_NOCHKSUM 0x01U
root@mbed.org 0:5e1631496985 67 #define UDP_FLAGS_UDPLITE 0x02U
root@mbed.org 0:5e1631496985 68 #define UDP_FLAGS_CONNECTED 0x04U
root@mbed.org 0:5e1631496985 69
root@mbed.org 0:5e1631496985 70 struct udp_pcb {
root@mbed.org 0:5e1631496985 71 /* Common members of all PCB types */
root@mbed.org 0:5e1631496985 72 IP_PCB;
root@mbed.org 0:5e1631496985 73
root@mbed.org 0:5e1631496985 74 /* Protocol specific PCB members */
root@mbed.org 0:5e1631496985 75
root@mbed.org 0:5e1631496985 76 struct udp_pcb *next;
root@mbed.org 0:5e1631496985 77
root@mbed.org 0:5e1631496985 78 u8_t flags;
root@mbed.org 0:5e1631496985 79 /* ports are in host byte order */
root@mbed.org 0:5e1631496985 80 u16_t local_port, remote_port;
root@mbed.org 0:5e1631496985 81
root@mbed.org 0:5e1631496985 82 #if LWIP_IGMP
root@mbed.org 0:5e1631496985 83 /* outgoing network interface for multicast packets */
root@mbed.org 0:5e1631496985 84 struct ip_addr multicast_ip;
root@mbed.org 0:5e1631496985 85 #endif /* LWIP_IGMP */
root@mbed.org 0:5e1631496985 86
root@mbed.org 0:5e1631496985 87 #if LWIP_UDPLITE
root@mbed.org 0:5e1631496985 88 /* used for UDP_LITE only */
root@mbed.org 0:5e1631496985 89 u16_t chksum_len_rx, chksum_len_tx;
root@mbed.org 0:5e1631496985 90 #endif /* LWIP_UDPLITE */
root@mbed.org 0:5e1631496985 91
root@mbed.org 0:5e1631496985 92 /* receive callback function
root@mbed.org 0:5e1631496985 93 * addr and port are in same byte order as in the pcb
root@mbed.org 0:5e1631496985 94 * The callback is responsible for freeing the pbuf
root@mbed.org 0:5e1631496985 95 * if it's not used any more.
root@mbed.org 0:5e1631496985 96 *
root@mbed.org 0:5e1631496985 97 * ATTENTION: Be aware that 'addr' points into the pbuf 'p' so freeing this pbuf
root@mbed.org 0:5e1631496985 98 * makes 'addr' invalid, too.
root@mbed.org 0:5e1631496985 99 *
root@mbed.org 0:5e1631496985 100 * @param arg user supplied argument (udp_pcb.recv_arg)
root@mbed.org 0:5e1631496985 101 * @param pcb the udp_pcb which received data
root@mbed.org 0:5e1631496985 102 * @param p the packet buffer that was received
root@mbed.org 0:5e1631496985 103 * @param addr the remote IP address from which the packet was received
root@mbed.org 0:5e1631496985 104 * @param port the remote port from which the packet was received
root@mbed.org 0:5e1631496985 105 */
root@mbed.org 0:5e1631496985 106 void (* recv)(void *arg, struct udp_pcb *pcb, struct pbuf *p,
root@mbed.org 0:5e1631496985 107 struct ip_addr *addr, u16_t port);
root@mbed.org 0:5e1631496985 108 /* user-supplied argument for the recv callback */
root@mbed.org 0:5e1631496985 109 void *recv_arg;
root@mbed.org 0:5e1631496985 110 };
root@mbed.org 0:5e1631496985 111 /* udp_pcbs export for exernal reference (e.g. SNMP agent) */
root@mbed.org 0:5e1631496985 112 extern struct udp_pcb *udp_pcbs;
root@mbed.org 0:5e1631496985 113
root@mbed.org 0:5e1631496985 114 /* The following functions is the application layer interface to the
root@mbed.org 0:5e1631496985 115 UDP code. */
root@mbed.org 0:5e1631496985 116 struct udp_pcb * udp_new (void);
root@mbed.org 0:5e1631496985 117 void udp_remove (struct udp_pcb *pcb);
root@mbed.org 0:5e1631496985 118 err_t udp_bind (struct udp_pcb *pcb, struct ip_addr *ipaddr,
root@mbed.org 0:5e1631496985 119 u16_t port);
root@mbed.org 0:5e1631496985 120 err_t udp_connect (struct udp_pcb *pcb, struct ip_addr *ipaddr,
root@mbed.org 0:5e1631496985 121 u16_t port);
root@mbed.org 0:5e1631496985 122 void udp_disconnect (struct udp_pcb *pcb);
root@mbed.org 0:5e1631496985 123 void udp_recv (struct udp_pcb *pcb,
root@mbed.org 0:5e1631496985 124 void (* recv)(void *arg, struct udp_pcb *upcb,
root@mbed.org 0:5e1631496985 125 struct pbuf *p,
root@mbed.org 0:5e1631496985 126 struct ip_addr *addr,
root@mbed.org 0:5e1631496985 127 u16_t port),
root@mbed.org 0:5e1631496985 128 void *recv_arg);
root@mbed.org 0:5e1631496985 129 err_t udp_sendto_if (struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *dst_ip, u16_t dst_port, struct netif *netif);
root@mbed.org 0:5e1631496985 130 err_t udp_sendto (struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *dst_ip, u16_t dst_port);
root@mbed.org 0:5e1631496985 131 err_t udp_send (struct udp_pcb *pcb, struct pbuf *p);
root@mbed.org 0:5e1631496985 132
root@mbed.org 0:5e1631496985 133 #define udp_flags(pcb) ((pcb)->flags)
root@mbed.org 0:5e1631496985 134 #define udp_setflags(pcb, f) ((pcb)->flags = (f))
root@mbed.org 0:5e1631496985 135
root@mbed.org 0:5e1631496985 136 /* The following functions are the lower layer interface to UDP. */
root@mbed.org 0:5e1631496985 137 void udp_input (struct pbuf *p, struct netif *inp);
root@mbed.org 0:5e1631496985 138
root@mbed.org 0:5e1631496985 139 #define udp_init() /* Compatibility define, not init needed. */
root@mbed.org 0:5e1631496985 140
root@mbed.org 0:5e1631496985 141 #if UDP_DEBUG
root@mbed.org 0:5e1631496985 142 void udp_debug_print(struct udp_hdr *udphdr);
root@mbed.org 0:5e1631496985 143 #else
root@mbed.org 0:5e1631496985 144 #define udp_debug_print(udphdr)
root@mbed.org 0:5e1631496985 145 #endif
root@mbed.org 0:5e1631496985 146
root@mbed.org 0:5e1631496985 147 #ifdef __cplusplus
root@mbed.org 0:5e1631496985 148 }
root@mbed.org 0:5e1631496985 149 #endif
root@mbed.org 0:5e1631496985 150
root@mbed.org 0:5e1631496985 151 #endif /* LWIP_UDP */
root@mbed.org 0:5e1631496985 152
root@mbed.org 0:5e1631496985 153 #endif /* __LWIP_UDP_H__ */