Skip to content

Commit 51c0a04

Browse files
Remove obsolete SockServer embedded implementations (#37)
1 parent 3f8a7cf commit 51c0a04

74 files changed

Lines changed: 14 additions & 29792 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

ARM.CMSIS-Driver_Validation.pdsc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- Update USART Server application to CMSIS solution format
1717
- Add USART Server application template
1818
- Remove XML report format
19+
- Remove obsolete SockServer embedded implementations
1920
- Improve Ethernet driver validation
2021
- Minor update to SPI driver validation
2122
- Minor update to USART driver validation

Documentation/Doxygen/src/DV_WiFi.txt

Lines changed: 13 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55

66
The WiFi driver validation requires the following hardware:
77
- WiFi Access Point connected to the local network
8-
- Hardware running SockServer (can be \ref sockserver_pc "PC running Microsoft Windows" or an
9-
\ref sockserver_embedded "embedded system")
8+
- \ref sockserver_pc "PC running Microsoft Windows"
109

1110
The WiFi driver validation requires the following software:
1211
- \ref wifi_sock_setup "SockServer" application running in the same network as WiFi Access Point used for testing
@@ -18,10 +17,10 @@ The WiFi driver validation requires the following software:
1817
\defgroup wifi_config Configuration
1918
\ingroup dv_wifi
2019

21-
The WiFi driver validation settings are available in the <b>DV_WiFi_Config.h</b> configuration file.
20+
The WiFi driver validation settings are available in the **DV_WiFi_Config.h** configuration file.
2221

2322
Some settings depend on the test environment and need to be changed for proper operation of the WiFi driver validation.<br>
24-
These settings can be found under <b>Configuration</b> settings in the <b>DV_WiFi_Config.h</b> configuration file and need to
23+
These settings can be found under **Configuration** settings in the **DV_WiFi_Config.h** configuration file and need to
2524
be set as follows:
2625

2726
\image html dv_wifi_config_h.png "DV_WiFi_Config.h configuration file in Configuration Wizard view mode"
@@ -46,17 +45,17 @@ be set as follows:
4645

4746
\note IP address is displayed by the SockServer application (on the embedded board's LCD when using embedded SockServer).
4847

49-
Under <b>Tests</b> select testing functionality as required.
48+
Under **Tests** select testing functionality as required.
5049
For details on tests performed by each test function please refer to \ref wifi_tests "WiFi Tests".
5150

52-
<b>Control</b>, <b>Management</b> and <b>Socket API (requires SockServer)</b> group of tests enable or disable
51+
<b>Control</b>, **Management** and **Socket API (requires SockServer)** group of tests enable or disable
5352
WiFi Driver API function tests respectively.
5453

55-
<b>Management (requires user interaction)</b> and <b>Socket Operation (requires SockServer)</b> group of tests
54+
<b>Management (requires user interaction)</b> and **Socket Operation (requires SockServer)** group of tests
5655
are used for more complex operational test of the WiFi driver.<br>
5756
A brief description of each test functionality can be viewed by using
5857
<a href="https://developer.arm.com/documentation/101407/0537/Utilities/Configuration-Wizard" target="_blank">Configuration Wizard</a>
59-
view of the <b>DV_WiFi_Config.h</b> file and clicking on the test or hovering a mouse pointer over it.
58+
view of the **DV_WiFi_Config.h** file and clicking on the test or hovering a mouse pointer over it.
6059

6160
*/
6261

@@ -67,15 +66,10 @@ view of the <b>DV_WiFi_Config.h</b> file and clicking on the test or hovering a
6766
\ingroup dv_wifi
6867

6968
The \b SockServer is an application providing a set of services used by the WiFi CMSIS-Driver Validation suite to test the
70-
Socket interface of the WiFi driver. It is located in the <b>.\\Tools\\SockServer</b> subdirectory of the pack root directory.
69+
Socket interface of the WiFi driver. It is located in the **`<pack installation root>/Tools/SockServer`** subdirectory of the pack root directory.
7170
The SockServer is available for different target systems. It runs several standard network services.
7271

73-
The SockServer is available for following target systems:
74-
- <b>Personal Computer</b> running Microsoft Windows (executable located in <b>.\\Tools\\SockServer\\PC\\Win</b>)
75-
- <b>Keil MCB4300</b> evaluation board (µVision project located in <b>.\\Tools\\SockServer\\Embedded\\MDK\\Board\\MCB4300</b>)
76-
- <b>Keil MCBSTM32F400</b> evaluation board (µVision project located in <b>.\\Tools\\SockServer\\Embedded\\MDK\\Board\\MCBSTM32F400</b>)
77-
78-
\note To run SockServer in an embedded system, you need a license for MDK-Professional (for the MDK-Middleware Network component).
72+
The **SockServer** is available for **Personal Computer** running Microsoft Windows (executable located in **`<pack installation root>/Tools/SockServer/PC/Win`**).
7973

8074
The following services are available by SockServer:
8175
- \b Echo service on port \token{7}, TCP and UDP
@@ -89,26 +83,24 @@ The following services are available by SockServer:
8983
- \b Telnet service on port \token{23}
9084
\n (SockServer status monitoring service)
9185

92-
\note SockServer provides the Telnet service only in embedded systems.
93-
9486
\section sockserver_pc SockServer for PC running Microsoft Windows
9587

9688
\b Requirements:
9789
- Personal Computer running Microsoft Windows
9890
- PC connection to local network
9991

100-
SockServer is already built and can be executed by running the SockServer.exe file in <b>.\\Tools\\SockServer\\PC\\Win</b>
92+
SockServer is already built and can be executed by running the **SockServer.exe** file in **`<pack installation root>/Tools/SockServer/PC/Win`**.
10193

10294
If you need to change the functionality of SockServer, source files and a batch script for building the executable are
103-
available in <b>.\\Tools\\SockServer\\PC\\Win</b>.
95+
available in **`<pack installation root>/Tools/SockServer/PC/Win`**.
10496

10597
\note
10698
- SockServer build process requires Minimalist GNU for Windows (MinGW).
10799
- To build the SockServer executable for Windows, follow these steps:
108100
- Download and install MinGW from https://winlibs.com/
109101
- Set environment path in Microsoft Windows as explained under Usage heading on https://winlibs.com/#usage
110-
- Run <b>Build.bat</b> located in <b>.\\Tools\\SockServer\\PC\\Win</b> which will result in an executable that is located in
111-
<b>.\\Tools\\SockServer\\PC\\Win</b>
102+
- Run **Build.bat** located in **`<pack installation root>/Tools/SockServer/PC/Win`** which will result in an executable that is located
103+
in **`<pack installation root>/Tools/SockServer/PC/Win`**
112104

113105
\subsection sockserver_pc_win_troubleshooting Troubleshooting
114106

@@ -137,104 +129,6 @@ Problems and solutions:
137129
- Profile: Domain, Private (Public not advised)
138130
- Name: Ping Echo
139131

140-
141-
\section sockserver_embedded SockServer for embedded systems
142-
143-
\b Requirements:
144-
- Keil MCB4300 or Keil MCBSTM32F400 evaluation board
145-
- Wired Ethernet connection to local network
146-
147-
\subsection sockserver_embedded_telnet Using the Telnet service
148-
149-
The Telnet service provides information about received and sent data. This can help to resolve driver problems when WiFi
150-
socket sending and receiving does not work. For example, when the transfer test fails, either \b SocketSend or
151-
\b SocketRecv functions may have failed or both.
152-
153-
For the Telnet connection from the PC, open a CMD window. At the prompt, type the following command or use another Telnet
154-
client application:
155-
\code
156-
c:\>telnet sockserver
157-
\endcode
158-
159-
The initial page opens:
160-
\image html SockServer.png "Initial telnet connection"
161-
162-
You can view the remote IP address, port number, receiving and transmitting counters with the \b stat command:
163-
\image html SockMonitor.png "Status monitoring"
164-
165-
Status monitor constantly updates the SockServer status on the screen. To stop the screen update, press any
166-
telnet client key.
167-
168-
\note You might need to enable the Telnet service in Windows 10 first. Here's a
169-
<a href="https://www.technipages.com/windows-10-enable-telnet" target="_blank">tutorial</a> on how to do this.
170-
171-
\subsection sockserver_embedded_porting Porting SockServer to other targets
172-
173-
Currently, the \b SockServer application is available for the \b MCB4300 and \b MCBSTM32F400 evaluation boards.
174-
To create SockServer application for a different target device, follow the steps below:
175-
-# Create new network project in µVision
176-
-# Select and configure the following software components:
177-
- \b Network:Core and configure the host name and pool size in \b Net_Config.c
178-
\code
179-
#define NET_HOST_NAME "SockServer"
180-
#define NET_MEM_POOL_SIZE 16384
181-
\endcode
182-
- \b Network:Interface:Ethernet and configure the MAC address in \b Net_Config_ETH0.h to avoid collisions
183-
\code
184-
#define ETH0_MAC_ADDR "1E-30-6C-A2-45-5A"
185-
\endcode
186-
- \b Network:Socket:BSD and configure number of sockets in \b Net_Config_BSD.h
187-
\code
188-
#define BSD_NUM_SOCKS 8
189-
#define BSD_SERVER_SOCKS 4
190-
\endcode
191-
- \b Network:Socket:TCP and configure number of sockets in \b Net_Config_TCP.h
192-
\code
193-
#define TCP_NUM_SOCKS 9
194-
\endcode
195-
- \b Network:Socket:UDP and configure number of sockets in \b Net_Config_UDP.h
196-
\code
197-
#define UDP_NUM_SOCKS 10
198-
\endcode
199-
- \b Network:Service:Telnet server and disable authentication in \b Net_Config_Telnet_Server.h
200-
\code
201-
#define TELNET_SERVER_AUTH_ENABLE 0
202-
\endcode
203-
- \b CMSIS \b Driver:Ethernet/MAC/PHY(API) depending on your hardware
204-
-# Configure device specific hardware:
205-
- Configure the CMSIS-Driver for Ethernet and other device specific components (clock system, I/O, ...)
206-
as required. Please consult your device's/board's documentation for more information.
207-
-# Copy and add \b SockServer.c and \b SockServer.h files to the project
208-
-# Copy and add \b Telnet_Server_UIF.c to the project
209-
-# Add the code to start the services in \b main.c
210-
\code
211-
// Application main thread
212-
static void app_main (void *argument) {
213-
214-
netInitialize ();
215-
osDelay (500);
216-
217-
osThreadNew(DgramServer, NULL, NULL);
218-
osThreadNew(StreamServer, NULL, NULL);
219-
osThreadNew(TestAssistant, NULL, NULL);
220-
}
221-
\endcode
222-
-# Increase the default RTX stack size to 400 bytes in <b>RTX_Config.h</b>
223-
\code
224-
#define OS_STACK_SIZE 400
225-
\endcode
226-
-# Set the default global stack to 1024 bytes and heap to 6144 bytes in your device's \b startup \b file
227-
\code
228-
Stack_Size EQU 0x00000400
229-
Heap_Size EQU 0x00001800
230-
\endcode
231-
232-
\subsection sockserver_embedded_troubleshooting Troubleshooting
233-
234-
Problems and solutions:
235-
1. SockServer on multiple embedded systems on the same local network
236-
- Set unique ETH0_MAC_ADDR in Net_Config_ETH0.h for each embedded system in embedded system project
237-
238132
*/
239133

240134
/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/

Tools/SockServer/Embedded/MDK/Board/IMXRT1050-EVKB/Abstract.txt

Lines changed: 0 additions & 67 deletions
This file was deleted.

Tools/SockServer/Embedded/MDK/Board/IMXRT1050-EVKB/Board_IO/retarget_stdio.c

Lines changed: 0 additions & 74 deletions
This file was deleted.

0 commit comments

Comments
 (0)