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 Group Management Protocol (IGMP)                           */
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 #include "nx_igmp.h"
30 
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_multicast_leave                           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 multicast leave         */
50 /*    function call.                                                      */
51 /*                                                                        */
52 /*  INPUT                                                                 */
53 /*                                                                        */
54 /*    ip_ptr                                IP instance pointer           */
55 /*    group_address                         Multicast group to join       */
56 /*                                                                        */
57 /*  OUTPUT                                                                */
58 /*                                                                        */
59 /*    status                                Completion status             */
60 /*                                                                        */
61 /*  CALLS                                                                 */
62 /*                                                                        */
63 /*    _nx_igmp_multicast_leave              Actual IGMP multicast leave   */
64 /*                                            function                    */
65 /*                                                                        */
66 /*  CALLED BY                                                             */
67 /*                                                                        */
68 /*    Application Code                                                    */
69 /*                                                                        */
70 /*  RELEASE HISTORY                                                       */
71 /*                                                                        */
72 /*    DATE              NAME                      DESCRIPTION             */
73 /*                                                                        */
74 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
75 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
76 /*                                            resulting in version 6.1    */
77 /*                                                                        */
78 /**************************************************************************/
_nxe_igmp_multicast_leave(NX_IP * ip_ptr,ULONG group_address)79 UINT  _nxe_igmp_multicast_leave(NX_IP *ip_ptr, ULONG group_address)
80 {
81 
82 #ifndef NX_DISABLE_IPV4
83 UINT status;
84 
85 
86     /* Check for invalid input pointers.  */
87     if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
88     {
89         return(NX_PTR_ERROR);
90     }
91 
92     /* Check for invalid multicast address.  */
93     if ((group_address & NX_IP_CLASS_D_MASK) != NX_IP_CLASS_D_TYPE)
94     {
95         return(NX_IP_ADDRESS_ERROR);
96     }
97 
98     /* Check to see if IGMP is enabled.  */
99     if (!ip_ptr -> nx_ip_igmp_packet_receive)
100     {
101         return(NX_NOT_ENABLED);
102     }
103 
104     /* Validate the interface.  */
105     if (ip_ptr -> nx_ip_interface[0].nx_interface_valid == NX_FALSE)
106     {
107         return(NX_INVALID_INTERFACE);
108     }
109 
110     /* Check for appropriate caller.  */
111     NX_THREADS_ONLY_CALLER_CHECKING
112 
113     /* Call actual IGMP multicast leave function.  */
114     status =  _nx_igmp_multicast_leave(ip_ptr, group_address);
115 
116     /* Return completion status.  */
117     return(status);
118 #else /* NX_DISABLE_IPV4  */
119     NX_PARAMETER_NOT_USED(ip_ptr);
120     NX_PARAMETER_NOT_USED(group_address);
121 
122     return(NX_NOT_SUPPORTED);
123 #endif /* !NX_DISABLE_IPV4  */
124 }
125 
126