Skip to content

Commit aa0ca5b

Browse files
committed
update README
1 parent 3ab2ac3 commit aa0ca5b

File tree

1 file changed

+39
-14
lines changed

1 file changed

+39
-14
lines changed

ide/Renesas/e2studio/RX72N/README.md

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
(DRAFT)wolfSSH simple application project for RX72N EnvisionKit board
1+
wolfSSH simple sftp client application project for RX72N EnvisionKit board
22
======
33
## 1. Overview
44
-----
@@ -7,7 +7,7 @@ We provide a simple sftp client program for evaluating wolfSSH targeting the RX7
77

88
The sample provided is a single application that can evaluate the following functions:
99

10-
- SFTPClient: A program that performs SFTP communication with the opposite SSH/SFTP server
10+
- SFTP Client: A program that performs SFTP communication with the opposite SSH/SFTP server
1111

1212
Since the H/W settings and S/W settings for operating the evaluation board have already been prepared, the minimum settings are required to operate the sample application.
1313

@@ -25,7 +25,6 @@ This sample program uses the following hardware and software libraries. If a new
2525
|Emulator| E2 Emulator Lite |
2626
|Toolchain|CCRX v3.06.00|
2727

28-
2928
The project of this sample program has a configuration file that uses the following FIT components.
3029
However, the FIT components themselves are not included in the distribution of this sample application. You need to download it by operating in the IDE. Some FIT components (TSIPs) cannot be downloaded directly from within the IDE and may need to be downloaded separately from the Renesas download site.
3130

@@ -44,15 +43,13 @@ However, the FIT components themselves are not included in the distribution of t
4443
|TCP/IP protocol stack[M3S-T4-Tiny] for Renesas MCUs|2.10|r_t4_rx|
4544
|TSIP(Trusted Secure IP) driver|1.22|r_tsip_rx|
4645

47-
## 3. Importing simple sftp client application project into e2Studio
46+
## 3. Importing a simple sftp client application project into e2Studio
4847
----
4948

5049
There is no need to create a new sample program. Since the project file is already prepared, please import the project from the IDE by following the steps below.
5150

52-
+ e2studio "File" menu> "Open project from file system ..."> "Directory (R) ..." Click the import source button and select the folder from which the project will be imported. Select the folder (Renesas/e2studio/{MCU}/{board-name-folder}/Simple) where this README file exists.
53-
+ Three projects that can be imported are listed, but check only the three projects "test" and "wolfssl" and click the "Finish" button.
54-
55-
You should see the **app_sftpclient**, **wolfcrypt_test**, **wolfssl** and **wolfssh_RX72N** 4 projects you imported into the project explorer.
51+
+ e2studio "File" menu> "Open project from file system ..."> "Directory (R) ..." Click the import source button and select the folder from which the project will be imported. Select the folder (Renesas/e2studio/{MCU}/{board-name-folder}/) where this README file exists.
52+
+ Three projects that can be imported are listed, but check only the four projects "app_sftpclient", "wolfcrypt_test", "wolfssl_RX72N" and "wolfssh_RX72N" and click the "Finish" button.
5653

5754
## 4. FIT module download and smart configurator file generation
5855
----
@@ -71,23 +68,23 @@ You will need to get the required FIT modules yourself. Follow the steps below t
7168

7269
6. Press the "Generate Code" button at the top right of the software component settings pane to have the smart configurator generate the source files. A src/smc_gen folder will be created under the smc project to store source files, libraries, etc.
7370

74-
## 5. Select the behavior of the sftp client application
71+
## 5. SFTP Server and Port Settings for SFTP Client Test Application
7572
----
7673

7774
The test project is a very simple sftp client application, which connects to echo server and gets `working directory` listing.
78-
75+
Before building the test application, set the SFTP server IP address and port number in the project properties.
7976

8077
- SFTP_SERVER_IP : IP address of the SFTP server
8178
- SFTP_SERVER_PORT : Port number of the SFTP server (default: 22222)
8279

8380
Then build the test application.
8481

85-
## 6. Build and run the test application
82+
## 6. Build and run the the application
8683
-----
8784

8885
Now that the test application is ready to build.
8986

90-
1. Build the wolfssl project on the project explorer, then the test project.
87+
1. Build the wolfssl and wolfssh projects on the project explorer, then the test project.
9188

9289
2. After a successful build, connect the target board to the emulator and supply external power.
9390

@@ -98,9 +95,37 @@ Now that the test application is ready to build.
9895
5. Press the run button to run the test application.
9996

10097

101-
10298
## 8. Running sftp client application to echo server
103-
99+
You can see the following log output on the Renesas Debug Virtual Console when the sftp client application runs successfully and connects to the echo server.
100+
101+
`Server output example`
102+
```
103+
./examples/echoserver/echoserver
104+
Keying Complete:
105+
WOLFSSH_TEXT_KEX_ALGO : ECDH
106+
WOLFSSH_TEXT_KEX_CURVE : nistp256
107+
WOLFSSH_TEXT_KEX_HASH : SHA-256
108+
WOLFSSH_TEXT_CRYPTO_IN_CIPHER : AES-256 GCM
109+
WOLFSSH_TEXT_CRYPTO_IN_MAC : AES256 GCM (in ETM mode)
110+
WOLFSSH_TEXT_CRYPTO_OUT_CIPHER : AES-256 GCM
111+
WOLFSSH_TEXT_CRYPTO_OUT_MAC : AES256 GCM (in ETM mode)
112+
```
113+
114+
`Client output example`
115+
```
116+
config.status
117+
.gitignore
118+
sshd_config
119+
apps
120+
...
121+
zephyr
122+
libtool
123+
Makefile.am
124+
Makefile.in
125+
src
126+
aclocal.m4
127+
sftp client completes 0
128+
```
104129

105130
# 9. Support
106131

0 commit comments

Comments
 (0)