summaryrefslogtreecommitdiff
path: root/common/src/nx_rarp_packet_send.c
blob: 4cb2a8db39614b02dc735070d09d0bcff7ca9c21 (plain)
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
184
185
186
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Reverse Address Resolution Protocol (RARP)                          */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_rarp.h"
#include "nx_packet.h"

#ifndef NX_DISABLE_IPV4
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_rarp_packet_send                                PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function builds an RARP packet and calls the associated driver */
/*    to send it out on the network.                                      */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP instance        */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _nx_packet_allocate                   Allocate a packet for the     */
/*                                            RARP request                */
/*    (ip_link_driver)                      User supplied link driver     */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    NetX Source Code                                                    */
/*                                                                        */
/**************************************************************************/
VOID  _nx_rarp_packet_send(NX_IP *ip_ptr)
{

NX_PACKET   *request_ptr;
ULONG       *message_ptr;
NX_IP_DRIVER driver_request;
ULONG        i;


    /* Determine which interfaces to send RARP packets out from (e.g. do not have IP addresses). */
    for (i = 0; i < NX_MAX_PHYSICAL_INTERFACES; i++)
    {

        /* Skip this interface if it is not initialized yet. */
        if (ip_ptr -> nx_ip_interface[i].nx_interface_valid == 0)
        {
            continue;
        }

        /* If the interface has a valid address, skip it. */
        if (ip_ptr -> nx_ip_interface[i].nx_interface_ip_address != 0)
        {
            continue;
        }


        /* Skip this interface if mapping is not required, i.e. the driver is not Ethernet-like. */
        /*lint -e{539} suppress positive indentation.  */
        if (ip_ptr -> nx_ip_interface[i].nx_interface_address_mapping_needed == 0)
        {
            continue;
        }

        /* Allocate a packet to build the RARP message in.  */
#ifdef NX_ENABLE_DUAL_PACKET_POOL
        /* Allocate from auxiliary packet pool first. */
        if (_nx_packet_allocate(ip_ptr -> nx_ip_auxiliary_packet_pool, &request_ptr, (NX_PHYSICAL_HEADER + NX_RARP_MESSAGE_SIZE), NX_NO_WAIT))
        {
            if (ip_ptr -> nx_ip_auxiliary_packet_pool != ip_ptr -> nx_ip_default_packet_pool)
#endif /* NX_ENABLE_DUAL_PACKET_POOL */
            {
                if (_nx_packet_allocate(ip_ptr -> nx_ip_default_packet_pool, &request_ptr, (NX_PHYSICAL_HEADER + NX_RARP_MESSAGE_SIZE), NX_NO_WAIT))
                {

                    /* Error getting packet, so just get out!  */
                    return;
                }
            }
#ifdef NX_ENABLE_DUAL_PACKET_POOL
            else
            {

                /* Error getting packet, so just get out!  */
                return;
            }
        }
#endif /* NX_ENABLE_DUAL_PACKET_POOL */

        /* Add debug information. */
        NX_PACKET_DEBUG(__FILE__, __LINE__, request_ptr);

#ifndef NX_DISABLE_RARP_INFO
        /* Increment the RARP requests sent count.  */
        ip_ptr -> nx_ip_rarp_requests_sent++;
#endif
        /*lint -e{644} suppress variable might not be initialized, since "request_ptr" was initialized in _nx_packet_allocate. */
        request_ptr -> nx_packet_address.nx_packet_interface_ptr = &(ip_ptr -> nx_ip_interface[i]);
        /* Build the RARP request packet.  */

        /* Setup the size of the RARP message.  */
        request_ptr -> nx_packet_length =  NX_RARP_MESSAGE_SIZE;

        /* Setup the prepend pointer.  */
        request_ptr -> nx_packet_prepend_ptr -= NX_RARP_MESSAGE_SIZE;

        /* Setup the pointer to the message area.  */
        /*lint -e{927} -e{826} suppress cast of pointer to pointer, since it is necessary  */
        message_ptr =  (ULONG *)request_ptr -> nx_packet_prepend_ptr;

        /* Write the Hardware type into the message.  */
        *message_ptr =        (ULONG)(NX_RARP_HARDWARE_TYPE << 16) | (NX_RARP_PROTOCOL_TYPE);
        *(message_ptr + 1) =  (ULONG)(NX_RARP_HARDWARE_SIZE << 24) | (NX_RARP_PROTOCOL_SIZE << 16) | NX_RARP_OPTION_REQUEST;
        *(message_ptr + 2) =  (ULONG)(request_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_physical_address_msw << 16) |
                                     (request_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_physical_address_lsw >> 16);
        *(message_ptr + 3) =  (ULONG)(request_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_physical_address_lsw << 16);
        *(message_ptr + 4) =  (ULONG)(request_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_physical_address_msw & NX_LOWER_16_MASK);
        *(message_ptr + 5) =  (ULONG)(request_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_physical_address_lsw);
        *(message_ptr + 6) =  (ULONG)0;

        /* If trace is enabled, insert this event into the trace buffer.  */
        NX_TRACE_IN_LINE_INSERT(NX_TRACE_INTERNAL_RARP_SEND, ip_ptr, 0, request_ptr, *(message_ptr + 1), NX_TRACE_INTERNAL_EVENTS, 0, 0);

        /* Endian swapping logic.  If NX_LITTLE_ENDIAN is specified, these macros will
           swap the endian of the RARP message.  */
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr));
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr + 1));
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr + 2));
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr + 3));
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr + 4));
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr + 5));
        NX_CHANGE_ULONG_ENDIAN(*(message_ptr + 6));

        /* Send the RARP request to the driver.  */
        driver_request.nx_ip_driver_ptr =                   ip_ptr;
        driver_request.nx_ip_driver_command =               NX_LINK_RARP_SEND;
        driver_request.nx_ip_driver_packet =                request_ptr;
        driver_request.nx_ip_driver_physical_address_msw =  0xFFFFUL;
        driver_request.nx_ip_driver_physical_address_lsw =  0xFFFFFFFFUL;
        driver_request.nx_ip_driver_interface =             request_ptr -> nx_packet_address.nx_packet_interface_ptr;

        /* If trace is enabled, insert this event into the trace buffer.  */
        NX_TRACE_IN_LINE_INSERT(NX_TRACE_INTERNAL_IO_DRIVER_RARP_SEND, ip_ptr, request_ptr, request_ptr -> nx_packet_length, 0, NX_TRACE_INTERNAL_EVENTS, 0, 0);

        (request_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_link_driver_entry)(&driver_request);
    }

    return;
}
#endif /* !NX_DISABLE_IPV4  */