summaryrefslogtreecommitdiff
path: root/common/src/nx_tcp_socket_driver_packet_receive.c
blob: f32ef4f55cf49e40eb67b6bb45e6b0e741d843cc (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Transmission Control Protocol (TCP)                                 */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_tcp.h"
#include "nx_packet.h"
#include "tx_thread.h"
#include "nx_ip.h"
#ifdef FEATURE_NX_IPV6
#include "nx_ipv6.h"
#endif /* FEATURE_NX_IPV6 */

#ifdef NX_ENABLE_TCPIP_OFFLOAD
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_tcp_socket_driver_packet_receive                PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function receives a TCP packet from the TCP/IP driver and add  */
/*    fake TCP/IP header. Then pass the packet to IP deferred receive     */
/*    routine.                                                            */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    socket_ptr                            Pointer to owning socket      */
/*    packet_ptr                            Pointer to packet to process  */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain protection mutex       */
/*    tx_mutex_put                          Release protection mutex      */
/*    _nx_ip_packet_deferred_receive        Defer IP packet receive       */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Driver                                                              */
/*                                                                        */
/**************************************************************************/
VOID _nx_tcp_socket_driver_packet_receive(NX_TCP_SOCKET *socket_ptr, NX_PACKET *packet_ptr)
{
NX_IP *ip_ptr;
NX_TCP_HEADER *header_ptr;

    /* Setup the IP pointer.  */
    ip_ptr =  socket_ptr -> nx_tcp_socket_ip_ptr;
        
    /* Obtain the IP internal mutex before processing the IP event.  */
    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);

    if (packet_ptr == NX_NULL)
    {

        /* Connection closed.  */
        if (socket_ptr -> nx_tcp_socket_state == NX_TCP_ESTABLISHED)
        {
            socket_ptr -> nx_tcp_socket_state =  NX_TCP_CLOSE_WAIT;

            /* Loop to release all threads suspended while trying to receive on the socket.  */
            while (socket_ptr -> nx_tcp_socket_receive_suspension_list)
            {

                /* Release the head of the receive suspension list. */
                _nx_tcp_receive_cleanup(socket_ptr -> nx_tcp_socket_receive_suspension_list NX_CLEANUP_ARGUMENT);
            }

            /* If given, call the application's disconnect callback function
            for disconnect.  */
            if (socket_ptr -> nx_tcp_disconnect_callback)
            {

                /* Call the application's disconnect handling function.  It is
                responsible for calling the socket disconnect function.  */
                (socket_ptr -> nx_tcp_disconnect_callback)(socket_ptr);
            }
        }
        
        /* Release the IP internal mutex.  */
        tx_mutex_put(&(ip_ptr -> nx_ip_protection));
        return;
    }

    /* Fake TCP and IP header.  */
    /* Prepend the TCP header to the packet.  First, make room for the TCP header.  */
    packet_ptr -> nx_packet_prepend_ptr =  packet_ptr -> nx_packet_prepend_ptr - sizeof(NX_TCP_HEADER);

    /* Add the length of the TCP header.  */
    packet_ptr -> nx_packet_length =  packet_ptr -> nx_packet_length + (ULONG)sizeof(NX_TCP_HEADER);

    /* Pickup the pointer to the head of the TCP packet.  */
    /*lint -e{927} -e{826} suppress cast of pointer to pointer, since it is necessary  */
    header_ptr =  (NX_TCP_HEADER *)packet_ptr -> nx_packet_prepend_ptr;

    /* Build the output request in the TCP header.  */
    header_ptr -> nx_tcp_header_word_0 = (((ULONG)(socket_ptr -> nx_tcp_socket_connect_port)) << NX_SHIFT_BY_16) |
                                          (ULONG)socket_ptr -> nx_tcp_socket_port;
    NX_CHANGE_ULONG_ENDIAN(header_ptr -> nx_tcp_header_word_0);
    header_ptr -> nx_tcp_acknowledgment_number = 0;
    header_ptr -> nx_tcp_sequence_number = 0;
    header_ptr -> nx_tcp_header_word_3 = NX_TCP_HEADER_SIZE | NX_TCP_ACK_BIT | NX_TCP_PSH_BIT;
    NX_CHANGE_ULONG_ENDIAN(header_ptr -> nx_tcp_header_word_3);
    header_ptr -> nx_tcp_header_word_4 = 0;

#ifndef NX_DISABLE_IPV4
    if (socket_ptr -> nx_tcp_socket_connect_ip.nxd_ip_version == NX_IP_VERSION_V4)
    {
        _nx_ip_header_add(ip_ptr, packet_ptr, socket_ptr -> nx_tcp_socket_connect_ip.nxd_ip_address.v4,
                          packet_ptr -> nx_packet_ip_interface -> nx_interface_ip_address,
                          socket_ptr -> nx_tcp_socket_type_of_service,
                          socket_ptr -> nx_tcp_socket_time_to_live,
                          NX_IP_TCP,
                          socket_ptr -> nx_tcp_socket_fragment_enable);
    }
#endif /* !NX_DISABLE_IPV4  */

#ifdef FEATURE_NX_IPV6
    if (socket_ptr -> nx_tcp_socket_connect_ip.nxd_ip_version == NX_IP_VERSION_V6)
    {
        if (_nx_ipv6_header_add(ip_ptr, &packet_ptr,
                                NX_PROTOCOL_TCP,
                                packet_ptr -> nx_packet_length,
                                ip_ptr -> nx_ipv6_hop_limit,
                                socket_ptr -> nx_tcp_socket_connect_ip.nxd_ip_address.v6,
                                socket_ptr -> nx_tcp_socket_ipv6_addr -> nxd_ipv6_address,
                                NX_NULL))
        {
        
            /* Release the IP internal mutex.  */
            tx_mutex_put(&(ip_ptr -> nx_ip_protection));
            return;
        }
    }
#endif /* FEATURE_NX_IPV6 */
        
    /* Release the IP internal mutex.  */
    tx_mutex_put(&(ip_ptr -> nx_ip_protection));

    _nx_ip_packet_deferred_receive(ip_ptr, packet_ptr);    
}
#endif /* NX_ENABLE_TCPIP_OFFLOAD */