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
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present Eclipse ThreadX Contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** 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_join_internal PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function handles the request to join the specified multicast */
/* group on a specified network device. */
/* */
/* INPUT */
/* */
/* ip_ptr IP instance pointer */
/* group_address Multicast group to join */
/* interface_index Index to the interface */
/* update_time Update time */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_mutex_get Obtain protection mutex */
/* tx_mutex_put Release protection mutex */
/* (ip_link_driver) Associated IP link driver */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
UINT _nx_igmp_multicast_interface_join_internal(NX_IP *ip_ptr, ULONG group_address,
UINT interface_index, UINT update_time)
{
UINT i;
UINT first_free;
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_JOIN, ip_ptr, group_address, interface_index, 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 either the same group request. */
first_free = NX_MAX_MULTICAST_GROUPS;
for (i = 0; i < NX_MAX_MULTICAST_GROUPS; i++)
{
/* Determine if the specified entry is already in the multicast join list. */
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. The only thing required in this
case is to increment the join count and return. */
ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_count++;
/* Release the IP protection. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return success! */
return(NX_SUCCESS);
}
/* Check for an empty entry. */
if ((ip_ptr -> nx_ipv4_multicast_entry[i].nx_ipv4_multicast_join_list == 0) &&
(first_free == NX_MAX_MULTICAST_GROUPS))
{
/* Remember the first free entry. */
first_free = i;
}
}
/* At this point, we have a new entry. First, check to see if there is an available
entry. */
if (first_free == NX_MAX_MULTICAST_GROUPS)
{
/* Release the protection of the IP instance. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return an error code to indicate there are no more group addresses
available. */
return(NX_NO_MORE_ENTRIES);
}
/* Register the new multicast group with the underlying driver to
ensure that there is room for the new group at the hardware level. */
driver_request.nx_ip_driver_ptr = ip_ptr;
driver_request.nx_ip_driver_command = NX_LINK_MULTICAST_JOIN;
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 = nx_interface;
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_INTERNAL_IO_DRIVER_MULTICAST_JOIN, ip_ptr, 0, 0, 0, NX_TRACE_INTERNAL_EVENTS, 0, 0);
(nx_interface -> nx_interface_link_driver_entry)(&driver_request);
/* Check the return driver status. */
/*lint -e{644} suppress variable might not be initialized, since "nx_ip_driver_status" was initialized in nx_interface_link_driver_entry. */
if (driver_request.nx_ip_driver_status != NX_SUCCESS)
{
/* Release the protection of the IP instance. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return an error code to indicate there are no more group addresses
available. */
return(NX_NO_MORE_ENTRIES);
}
/* Set it up in the IP control structures. */
ip_ptr -> nx_ipv4_multicast_entry[first_free].nx_ipv4_multicast_join_list = group_address;
ip_ptr -> nx_ipv4_multicast_entry[first_free].nx_ipv4_multicast_join_interface_list = nx_interface;
ip_ptr -> nx_ipv4_multicast_entry[first_free].nx_ipv4_multicast_join_count = 1;
ip_ptr -> nx_ipv4_multicast_entry[first_free].nx_ipv4_multicast_update_time = update_time; /* Update on next IGMP periodic */
ip_ptr -> nx_ipv4_multicast_entry[first_free].nx_ipv4_multicast_loopback_enable = ip_ptr -> nx_ip_igmp_global_loopback_enable;
#ifndef NX_DISABLE_IGMP_INFO
/* Increment the IGMP groups joined count. */
ip_ptr -> nx_ip_igmp_groups_joined++;
#endif
/* Release the protection over the IP instance. */
tx_mutex_put(&(ip_ptr -> nx_ip_protection));
/* Return a successful status! */
return(NX_SUCCESS);
}
#endif /* !NX_DISABLE_IPV4 */
|
