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 /* Copyright (c) Microsoft Corporation. All rights reserved. */
13 /* */
14 /**************************************************************************/
15 /**************************************************************************/
16 /** */
17 /** NetX Component */
18 /** */
19 /** Internet Protocol (IP) */
20 /** */
21 /**************************************************************************/
22 /**************************************************************************/
23
24 #define NX_SOURCE_CODE
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_ip.h"
30
31 /* Bring in externs for caller checking code. */
32
33 NX_CALLER_CHECKING_EXTERNS
34
35 /**************************************************************************/
36 /* */
37 /* FUNCTION RELEASE */
38 /* */
39 /* _nxe_ip_interface_detach PORTABLE C */
40 /* 6.1 */
41 /* AUTHOR */
42 /* */
43 /* Yuxin Zhou, Microsoft Corporation */
44 /* */
45 /* DESCRIPTION */
46 /* */
47 /* This function checks for errors in the IP interface detach */
48 /* function call. */
49 /* */
50 /* */
51 /* INPUT */
52 /* */
53 /* ip_ptr Pointer to IP control block */
54 /* index IP interface index */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* status Completion status */
59 /* */
60 /* CALLS */
61 /* */
62 /* _nx_ip_interface_detach Detaches the interface */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* Application Code */
67 /* */
68 /* RELEASE HISTORY */
69 /* */
70 /* DATE NAME DESCRIPTION */
71 /* */
72 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
73 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
74 /* resulting in version 6.1 */
75 /* */
76 /**************************************************************************/
_nxe_ip_interface_detach(NX_IP * ip_ptr,UINT index)77 UINT _nxe_ip_interface_detach(NX_IP *ip_ptr, UINT index)
78 {
79
80 UINT status;
81
82 /* Check for invalid input pointers. */
83 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
84 {
85 return(NX_PTR_ERROR);
86 }
87
88 /* Check for valid interface index. */
89 if (index >= NX_MAX_PHYSICAL_INTERFACES)
90 {
91 return(NX_INVALID_INTERFACE);
92 }
93
94 /* Check for appropriate caller. */
95 NX_INIT_AND_THREADS_CALLER_CHECKING
96
97 /* Call actual IP interface detach function. */
98 status = _nx_ip_interface_detach(ip_ptr, index);
99
100 /* Return completion status. */
101 return(status);
102 }
103
104
