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 /** Internet Control Message Protocol (ICMP) */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define NX_SOURCE_CODE
23
24
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_ip.h"
30 #include "nx_icmp.h"
31
32
33 /* Bring in externs for caller checking code. */
34
35
36
37 NX_CALLER_CHECKING_EXTERNS
38
39
40 /**************************************************************************/
41 /* */
42 /* FUNCTION RELEASE */
43 /* */
44 /* _nxde_icmp_enable PORTABLE C */
45 /* 6.1 */
46 /* AUTHOR */
47 /* */
48 /* Yuxin Zhou, Microsoft Corporation */
49 /* */
50 /* DESCRIPTION */
51 /* */
52 /* This function checks for errors in the ICMPv4/ICMPv6 enable function*/
53 /* call. */
54 /* */
55 /* INPUT */
56 /* */
57 /* ip_ptr IP instance pointer */
58 /* */
59 /* OUTPUT */
60 /* */
61 /* status Completion status */
62 /* */
63 /* CALLS */
64 /* */
65 /* _nxd_icmp_enable Actual ICMP enable 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_icmp_enable(NX_IP * ip_ptr)80 UINT _nxde_icmp_enable(NX_IP *ip_ptr)
81 {
82
83 UINT status;
84
85
86 /* Check for invalid input pointers. */
87 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
88 {
89 return(NX_PTR_ERROR);
90 }
91
92 /* Check for appropriate caller. */
93 NX_INIT_AND_THREADS_CALLER_CHECKING
94
95 /* Call actual ICMP enable function. */
96 status = _nxd_icmp_enable(ip_ptr);
97
98 /* Return completion status. */
99 return(status);
100 }
101
102
