FreeRTOS/Common/ethernet/lwIP/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/arch.h"
  36
  37 #include "lwip/pbuf.h"
  38 #include "lwip/inet.h"
  39 #include "lwip/ip.h"
  40
  41 #define UDP_HLEN 8
  42
  43 struct udp_hdr {
  44   PACK_STRUCT_FIELD(u16_t src);
  45   PACK_STRUCT_FIELD(u16_t dest);  /* src/dest UDP ports */
  46   PACK_STRUCT_FIELD(u16_t len);
  47   PACK_STRUCT_FIELD(u16_t chksum);
  48 } PACK_STRUCT_STRUCT;
  49
  50 #define UDP_FLAGS_NOCHKSUM 0x01U
  51 #define UDP_FLAGS_UDPLITE  0x02U
  52 #define UDP_FLAGS_CONNECTED  0x04U
  53
  54 struct udp_pcb {
  55 /* Common members of all PCB types */
  56   IP_PCB;
  57
  58 /* Protocol specific PCB members */
  59
  60   struct udp_pcb *next;
  61
  62   u8_t flags;
  63   u16_t local_port, remote_port;
  64
  65   u16_t chksum_len;
  66
  67   void (* recv)(void *arg, struct udp_pcb *pcb, struct pbuf *p,
  68     struct ip_addr *addr, u16_t port);
  69   void *recv_arg;
  70 };
  71 /* udp_pcbs export for exernal reference (e.g. SNMP agent) */
  72 extern struct udp_pcb *udp_pcbs;
  73
  74 /* The following functions is the application layer interface to the
  75    UDP code. */
  76 struct udp_pcb * udp_new        (void);
  77 void             udp_remove     (struct udp_pcb *pcb);
  78 err_t            udp_bind       (struct udp_pcb *pcb, struct ip_addr *ipaddr,
  79                  u16_t port);
  80 err_t            udp_connect    (struct udp_pcb *pcb, struct ip_addr *ipaddr,
  81                  u16_t port);
  82 void             udp_disconnect    (struct udp_pcb *pcb);
  83 void             udp_recv       (struct udp_pcb *pcb,
  84          void (* recv)(void *arg, struct udp_pcb *upcb,
  85                  struct pbuf *p,
  86                  struct ip_addr *addr,
  87                  u16_t port),
  88          void *recv_arg);
  89 err_t            udp_sendto     (struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *dst_ip, u16_t dst_port);
  90 err_t            udp_send       (struct udp_pcb *pcb, struct pbuf *p);
  91
  92 #define          udp_flags(pcb)  ((pcb)->flags)
  93 #define          udp_setflags(pcb, f)  ((pcb)->flags = (f))
  94
  95 /* The following functions are the lower layer interface to UDP. */
  96 void             udp_input      (struct pbuf *p, struct netif *inp);
  97 void             udp_init       (void);
  98
  99 #if UDP_DEBUG
 100 void udp_debug_print(struct udp_hdr *udphdr);
 101 #else
 102 #define udp_debug_print(udphdr)
 103 #endif
 104 #endif /* __LWIP_UDP_H__ */
 105
 106