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 #if (defined(__MWERKS__)  || defined(__CWCC__))\r
  56         #pragma options align= packed\r
  57 #endif\r
  58 struct udp_hdr {\r
  59   PACK_STRUCT_FIELD(u16_t src);\r
  60   PACK_STRUCT_FIELD(u16_t dest);  /* src/dest UDP ports */\r
  61   PACK_STRUCT_FIELD(u16_t len);\r
  62   PACK_STRUCT_FIELD(u16_t chksum);\r
  63 } PACK_STRUCT_STRUCT;\r
  64 PACK_STRUCT_END\r
  65 #ifdef PACK_STRUCT_USE_INCLUDES\r
  66 #  include "arch/epstruct.h"\r
  67 #endif\r
  68 \r
  69 #define UDP_FLAGS_NOCHKSUM 0x01U\r
  70 #define UDP_FLAGS_UDPLITE  0x02U\r
  71 #define UDP_FLAGS_CONNECTED  0x04U\r
  72 \r
  73 struct udp_pcb {\r
  74 /* Common members of all PCB types */\r
  75   IP_PCB;\r
  76 \r
  77 /* Protocol specific PCB members */\r
  78 \r
  79   struct udp_pcb *next;\r
  80 \r
  81   u8_t flags;\r
  82   /* ports are in host byte order */\r
  83   u16_t local_port, remote_port;\r
  84 \r
  85 #if LWIP_IGMP\r
  86   /* outgoing network interface for multicast packets */\r
  87   struct ip_addr multicast_ip;\r
  88 #endif /* LWIP_IGMP */\r
  89 \r
  90 #if LWIP_UDPLITE\r
  91   /* used for UDP_LITE only */\r
  92   u16_t chksum_len_rx, chksum_len_tx;\r
  93 #endif /* LWIP_UDPLITE */\r
  94 \r
  95   /* receive callback function\r
  96    * addr and port are in same byte order as in the pcb\r
  97    * The callback is responsible for freeing the pbuf\r
  98    * if it's not used any more.\r
  99    *\r
 100    * @param arg user supplied argument (udp_pcb.recv_arg)\r
 101    * @param pcb the udp_pcb which received data\r
 102    * @param p the packet buffer that was received\r
 103    * @param addr the remote IP address from which the packet was received\r
 104    * @param port the remote port from which the packet was received\r
 105    */\r
 106   void (* recv)(void *arg, struct udp_pcb *pcb, struct pbuf *p,\r
 107     struct ip_addr *addr, u16_t port);\r
 108   /* user-supplied argument for the recv callback */\r
 109   void *recv_arg;\r
 110 };\r
 111 /* udp_pcbs export for exernal reference (e.g. SNMP agent) */\r
 112 extern struct udp_pcb *udp_pcbs;\r
 113 \r
 114 /* The following functions is the application layer interface to the\r
 115    UDP code. */\r
 116 struct udp_pcb * udp_new        (void);\r
 117 void             udp_remove     (struct udp_pcb *pcb);\r
 118 err_t            udp_bind       (struct udp_pcb *pcb, struct ip_addr *ipaddr,\r
 119                  u16_t port);\r
 120 err_t            udp_connect    (struct udp_pcb *pcb, struct ip_addr *ipaddr,\r
 121                  u16_t port);\r
 122 void             udp_disconnect    (struct udp_pcb *pcb);\r
 123 void             udp_recv       (struct udp_pcb *pcb,\r
 124          void (* recv)(void *arg, struct udp_pcb *upcb,\r
 125                  struct pbuf *p,\r
 126                  struct ip_addr *addr,\r
 127                  u16_t port),\r
 128          void *recv_arg);\r
 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);\r
 130 err_t            udp_sendto     (struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *dst_ip, u16_t dst_port);\r
 131 err_t            udp_send       (struct udp_pcb *pcb, struct pbuf *p);\r
 132 \r
 133 #define          udp_flags(pcb)  ((pcb)->flags)\r
 134 #define          udp_setflags(pcb, f)  ((pcb)->flags = (f))\r
 135 \r
 136 /* The following functions are the lower layer interface to UDP. */\r
 137 void             udp_input      (struct pbuf *p, struct netif *inp);\r
 138 \r
 139 #define udp_init() /* Compatibility define, not init needed. */\r
 140 \r
 141 #if UDP_DEBUG\r
 142 void udp_debug_print(struct udp_hdr *udphdr);\r
 143 #else\r
 144 #define udp_debug_print(udphdr)\r
 145 #endif\r
 146 \r
 147 #ifdef __cplusplus\r
 148 }\r
 149 #endif\r
 150 \r
 151 #endif /* LWIP_UDP */\r
 152 \r
 153 #endif /* __LWIP_UDP_H__ */\r