Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** User Datagram Protocol (UDP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_ip.h"
#include "nx_udp.h"
#include "nx_packet.h"
/* Bring in externs for caller checking code. */
NX_CALLER_CHECKING_EXTERNS
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_udp_socket_source_send PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks for errors in the UDP socket source send */
/* function call. */
/* */
/* INPUT */
/* */
/* socket_ptr Pointer to UDP socket */
/* packet_ptr Pointer to UDP packet */
/* ip_address IP address */
/* port 16-bit UDP port number */
/* address_index Index of IPv4 address to */
/* use as the source address */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_udp_socket_source_send Actual UDP socket send */
/* function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_udp_socket_source_send(NX_UDP_SOCKET *socket_ptr, NX_PACKET **packet_ptr_ptr,
ULONG ip_address, UINT port, UINT address_index)
{
#ifndef NX_DISABLE_IPV4
NX_PACKET *packet_ptr;
UINT status;
NX_IP *ip_ptr;
/* Setup packet pointer. */
packet_ptr = *packet_ptr_ptr;
/* Check for invalid input pointers. */
if ((socket_ptr == NX_NULL) || (packet_ptr == NX_NULL))
{
return(NX_PTR_ERROR);
}
/*lint -e{923} suppress cast of ULONG to pointer. */
if ((socket_ptr -> nx_udp_socket_id != NX_UDP_ID) ||
(packet_ptr -> nx_packet_union_next.nx_packet_tcp_queue_next != ((NX_PACKET *)NX_PACKET_ALLOCATED)))
{
return(NX_PTR_ERROR);
}
/* Check for invalid IP address. */
if (!ip_address)
{
return(NX_IP_ADDRESS_ERROR);
}
/* Check for an invalid port. */
if (((ULONG)port) > (ULONG)NX_MAX_PORT)
{
return(NX_INVALID_PORT);
}
/* Validate the IP instance. */
ip_ptr = socket_ptr -> nx_udp_socket_ip_ptr;
if (ip_ptr == NX_NULL)
{
return(NX_PTR_ERROR);
}
/* Check to see if UDP is enabled. */
if (!ip_ptr -> nx_ip_udp_packet_receive)
{
return(NX_NOT_ENABLED);
}
if (ip_ptr -> nx_ip_id != NX_IP_ID)
{
return(NX_PTR_ERROR);
}
/* Validate the interface index. */
if (address_index >= NX_MAX_IP_INTERFACES)
{
return(NX_INVALID_INTERFACE);
}
if (!(ip_ptr -> nx_ip_interface[address_index].nx_interface_valid))
{
return(NX_INVALID_INTERFACE);
}
/* Check for an invalid packet prepend pointer. */
/*lint -e{946} suppress pointer subtraction, since it is necessary. */
/*lint -e{947} suppress pointer subtraction, since it is necessary. */
if ((INT)(packet_ptr -> nx_packet_prepend_ptr - packet_ptr -> nx_packet_data_start) < (INT)(sizeof(NX_IPV4_HEADER) + sizeof(NX_UDP_HEADER)))
{
#ifndef NX_DISABLE_UDP_INFO
/* Increment the total UDP invalid packet count. */
(socket_ptr -> nx_udp_socket_ip_ptr) -> nx_ip_udp_invalid_packets++;
/* Increment the total UDP invalid packet count for this socket. */
socket_ptr -> nx_udp_socket_invalid_packets++;
#endif
/* Return error code. */
return(NX_UNDERFLOW);
}
/* Check for an invalid packet append pointer. */
/*lint -e{946} suppress pointer subtraction, since it is necessary. */
if (packet_ptr -> nx_packet_append_ptr > packet_ptr -> nx_packet_data_end)
{
#ifndef NX_DISABLE_UDP_INFO
/* Increment the total UDP invalid packet count. */
(socket_ptr -> nx_udp_socket_ip_ptr) -> nx_ip_udp_invalid_packets++;
/* Increment the total UDP invalid packet count for this socket. */
socket_ptr -> nx_udp_socket_invalid_packets++;
#endif
/* Return error code. */
return(NX_OVERFLOW);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual UDP socket send function. */
status = _nx_udp_socket_source_send(socket_ptr, packet_ptr, ip_address, port, address_index);
/* Determine if the packet send was successful. */
if (status == NX_SUCCESS)
{
/* Yes, now clear the application's packet pointer so it can't be accidentally
used again by the application. This is only done when error checking is
enabled. */
*packet_ptr_ptr = NX_NULL;
}
/* Return completion status. */
return(status);
#else
NX_PARAMETER_NOT_USED(socket_ptr);
NX_PARAMETER_NOT_USED(packet_ptr_ptr);
NX_PARAMETER_NOT_USED(ip_address);
NX_PARAMETER_NOT_USED(port);
NX_PARAMETER_NOT_USED(address_index);
return(NX_NOT_SUPPORTED);
#endif /* !NX_DISABLE_IPV4 */
}