src/include/lwip/udp.h

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