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 Group Management Protocol (IGMP) */
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 #include "nx_igmp.h"
31
32 /* Bring in externs for caller checking code. */
33
34 NX_CALLER_CHECKING_EXTERNS
35
36
37 /**************************************************************************/
38 /* */
39 /* FUNCTION RELEASE */
40 /* */
41 /* _nxe_igmp_enable PORTABLE C */
42 /* 6.1 */
43 /* AUTHOR */
44 /* */
45 /* Yuxin Zhou, Microsoft Corporation */
46 /* */
47 /* DESCRIPTION */
48 /* */
49 /* This function checks for errors in the IGMP enable function call. */
50 /* */
51 /* INPUT */
52 /* */
53 /* ip_ptr IP instance pointer */
54 /* */
55 /* OUTPUT */
56 /* */
57 /* status Completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _nx_igmp_enable Actual IGMP enable function */
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 /**************************************************************************/
_nxe_igmp_enable(NX_IP * ip_ptr)76 UINT _nxe_igmp_enable(NX_IP *ip_ptr)
77 {
78
79 #ifndef NX_DISABLE_IPV4
80 UINT status;
81
82
83 /* Check for invalid input pointers. */
84 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
85 {
86 return(NX_PTR_ERROR);
87 }
88
89 /* Check to see if IGMP is enabled. */
90 if (ip_ptr -> nx_ip_igmp_packet_receive)
91 {
92 return(NX_ALREADY_ENABLED);
93 }
94
95 /* Check for appropriate caller. */
96 NX_INIT_AND_THREADS_CALLER_CHECKING
97
98 /* Call actual IGMP enable function. */
99 status = _nx_igmp_enable(ip_ptr);
100
101 /* Return completion status. */
102 return(status);
103 #else /* NX_DISABLE_IPV4 */
104 NX_PARAMETER_NOT_USED(ip_ptr);
105
106 return(NX_NOT_SUPPORTED);
107 #endif /* !NX_DISABLE_IPV4 */
108 }
109
110
