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 /* Include necessary system files. */
25
26 #include "nx_api.h"
27 #include "nx_ip.h"
28
29 /* Bring in externs for caller checking code. */
30
31 NX_CALLER_CHECKING_EXTERNS
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _nxe_ip_interface_detach PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Yuxin Zhou, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function checks for errors in the IP interface detach */
46 /* function call. */
47 /* */
48 /* */
49 /* INPUT */
50 /* */
51 /* ip_ptr Pointer to IP control block */
52 /* index IP interface index */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _nx_ip_interface_detach Detaches the interface */
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_ip_interface_detach(NX_IP * ip_ptr,UINT index)75 UINT _nxe_ip_interface_detach(NX_IP *ip_ptr, UINT index)
76 {
77
78 UINT status;
79
80 /* Check for invalid input pointers. */
81 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
82 {
83 return(NX_PTR_ERROR);
84 }
85
86 /* Check for valid interface index. */
87 if (index >= NX_MAX_PHYSICAL_INTERFACES)
88 {
89 return(NX_INVALID_INTERFACE);
90 }
91
92 /* Check for appropriate caller. */
93 NX_INIT_AND_THREADS_CALLER_CHECKING
94
95 /* Call actual IP interface detach function. */
96 status = _nx_ip_interface_detach(ip_ptr, index);
97
98 /* Return completion status. */
99 return(status);
100 }
101
102
