1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** NetX Component */
16 /** */
17 /** User Datagram Protocol (UDP) */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define NX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "nx_api.h"
28 #include "nx_ip.h"
29 #include "nx_udp.h"
30
31
32 /* Bring in externs for caller checking code. */
33
34 NX_CALLER_CHECKING_EXTERNS
35
36 /**************************************************************************/
37 /* */
38 /* FUNCTION RELEASE */
39 /* */
40 /* _nxe_udp_enable PORTABLE C */
41 /* 6.1 */
42 /* AUTHOR */
43 /* */
44 /* Yuxin Zhou, Microsoft Corporation */
45 /* */
46 /* DESCRIPTION */
47 /* */
48 /* This function checks for errors in the UDP enable function call. */
49 /* */
50 /* INPUT */
51 /* */
52 /* ip_ptr IP instance pointer */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _nx_udp_enable Actual UDP enable function */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
71 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_nxe_udp_enable(NX_IP * ip_ptr)75 UINT _nxe_udp_enable(NX_IP *ip_ptr)
76 {
77
78 UINT status;
79
80
81 /* Check for invalid input pointers. */
82 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
83 {
84 return(NX_PTR_ERROR);
85 }
86
87 /* Check to see if UDP is enabled. */
88 if (ip_ptr -> nx_ip_udp_packet_receive)
89 {
90 return(NX_ALREADY_ENABLED);
91 }
92
93 /* Check for appropriate caller. */
94 NX_NOT_ISR_CALLER_CHECKING
95
96 /* Call actual UDP enable function. */
97 status = _nx_udp_enable(ip_ptr);
98
99 /* Return completion status. */
100 return(status);
101 }
102
103
