1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** NetX Component */
17 /** */
18 /** Transmission Control Protocol (TCP) */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define NX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_tcp.h"
30
31
32 /* Bring in externs for caller checking code. */
33
34 NX_CALLER_CHECKING_EXTERNS
35
36
37 /**************************************************************************/
38 /* */
39 /* FUNCTION RELEASE */
40 /* */
41 /* _nxde_tcp_client_socket_connect PORTABLE C */
42 /* 6.1 */
43 /* AUTHOR */
44 /* */
45 /* Yuxin Zhou, Microsoft Corporation */
46 /* */
47 /* DESCRIPTION */
48 /* */
49 /* This function checks for errors in the TCP client socket connect */
50 /* function call. */
51 /* */
52 /* INPUT */
53 /* */
54 /* socket_ptr Pointer to TCP client socket */
55 /* server_ip IP address of server */
56 /* server_port Port number of server */
57 /* wait_option Suspension option */
58 /* */
59 /* OUTPUT */
60 /* */
61 /* status Acctual completion status */
62 /* NX_PTR_ERROR Invalid pointer input */
63 /* NX_NOT_ENABLED TCP not enabled */
64 /* NX_IP_ADDRESS_ERROR Invalid TCP server IP address */
65 /* NX_INVALID_PORT Invalid TCP server port */
66 /* */
67 /* CALLS */
68 /* */
69 /* _nxd_tcp_client_socket_connect Actual client socket connect */
70 /* function */
71 /* */
72 /* CALLED BY */
73 /* */
74 /* Application Code */
75 /* */
76 /* RELEASE HISTORY */
77 /* */
78 /* DATE NAME DESCRIPTION */
79 /* */
80 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
81 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
82 /* resulting in version 6.1 */
83 /* */
84 /**************************************************************************/
_nxde_tcp_client_socket_connect(NX_TCP_SOCKET * socket_ptr,NXD_ADDRESS * server_ip,UINT server_port,ULONG wait_option)85 UINT _nxde_tcp_client_socket_connect(NX_TCP_SOCKET *socket_ptr,
86 NXD_ADDRESS *server_ip,
87 UINT server_port, ULONG wait_option)
88 {
89
90 UINT status;
91
92
93 /* Check for invalid input pointers. */
94 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID))
95 {
96 return(NX_PTR_ERROR);
97 }
98
99 /* Verify TCP is enabled. */
100 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive)
101 {
102 return(NX_NOT_ENABLED);
103 }
104
105
106 /* Check for valid TCP server address. */
107 if (server_ip == NX_NULL)
108 {
109 return(NX_IP_ADDRESS_ERROR);
110 }
111
112 /* Check that the server IP address version is either IPv4 or IPv6. */
113 if ((server_ip -> nxd_ip_version != NX_IP_VERSION_V4) &&
114 (server_ip -> nxd_ip_version != NX_IP_VERSION_V6))
115 {
116
117 return(NX_IP_ADDRESS_ERROR);
118 }
119
120 #ifndef NX_DISABLE_IPV4
121 /* Check for a valid server IP address if the server_ip is version IPv4. */
122 if (server_ip -> nxd_ip_version == NX_IP_VERSION_V4)
123 {
124 if (((server_ip -> nxd_ip_address.v4 & NX_IP_CLASS_A_MASK) != NX_IP_CLASS_A_TYPE) &&
125 ((server_ip -> nxd_ip_address.v4 & NX_IP_CLASS_B_MASK) != NX_IP_CLASS_B_TYPE) &&
126 ((server_ip -> nxd_ip_address.v4 & NX_IP_CLASS_C_MASK) != NX_IP_CLASS_C_TYPE))
127 {
128 return(NX_IP_ADDRESS_ERROR);
129 }
130 }
131 #endif /* !NX_DISABLE_IPV4 */
132
133 /* Check for an invalid port. */
134 if (((ULONG)server_port) > (ULONG)NX_MAX_PORT)
135 {
136 return(NX_INVALID_PORT);
137 }
138
139 /* Check for appropriate caller. */
140 NX_THREADS_ONLY_CALLER_CHECKING
141
142 /* Call actual TCP client socket connect function. */
143 status = _nxd_tcp_client_socket_connect(socket_ptr, server_ip, server_port, wait_option);
144
145 /* Return completion status. */
146 return(status);
147 }
148
149
