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_address_change_notify 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 address change notify */
49 /* function call. */
50 /* */
51 /* INPUT */
52 /* */
53 /* ip_ptr IP control block pointer */
54 /* ip_address_change_notify Application callback function */
55 /* additional_info Optional additional information */
56 /* for the callback function */
57 /* */
58 /* OUTPUT */
59 /* */
60 /* status Completion status */
61 /* */
62 /* CALLS */
63 /* */
64 /* _nx_ip_address_change_notify Actual IP address change notify */
65 /* function */
66 /* */
67 /* CALLED BY */
68 /* */
69 /* Application Code */
70 /* */
71 /* RELEASE HISTORY */
72 /* */
73 /* DATE NAME DESCRIPTION */
74 /* */
75 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
76 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
77 /* resulting in version 6.1 */
78 /* */
79 /**************************************************************************/
_nxe_ip_address_change_notify(NX_IP * ip_ptr,VOID (* ip_address_change_notify)(NX_IP *,VOID *),VOID * additional_info)80 UINT _nxe_ip_address_change_notify(NX_IP *ip_ptr, VOID (*ip_address_change_notify)(NX_IP *, VOID *), VOID *additional_info)
81 {
82
83 #ifndef NX_DISABLE_IPV4
84 UINT status;
85
86
87 /* Check for invalid input pointers. */
88 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
89 {
90 return(NX_PTR_ERROR);
91 }
92
93 /* Check for appropriate caller. */
94 NX_INIT_AND_THREADS_CALLER_CHECKING
95
96 /* Call actual IP address change notify function. */
97 status = _nx_ip_address_change_notify(ip_ptr, ip_address_change_notify, additional_info);
98
99 /* Return completion status. */
100 return(status);
101 #else /* NX_DISABLE_IPV4 */
102 NX_PARAMETER_NOT_USED(ip_ptr);
103 NX_PARAMETER_NOT_USED(ip_address_change_notify);
104 NX_PARAMETER_NOT_USED(additional_info);
105
106 return(NX_NOT_SUPPORTED);
107 #endif /* !NX_DISABLE_IPV4 */
108 }
109
110
