Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Internet Group Management Protocol (IGMP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_ip.h"
#include "nx_igmp.h"
/* Bring in externs for caller checking code. */
NX_CALLER_CHECKING_EXTERNS
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_igmp_multicast_join PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks for errors in the IGMP multicast join */
/* function call. */
/* */
/* INPUT */
/* */
/* ip_ptr IP instance pointer */
/* group_address Multicast group to join */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_igmp_multicast_join Actual IGMP multicast join */
/* function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nxe_igmp_multicast_join(NX_IP *ip_ptr, ULONG group_address)
{
#ifndef NX_DISABLE_IPV4
UINT status;
/* Check for invalid input pointers. */
if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
{
return(NX_PTR_ERROR);
}
/* Check for invalid multicast address. */
if ((group_address & NX_IP_CLASS_D_MASK) != NX_IP_CLASS_D_TYPE)
{
return(NX_IP_ADDRESS_ERROR);
}
/* Check to see if IGMP is enabled. */
if (!ip_ptr -> nx_ip_igmp_packet_receive)
{
return(NX_NOT_ENABLED);
}
/* Validate the interface. For backward compatibility, this service
assumes multicast join on the primary interface, which is nx_ip_interface[0]. */
if (ip_ptr -> nx_ip_interface[0].nx_interface_valid == NX_FALSE)
{
return(NX_INVALID_INTERFACE);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Call actual IGMP multicast join function. */
status = _nx_igmp_multicast_join(ip_ptr, group_address);
/* Return completion status. */
return(status);
#else /* NX_DISABLE_IPV4 */
NX_PARAMETER_NOT_USED(ip_ptr);
NX_PARAMETER_NOT_USED(group_address);
return(NX_NOT_SUPPORTED);
#endif /* !NX_DISABLE_IPV4 */
}