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 Control Message Protocol for IPv6 (ICMPv6)                 */
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_icmpv6.h"
29 
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _nxd_icmpv6_ra_flag_callback_set                    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 /*    Duo calls whenever router advertisement is received.                */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    ip_ptr                            IP control block pointer          */
49 /*    icmpv6_ra_flag_callback           Application callback function     */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    status                            Completion status                 */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    tx_mutex_get                          Get protection mutex          */
58 /*    tx_mutex_put                          Put protection mutex          */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
69 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
70 /*                                            resulting in version 6.1    */
71 /*                                                                        */
72 /**************************************************************************/
_nxd_icmpv6_ra_flag_callback_set(NX_IP * ip_ptr,VOID (* icmpv6_ra_flag_callback)(NX_IP * ip_ptr,UINT ra_flag))73 UINT  _nxd_icmpv6_ra_flag_callback_set(NX_IP *ip_ptr, VOID (*icmpv6_ra_flag_callback)(NX_IP *ip_ptr, UINT ra_flag))
74 {
75 
76 #ifdef FEATURE_NX_IPV6
77     /* Get mutex protection.  */
78     tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
79 
80     /* Setup the IP address change callback function and the additional information pointers. */
81     ip_ptr -> nx_icmpv6_ra_flag_callback = icmpv6_ra_flag_callback;
82 
83     /* Release mutex protection.  */
84     tx_mutex_put(&(ip_ptr -> nx_ip_protection));
85 
86     /* Return completion status.  */
87     return(NX_SUCCESS);
88 
89 #else /* !FEATURE_NX_IPV6 */
90     NX_PARAMETER_NOT_USED(ip_ptr);
91     NX_PARAMETER_NOT_USED(icmpv6_ra_flag_callback);
92 
93     return(NX_NOT_SUPPORTED);
94 
95 #endif /* FEATURE_NX_IPV6 */
96 }
97 
98