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