Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

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