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 Protocol (IP) */
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_ipv6.h"
29 #ifdef FEATURE_NX_IPV6
30 #include "nx_ip.h"
31 /* Bring in externs for caller checking code. */
32
33 NX_CALLER_CHECKING_EXTERNS
34 #endif /* FEATURE_NX_IPV6 */
35
36
37 /**************************************************************************/
38 /* */
39 /* FUNCTION RELEASE */
40 /* */
41 /* _nxde_ipv6_disable 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 ipv6 disable function */
50 /* call. */
51 /* */
52 /* INPUT */
53 /* */
54 /* ip_ptr IP instance pointer */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* status Actual completion status */
59 /* NX_PTR_ERROR Invalid pointer input */
60 /* */
61 /* CALLS */
62 /* */
63 /* _nxdipv6_disable Actual IPv6 disable function */
64 /* */
65 /* CALLED BY */
66 /* */
67 /* Application Code */
68 /* */
69 /* RELEASE HISTORY */
70 /* */
71 /* DATE NAME DESCRIPTION */
72 /* */
73 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
74 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
75 /* resulting in version 6.1 */
76 /* */
77 /**************************************************************************/
_nxde_ipv6_disable(NX_IP * ip_ptr)78 UINT _nxde_ipv6_disable(NX_IP *ip_ptr)
79 {
80 #ifdef FEATURE_NX_IPV6
81 UINT status;
82
83
84 /* Check for invalid input pointers. */
85 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
86 {
87 return(NX_PTR_ERROR);
88 }
89
90 /* Check for appropriate caller. */
91 NX_INIT_AND_THREADS_CALLER_CHECKING
92
93 /* Call actual IPv6 disable function. */
94 status = _nxd_ipv6_disable(ip_ptr);
95
96 /* Return completion status. */
97 return(status);
98
99 #else /* ! FEATURE_NX_IPV6 */
100 NX_PARAMETER_NOT_USED(ip_ptr);
101 return(NX_NOT_SUPPORTED);
102
103 #endif /* FEATURE_NX_IPV6 */
104 }
105
106
