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 Protocol (IPv6) */ 19 /** */ 20 /**************************************************************************/ 21 22 #define NX_SOURCE_CODE 23 24 25 /* Include necessary system files. */ 26 27 #include "nx_api.h" 28 #include "nx_ipv6.h" 29 #if defined(NX_ENABLE_IPV6_MULTICAST) && defined(FEATURE_NX_IPV6) 30 #include "nx_ip.h" 31 32 /* Bring in externs for caller checking code. */ 33 34 NX_CALLER_CHECKING_EXTERNS 35 #endif /* NX_ENABLE_IPV6_MULTICAST && FEATURE_NX_IPV6 */ 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxde_ipv6_multicast_interface_join PORTABLE C */ 42 /* 6.1 */ 43 /* AUTHOR */ 44 /* */ 45 /* Yuxin Zhou, Microsoft Corporation */ 46 /* */ 47 /* DESCRIPTION */ 48 /* */ 49 /* This service checks for errors in the IPv6 multicast join call. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* ip_ptr IP instance pointer */ 54 /* group_address IPv6 multicast address */ 55 /* interface_index Index to the phyical interface*/ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* IPv6_Address_Type Obtain IPv6 address type */ 64 /* _nxd_ipv6_multicast_interface_join Actual IPv6 multicast join */ 65 /* function */ 66 /* */ 67 /* CALLED BY */ 68 /* */ 69 /* Application */ 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 /**************************************************************************/ _nxde_ipv6_multicast_interface_join(NX_IP * ip_ptr,NXD_ADDRESS * group_address,UINT interface_index)80UINT _nxde_ipv6_multicast_interface_join(NX_IP *ip_ptr, NXD_ADDRESS *group_address, UINT interface_index) 81 { 82 83 #if defined(NX_ENABLE_IPV6_MULTICAST) && defined(FEATURE_NX_IPV6) 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) || (group_address == NX_NULL)) 89 { 90 return(NX_PTR_ERROR); 91 } 92 93 /* Check for invalid input parameter. */ 94 if ((IPv6_Address_Type(group_address -> nxd_ip_address.v6) & IPV6_ADDRESS_MULTICAST) != IPV6_ADDRESS_MULTICAST) 95 { 96 return(NX_IP_ADDRESS_ERROR); 97 } 98 99 /* Validate the interface. */ 100 if (interface_index >= NX_MAX_PHYSICAL_INTERFACES) 101 { 102 return(NX_INVALID_INTERFACE); 103 } 104 105 /* Validate the interface. */ 106 if (ip_ptr -> nx_ip_interface[interface_index].nx_interface_valid != NX_TRUE) 107 { 108 return(NX_INVALID_INTERFACE); 109 } 110 111 /* Check for appropriate caller. */ 112 NX_THREADS_ONLY_CALLER_CHECKING 113 114 /* Call actual IPv6 enable function. */ 115 status = _nxd_ipv6_multicast_interface_join(ip_ptr, group_address, interface_index); 116 117 /* Return completion status. */ 118 return(status); 119 120 #else /* ! NX_ENABLE_IPV6_MULTICAST */ 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 127 #endif /* NX_ENABLE_IPV6_MULTICAST && FEATURE_NX_IPV6 */ 128 } 129 130
