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
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _nx_ip_address_change_notify PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Yuxin Zhou, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function registers an application callback routine that NetX */
44 /* calls whenever the IP address is changed. */
45 /* */
46 /* INPUT */
47 /* */
48 /* ip_ptr IP control block pointer */
49 /* ip_address_change_notify Application callback function */
50 /* additional_info Optional additional */
51 /* information for the */
52 /* callback function */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* tx_mutex_get Get protection mutex */
61 /* tx_mutex_put Put protection mutex */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* Application Code */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
72 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
73 /* resulting in version 6.1 */
74 /* */
75 /**************************************************************************/
_nx_ip_address_change_notify(NX_IP * ip_ptr,VOID (* ip_address_change_notify)(NX_IP *,VOID *),VOID * additional_info)76 UINT _nx_ip_address_change_notify(NX_IP *ip_ptr, VOID (*ip_address_change_notify)(NX_IP *, VOID *), VOID *additional_info)
77 {
78
79 #ifndef NX_DISABLE_IPV4
80 TX_INTERRUPT_SAVE_AREA
81
82
83 /* If trace is enabled, insert this event into the trace buffer. */
84 NX_TRACE_IN_LINE_INSERT(NX_TRACE_IP_ADDRESS_CHANGE_NOTIFY, ip_ptr, ip_address_change_notify, additional_info, 0, NX_TRACE_IP_EVENTS, 0, 0);
85
86 /* Get mutex protection. */
87 tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
88
89 /* Disable interrupts. */
90 TX_DISABLE
91
92 /* Setup the IP address change callback function and the additional information pointers. */
93 ip_ptr -> nx_ip_address_change_notify = ip_address_change_notify;
94 ip_ptr -> nx_ip_address_change_notify_additional_info = additional_info;
95
96 /* Restore interrupts. */
97 TX_RESTORE
98
99 /* Release mutex protection. */
100 tx_mutex_put(&(ip_ptr -> nx_ip_protection));
101
102 /* Return completion status. */
103 return(NX_SUCCESS);
104 #else /* NX_DISABLE_IPV4 */
105 NX_PARAMETER_NOT_USED(ip_ptr);
106 NX_PARAMETER_NOT_USED(ip_address_change_notify);
107 NX_PARAMETER_NOT_USED(additional_info);
108
109 return(NX_NOT_SUPPORTED);
110 #endif /* !NX_DISABLE_IPV4 */
111 }
112
113
