udp.h
Go to the documentation of this file.
1 /**
2  * @file udp.h
3  * @brief UDP (User Datagram Protocol)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2022 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.1.6
29  **/
30 
31 #ifndef _UDP_H
32 #define _UDP_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "core/tcp.h"
37 
38 //UDP support
39 #ifndef UDP_SUPPORT
40  #define UDP_SUPPORT ENABLED
41 #elif (UDP_SUPPORT != ENABLED && UDP_SUPPORT != DISABLED)
42  #error UDP_SUPPORT parameter is not valid
43 #endif
44 
45 //Maximum number of callback functions that can be registered
46 //to process incoming UDP datagrams
47 #ifndef UDP_CALLBACK_TABLE_SIZE
48  #define UDP_CALLBACK_TABLE_SIZE 10
49 #elif (UDP_CALLBACK_TABLE_SIZE < 1)
50  #error UDP_CALLBACK_TABLE_SIZE parameter is not valid
51 #endif
52 
53 //Receive queue depth for connectionless sockets
54 #ifndef UDP_RX_QUEUE_SIZE
55  #define UDP_RX_QUEUE_SIZE 4
56 #elif (UDP_RX_QUEUE_SIZE < 1)
57  #error UDP_RX_QUEUE_SIZE parameter is not valid
58 #endif
59 
60 //C++ guard
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64 
65 
66 //CodeWarrior or Win32 compiler?
67 #if defined(__CWCC__) || defined(_WIN32)
68  #pragma pack(push, 1)
69 #endif
70 
71 
72 /**
73  * @brief UDP header
74  **/
75 
76 typedef __start_packed struct
77 {
78  uint16_t srcPort; //0-1
79  uint16_t destPort; //2-3
80  uint16_t length; //4-5
81  uint16_t checksum; //6-7
82  uint8_t data[]; //8
84 
85 
86 //CodeWarrior or Win32 compiler?
87 #if defined(__CWCC__) || defined(_WIN32)
88  #pragma pack(pop)
89 #endif
90 
91 
92 /**
93  * @brief UDP receive callback
94  **/
95 
96 typedef void (*UdpRxCallback)(NetInterface *interface,
97  const IpPseudoHeader *pseudoHeader, const UdpHeader *header,
98  const NetBuffer *buffer, size_t offset, const NetRxAncillary *ancillary,
99  void *param);
100 
101 
102 /**
103  * @brief UDP receive callback entry
104  **/
105 
106 typedef struct
107 {
109  uint16_t port;
111  void *param;
113 
114 
115 //Global variables
117 
118 //UDP related functions
119 error_t udpInit(void);
120 uint16_t udpGetDynamicPort(void);
121 
122 error_t udpProcessDatagram(NetInterface *interface, IpPseudoHeader *pseudoHeader,
123  const NetBuffer *buffer, size_t offset, NetRxAncillary *ancillary);
124 
126 
128  uint16_t srcPort, const IpAddr *destIpAddr, uint16_t destPort,
129  NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
130 
132 
133 NetBuffer *udpAllocBuffer(size_t length, size_t *offset);
134 
136 
137 error_t udpAttachRxCallback(NetInterface *interface, uint16_t port,
138  UdpRxCallback callback, void *param);
139 
140 error_t udpDetachRxCallback(NetInterface *interface, uint16_t port);
141 
143  const IpPseudoHeader *pseudoHeader, const UdpHeader *header,
144  const NetBuffer *buffer, size_t offset, NetRxAncillary *ancillary);
145 
146 void udpDumpHeader(const UdpHeader *datagram);
147 
148 //C++ guard
149 #ifdef __cplusplus
150 }
151 #endif
152 
153 #endif
error_t udpSendBuffer(NetInterface *interface, const IpAddr *srcIpAddr, uint16_t srcPort, const IpAddr *destIpAddr, uint16_t destPort, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a UDP datagram.
Definition: udp.c:532
IP network address.
Definition: ip.h:79
__start_packed struct @0 UdpHeader
UDP header.
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
error_t udpSendDatagram(Socket *socket, const SocketMsg *message, uint_t flags)
Send a UDP datagram.
Definition: udp.c:418
Message and ancillary data.
Definition: socket.h:200
uint16_t checksum
Definition: udp.h:81
uint16_t port
Definition: udp.h:109
uint16_t destPort
Definition: udp.h:79
Ipv4Addr srcIpAddr
Definition: ipcp.h:77
IP pseudo header.
Definition: ip.h:98
void udpUpdateEvents(Socket *socket)
Update UDP related events.
Definition: udp.c:815
error_t udpDetachRxCallback(NetInterface *interface, uint16_t port)
Unregister user callback.
Definition: udp.c:902
error_t udpAttachRxCallback(NetInterface *interface, uint16_t port, UdpRxCallback callback, void *param)
Register user callback.
Definition: udp.c:861
void * param
Definition: udp.h:111
void(* UdpRxCallback)(NetInterface *interface, const IpPseudoHeader *pseudoHeader, const UdpHeader *header, const NetBuffer *buffer, size_t offset, const NetRxAncillary *ancillary, void *param)
UDP receive callback.
Definition: udp.h:96
error_t
Error codes.
Definition: error.h:43
UdpRxCallback callback
Definition: udp.h:110
error_t udpReceiveDatagram(Socket *socket, SocketMsg *message, uint_t flags)
Receive data from a UDP socket.
Definition: udp.c:689
error_t udpInit(void)
UDP related initialization.
Definition: udp.c:63
int_t socket(int_t family, int_t type, int_t protocol)
Create a socket that is bound to a specific transport service provider.
Definition: bsd_socket.c:63
UDP receive callback entry.
Definition: udp.h:107
NetInterface * interface
Definition: udp.h:108
#define NetRxAncillary
Definition: net_misc.h:40
#define NetInterface
Definition: net.h:36
uint16_t udpGetDynamicPort(void)
Get an ephemeral port number.
Definition: udp.c:81
void udpDumpHeader(const UdpHeader *datagram)
Dump UDP header for debugging purpose.
Definition: udp.c:1011
error_t udpInvokeRxCallback(NetInterface *interface, const IpPseudoHeader *pseudoHeader, const UdpHeader *header, const NetBuffer *buffer, size_t offset, NetRxAncillary *ancillary)
Invoke user callback.
Definition: udp.c:948
__start_packed struct _Ipv4Header __end_packed
#define NetTxAncillary
Definition: net_misc.h:36
uint16_t length
Definition: udp.h:80
#define UDP_CALLBACK_TABLE_SIZE
Definition: udp.h:48
uint16_t port
Definition: dns_common.h:251
uint8_t flags
Definition: tcp.h:349
TCP (Transmission Control Protocol)
#define Socket
Definition: socket.h:36
uint8_t message[]
Definition: chap.h:152
NetBuffer * udpAllocBuffer(size_t length, size_t *offset)
Allocate a buffer to hold a UDP packet.
Definition: udp.c:792
uint16_t srcPort
Definition: udp.h:78
error_t udpProcessDatagram(NetInterface *interface, IpPseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, NetRxAncillary *ancillary)
Incoming UDP datagram processing.
Definition: udp.c:124
UdpRxCallbackEntry udpCallbackTable[UDP_CALLBACK_TABLE_SIZE]
Definition: udp.c:55
unsigned int uint_t
Definition: compiler_port.h:45
TCP/IP stack core.
uint8_t data[]
Definition: udp.h:82
Ipv4Addr destIpAddr
Definition: ipcp.h:78