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_multicast_join 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 join */ 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_join Actual IGMP multicast join */ 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_join(NX_IP * ip_ptr,ULONG group_address)79UINT _nxe_igmp_multicast_join(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. For backward compatibility, this service 105 assumes multicast join on the primary interface, which is nx_ip_interface[0]. */ 106 if (ip_ptr -> nx_ip_interface[0].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 join function. */ 115 status = _nx_igmp_multicast_join(ip_ptr, group_address); 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 123 return(NX_NOT_SUPPORTED); 124 #endif /* !NX_DISABLE_IPV4 */ 125 } 126 127
