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 /* Bring in externs for caller checking code. */ 32 33 NX_CALLER_CHECKING_EXTERNS 34 35 36 /**************************************************************************/ 37 /* */ 38 /* FUNCTION RELEASE */ 39 /* */ 40 /* _nxe_igmp_multicast_interface_leave PORTABLE C */ 41 /* 6.1 */ 42 /* AUTHOR */ 43 /* */ 44 /* Yuxin Zhou, Microsoft Corporation */ 45 /* */ 46 /* DESCRIPTION */ 47 /* */ 48 /* This function checks for errors in the IGMP multicast join */ 49 /* function call. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* ip_ptr IP instance pointer */ 54 /* group_address Multicast group to join */ 55 /* interface_index Index to the interface */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* _nx_igmp_multicast_interface_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_interface_leave(NX_IP * ip_ptr,ULONG group_address,UINT interface_index)79UINT _nxe_igmp_multicast_interface_leave(NX_IP *ip_ptr, ULONG group_address, UINT interface_index) 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 ((interface_index >= NX_MAX_PHYSICAL_INTERFACES) || 106 (ip_ptr -> nx_ip_interface[interface_index].nx_interface_valid == NX_FALSE)) 107 { 108 return(NX_INVALID_INTERFACE); 109 } 110 111 /* Check for appropriate caller. */ 112 NX_THREADS_ONLY_CALLER_CHECKING 113 114 /* Call actual IGMP multicast leave function. */ 115 status = _nx_igmp_multicast_interface_leave(ip_ptr, group_address, interface_index); 116 117 /* Return completion status. */ 118 return(status); 119 #else /* NX_DISABLE_IPV4 */ 120 NX_PARAMETER_NOT_USED(ip_ptr); 121 NX_PARAMETER_NOT_USED(group_address); 122 NX_PARAMETER_NOT_USED(interface_index); 123 124 return(NX_NOT_SUPPORTED); 125 #endif /* !NX_DISABLE_IPV4 */ 126 } 127 128
