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_icmpv6.h"
30 
31 #ifdef FEATURE_NX_IPV6
32 /* Bring in externs for caller checking code.  */
33 NX_CALLER_CHECKING_EXTERNS
34 #endif /* FEATURE_NX_IPV6 */
35 
36 
37 /**************************************************************************/
38 /*                                                                        */
39 /*  FUNCTION                                               RELEASE        */
40 /*                                                                        */
41 /*    _nxde_icmpv6_ra_flag_callback_set                   PORTABLE C      */
42 /*                                                           6.1          */
43 /*  AUTHOR                                                                */
44 /*                                                                        */
45 /*    Yuxin Zhou, Microsoft Corporation                                   */
46 /*                                                                        */
47 /*  DESCRIPTION                                                           */
48 /*                                                                        */
49 /*    This function checks for errors for ra_flag callback register.      */
50 /*                                                                        */
51 /*  INPUT                                                                 */
52 /*                                                                        */
53 /*    ip_ptr                            IP control block pointer          */
54 /*    icmpv6_ra_flag_callback           Application callback function     */
55 /*                                                                        */
56 /*  OUTPUT                                                                */
57 /*                                                                        */
58 /*    status                                Actual completion status      */
59 /*    NX_PTR_ERROR                          Invalid pointer input         */
60 /*                                                                        */
61 /*  CALLS                                                                 */
62 /*                                                                        */
63 /*    None                                                                */
64 /*                                                                        */
65 /*  CALLED BY                                                             */
66 /*                                                                        */
67 /*    Application Code                                                    */
68 /*                                                                        */
69 /*  RELEASE HISTORY                                                       */
70 /*                                                                        */
71 /*    DATE              NAME                      DESCRIPTION             */
72 /*                                                                        */
73 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
74 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
75 /*                                            resulting in version 6.1    */
76 /*                                                                        */
77 /**************************************************************************/
_nxde_icmpv6_ra_flag_callback_set(NX_IP * ip_ptr,VOID (* icmpv6_ra_flag_callback)(NX_IP * ip_ptr,UINT ra_flag))78 UINT  _nxde_icmpv6_ra_flag_callback_set(NX_IP *ip_ptr, VOID (*icmpv6_ra_flag_callback)(NX_IP *ip_ptr, UINT ra_flag))
79 {
80 #ifdef FEATURE_NX_IPV6
81 UINT status;
82 
83 
84     /* Check for invalid input pointers.  */
85     if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
86     {
87         return(NX_PTR_ERROR);
88     }
89 
90     /* Check for appropriate caller.  */
91     NX_INIT_AND_THREADS_CALLER_CHECKING
92 
93     /* Call actual IPv6 enable function.  */
94     status =  _nxd_icmpv6_ra_flag_callback_set(ip_ptr, icmpv6_ra_flag_callback);
95 
96     /* Return completion status.  */
97     return(status);
98 #else /* !FEATURE_NX_IPV6 */
99     NX_PARAMETER_NOT_USED(ip_ptr);
100     NX_PARAMETER_NOT_USED(icmpv6_ra_flag_callback);
101 
102     return(NX_NOT_SUPPORTED);
103 #endif /* FEATURE_NX_IPV6 */
104 }
105 
106