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
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** NetX Component */
17 /** */
18 /** Internet Protocol (IP) */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define NX_SOURCE_CODE
24
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 /* */
38 /* FUNCTION RELEASE */
39 /* */
40 /* _nxe_ip_interface_status_check 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 IP interface status check */
49 /* function call. */
50 /* */
51 /* INPUT */
52 /* */
53 /* ip_ptr Pointer to IP instance */
54 /* interface_index Index to the interface */
55 /* needed_status Status needed request */
56 /* actual_status Pointer to return status area */
57 /* wait_option Maximum suspension time */
58 /* */
59 /* OUTPUT */
60 /* */
61 /* status Completion status */
62 /* */
63 /* CALLS */
64 /* */
65 /* _nx_ip_interface_status_check Actual IP interface status */
66 /* check function */
67 /* */
68 /* CALLED BY */
69 /* */
70 /* Application */
71 /* */
72 /* RELEASE HISTORY */
73 /* */
74 /* DATE NAME DESCRIPTION */
75 /* */
76 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
77 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
78 /* resulting in version 6.1 */
79 /* */
80 /**************************************************************************/
_nxe_ip_interface_status_check(NX_IP * ip_ptr,UINT interface_index,ULONG needed_status,ULONG * actual_status,ULONG wait_option)81 UINT _nxe_ip_interface_status_check(NX_IP *ip_ptr, UINT interface_index, ULONG needed_status,
82 ULONG *actual_status, ULONG wait_option)
83 {
84
85 UINT status;
86
87
88 /* Check for invalid input pointers. */
89 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID) || (actual_status == NX_NULL))
90 {
91 return(NX_PTR_ERROR);
92 }
93
94 /* Check for invalid interface index. */
95 if ((interface_index >= NX_MAX_PHYSICAL_INTERFACES) ||
96 (ip_ptr -> nx_ip_interface[interface_index].nx_interface_valid) == 0)
97 {
98 return(NX_INVALID_INTERFACE);
99 }
100
101 /* Check for valid options. */
102 if (needed_status &
103 ~((NX_IP_INITIALIZE_DONE | NX_IP_LINK_ENABLED | NX_IP_UDP_ENABLED | NX_IP_TCP_ENABLED | NX_IP_INTERFACE_LINK_ENABLED)
104 #ifndef NX_DISABLE_IPV4
105 | (NX_IP_ADDRESS_RESOLVED | NX_IP_ARP_ENABLED | NX_IP_RARP_COMPLETE | NX_IP_IGMP_ENABLED)
106 #endif /* !NX_DISABLE_IPV4 */
107 ))
108 {
109 return(NX_OPTION_ERROR);
110 }
111
112 /* Check for appropriate caller. */
113 NX_THREADS_ONLY_CALLER_CHECKING
114
115 /* Call actual IP interface status check function. */
116 status = _nx_ip_interface_status_check(ip_ptr, interface_index, needed_status, actual_status, wait_option);
117
118 /* Return completion status. */
119 return(status);
120 }
121
122