1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** NetX Component */
17 /** */
18 /** User Datagram Protocol (UDP) */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define NX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_udp.h"
30 #ifdef FEATURE_NX_IPV6
31 #include "nx_ipv6.h"
32 #endif /* FEATURE_NX_IPV6 */
33
34 /* Bring in externs for caller checking code. */
35 NX_CALLER_CHECKING_EXTERNS
36
37 /**************************************************************************/
38 /* */
39 /* FUNCTION RELEASE */
40 /* */
41 /* _nxde_udp_socket_extract PORTABLE C */
42 /* 6.1 */
43 /* AUTHOR */
44 /* */
45 /* Yuxin Zhou, Microsoft Corporation */
46 /* */
47 /* DESCRIPTION */
48 /* */
49 /* This function checks for errors in the UDP source extract */
50 /* function call. */
51 /* */
52 /* INPUT */
53 /* */
54 /* packet_ptr Pointer to UDP packet pointer */
55 /* ip_address Pointer to source IP address */
56 /* port Pointer to ource UDP port */
57 /* */
58 /* OUTPUT */
59 /* */
60 /* status Actual completion status */
61 /* */
62 /* CALLS */
63 /* */
64 /* _nxd_udp_source_extract Actual UDP source extract */
65 /* function */
66 /* */
67 /* CALLED BY */
68 /* */
69 /* Application Code */
70 /* */
71 /* RELEASE HISTORY */
72 /* */
73 /* DATE NAME DESCRIPTION */
74 /* */
75 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
76 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
77 /* resulting in version 6.1 */
78 /* */
79 /**************************************************************************/
_nxde_udp_source_extract(NX_PACKET * packet_ptr,NXD_ADDRESS * ip_address,UINT * port)80 UINT _nxde_udp_source_extract(NX_PACKET *packet_ptr, NXD_ADDRESS *ip_address, UINT *port)
81 {
82
83 UINT status;
84
85 /* Check for invalid input pointers. */
86 if ((packet_ptr == NX_NULL) || (ip_address == NX_NULL) || (port == NX_NULL))
87 {
88 return(NX_PTR_ERROR);
89 }
90
91 if (packet_ptr -> nx_packet_ip_header == NX_NULL)
92 {
93 return(NX_INVALID_PACKET);
94 }
95
96 /* Check for appropriate caller. */
97 NX_THREADS_ONLY_CALLER_CHECKING
98
99 /* Call actual UDP source extract function. */
100 status = _nxd_udp_source_extract(packet_ptr, ip_address, port);
101
102 /* Return completion status. */
103 return(status);
104 }
105
106
