git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP_130/src/include/lwip/udp.h

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