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_ip.h"
29
30 /* Bring in externs for caller checking code. */
31
32 NX_CALLER_CHECKING_EXTERNS
33
34
35 /**************************************************************************/
36 /* */
37 /* FUNCTION RELEASE */
38 /* */
39 /* _nxe_ip_interface_address_set 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 address set */
48 /* function call. */
49 /* */
50 /* INPUT */
51 /* */
52 /* ip_ptr IP control block pointer */
53 /* interface_index IP Interface Index */
54 /* ip_address IP address, in host byte */
55 /* order */
56 /* network_mask Network mask, in host byte */
57 /* order */
58 /* */
59 /* OUTPUT */
60 /* */
61 /* status Completion status */
62 /* */
63 /* CALLS */
64 /* */
65 /* _nx_ip_interface_address_set Actual IP address set */
66 /* function */
67 /* */
68 /* CALLED BY */
69 /* */
70 /* Application Code */
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_address_set(NX_IP * ip_ptr,UINT interface_index,ULONG ip_address,ULONG network_mask)81 UINT _nxe_ip_interface_address_set(NX_IP *ip_ptr, UINT interface_index, ULONG ip_address, ULONG network_mask)
82 {
83
84 #ifndef NX_DISABLE_IPV4
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))
90 {
91 return(NX_PTR_ERROR);
92 }
93
94 /* Check for invalid IP address. */
95 if (((ip_address & NX_IP_CLASS_A_MASK) != NX_IP_CLASS_A_TYPE) &&
96 ((ip_address & NX_IP_CLASS_B_MASK) != NX_IP_CLASS_B_TYPE) &&
97 ((ip_address & NX_IP_CLASS_C_MASK) != NX_IP_CLASS_C_TYPE))
98 {
99 return(NX_IP_ADDRESS_ERROR);
100 }
101
102 /* Check for invalid interface ID */
103 if (interface_index >= NX_MAX_PHYSICAL_INTERFACES)
104 {
105 return(NX_INVALID_INTERFACE);
106 }
107
108 /* Check for interface being valid. */
109 if (!ip_ptr -> nx_ip_interface[interface_index].nx_interface_valid)
110 {
111 return(NX_INVALID_INTERFACE);
112 }
113
114 /* Check for appropriate caller. */
115 NX_INIT_AND_THREADS_CALLER_CHECKING
116
117 /* Call actual IP address set function. */
118 status = _nx_ip_interface_address_set(ip_ptr, interface_index, ip_address, network_mask);
119
120 /* Return completion status. */
121 return(status);
122 #else /* NX_DISABLE_IPV4 */
123 NX_PARAMETER_NOT_USED(ip_ptr);
124 NX_PARAMETER_NOT_USED(interface_index);
125 NX_PARAMETER_NOT_USED(ip_address);
126 NX_PARAMETER_NOT_USED(network_mask);
127
128 return(NX_NOT_SUPPORTED);
129 #endif /* !NX_DISABLE_IPV4 */
130 }
131
132
