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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/**************************************************************************/
/* */
/* 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_igmp.h"
#ifndef NX_DISABLE_IPV4
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_igmp_multicast_interface_leave_internal PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function handles the request to leave the specified multicast */
/* group. */
/* */
/* INPUT */
/* */
/* ip_ptr IP instance pointer */
/* group_address Multicast group to join */
/* interface_index Interface index */
/* */
/* OUTPUT */
/* */
/* NX_SUCCESS Successful completion status */
/* NX_ENTRY_NOT_FOUND Group address not found in the*/
/* IGMP join list */
/* */
/* CALLS */
/* */
/* tx_mutex_get Obtain protection mutex */
/* tx_mutex_put Release protection mutex */
/* (ip_link_driver) Associated IP link driver */
/* nx_igmp_interface_report_send Send IGMP group reports */
/* */
/* 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 _nx_igmp_multicast_interface_leave_internal(NX_IP *ip_ptr, ULONG group_address, UINT interface_index)
{
UINT i;
NX_IP_DRIVER driver_request;
NX_INTERFACE *nx_interface;
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_IGMP_MULTICAST_LEAVE, ip_ptr, group_address, 0, 0, NX_TRACE_IGMP_EVENTS, 0, 0);
/* Obtain the IP mutex so we can search the multicast join list. */
tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
nx_interface = &ip_ptr -> nx_ip_interface[interface_index];
/* Search the multicast join list for the group request. */
for (i = 0; i < NX_MAX_MULTICAST_GROUPS; i++)
{
/* Determine if the specified entry is present. */
if ((ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_list == group_address) &&
(ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_interface_list == nx_interface))
{
/* Yes, we have found the same entry. */
/* Decrease the join count. */
ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_count--;
/* Determine if there are no other join requests for this group address. */
if (ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_count == 0)
{
/* Clear the group join value. */
ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_list = 0;
/* Un-register the new multicast group with the underlying driver. */
driver_request.nx_ip_driver_ptr = ip_ptr;
driver_request.nx_ip_driver_command = NX_LINK_MULTICAST_LEAVE;
driver_request.nx_ip_driver_physical_address_msw = NX_IP_MULTICAST_UPPER;
driver_request.nx_ip_driver_physical_address_lsw = NX_IP_MULTICAST_LOWER | (group_address & NX_IP_MULTICAST_MASK);
driver_request.nx_ip_driver_interface = ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_interface_list;
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_INTERNAL_IO_DRIVER_MULTICAST_LEAVE, ip_ptr, 0, 0, 0, NX_TRACE_INTERNAL_EVENTS, 0, 0);
(ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_interface_list -> nx_interface_link_driver_entry)(&driver_request);
/* Clear the interface entry for version IGMPv1. Don't need it anymore. */
ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_interface_list = NX_NULL;
#ifndef NX_DISABLE_IGMP_INFO
/* Decrement the IGMP groups joined count. */
ip_ptr -> nx_ip_igmp_groups_joined--;
#endif
#ifndef NX_DISABLE_IGMPV2
/* Check if the entry is a local multicast join. */
if (ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_update_time == NX_WAIT_FOREVER)
{
/* It is. Release the IP protection. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return success. */
return(NX_SUCCESS);
}
/* IGMPv1 hosts do not send a leave group message. */
if (ip_ptr -> nx_ip_igmp_router_version == NX_IGMP_HOST_VERSION_1)
{
/* Release the IP protection. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return success! */
return(NX_SUCCESS);
}
/* Build and send the leave report packet. */
_nx_igmp_interface_report_send(ip_ptr, group_address, interface_index, NX_FALSE);
#endif /* NX_DISABLE_IGMPV2 */
}
/* Release the IP protection. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return success. */
return(NX_SUCCESS);
}
}
/* At this point we know that the supplied entry was not found. */
/* Release the protection of the IP instance. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return an error code. */
return(NX_ENTRY_NOT_FOUND);
}
#endif /* !NX_DISABLE_IPV4 */