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_join 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 /* */ 56 /* OUTPUT */ 57 /* */ 58 /* status Completion status */ 59 /* */ 60 /* CALLS */ 61 /* */ 62 /* _nx_igmp_multicast_join Actual IGMP multicast join */ 63 /* function */ 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 /**************************************************************************/ _nxe_igmp_multicast_join(NX_IP * ip_ptr,ULONG group_address)78UINT _nxe_igmp_multicast_join(NX_IP *ip_ptr, ULONG group_address) 79 { 80 81 #ifndef NX_DISABLE_IPV4 82 UINT status; 83 84 85 /* Check for invalid input pointers. */ 86 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID)) 87 { 88 return(NX_PTR_ERROR); 89 } 90 91 /* Check for invalid multicast address. */ 92 if ((group_address & NX_IP_CLASS_D_MASK) != NX_IP_CLASS_D_TYPE) 93 { 94 return(NX_IP_ADDRESS_ERROR); 95 } 96 97 /* Check to see if IGMP is enabled. */ 98 if (!ip_ptr -> nx_ip_igmp_packet_receive) 99 { 100 return(NX_NOT_ENABLED); 101 } 102 103 /* Validate the interface. For backward compatibility, this service 104 assumes multicast join on the primary interface, which is nx_ip_interface[0]. */ 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 join function. */ 114 status = _nx_igmp_multicast_join(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
