2
0

README.md 7.6 KB

wolfSSL for Renesas RA Evaluation Kit (EK-RA6M3)

Description

This directory contains e2studio projects targeted at the Renesas RA 32-bit MCUs.\ The example projects include a wolfSSL TLS client and server.\ They also include benchmark and cryptography tests for the wolfCrypt library.

The wolfssl project contains both the wolfSSL and wolfCrypt libraries.\ It is built as a Renesas RA C Library Project and contains the Renesas RA\ configuration.

The other projects (benchmark, client, server and test) are built as a\ Renesas RA C Project Using RA Library, where the RA library is the wolfssl project.\ The wolfssl Project Summary is listed below and is relevant for every project.

Project Summary

Item Name/Version
Board EK-RA6M3
Device R7FA6M3AH3CFC
Toolchain GCC ARM Embedded
FSP Version 3.5.0

Selected software components

Components Version
Board Support Package Common Files v3.5.0
Arm CMSIS Version 5 - Core (M) v5.8.0+renesas.0.fsp.3.5.0
FreeRTOS v10.4.3-LTS.Patch.2+fsp.3.5.0
RA6M3-EK Board Support Files v3.5.0
Board support package for R7FA6M3AH3CFC v3.5.0
Board support package for RA6M3 v3.5.0
Board support package for RA6M3 - FSP Data v3.5.0
FreeRTOS - Memory Management - Heap 4 v10.4.3-LTS.Patch.2+fsp.3.5.0
r_ether to FreeRTOS+TCP Wrapper v3.5.0
Ethernet v3.5.0
Ethernet PHY v3.5.0
FreeRTOS+TCP v2.3.2-LTS.Patch.1+fsp.3.5.0
FreeRTOS - Buffer Allocation 2 v2.3.2-LTS.Patch.1+fsp.3.5.0

Setup Steps

The project directories are missing files necessary to build the project.\ These files can be generated when creating a new Renesas RA Project.\ The following steps explain how to generate the missing files and where to place them.

1.) Create a 'dummy' Renesas RA C Library Project.

  • Click File->New->RA C/C++ Project
  • Click Renesas RA C Library Project. Click Next
  • Enter dummy_library as the project name. Click Next.
  • Under Board: Custom User Board, select EK-RA6M3.
  • Under RTOS: No RTOS, select FreeRTOS.
  • Click Next. Select FreeRTOS - Minimal - Static Allocation
  • Click Finish.
  • Open Smart Configurator by clicking configuration.xml in the project
  • Go to BSP tab and increase Heap Size under RA Common on Properties page, e.g. 0x1000
  • Go to Stacks tab
  • Add New thead and set properties
Property Value
Thread Symbol wolfssl_tst_thread
Thread Name wolf_tst_thread
Thread Stack size increase depending on your environment
e.g. 0xA000
Thread MemoryAllocation Dyamic
Common General Use Mutexes Enabled
Common General Enable Backward Compatibility Enabled
Common Memory Allocation Support Dynamic Allocation Enabled
Common Memory Allocation Total Heap Size increase depending on your environment
e.g. 0x20000
  • Add Heap 4 stack to sce_tst_thread from New Stack -> RTOS -> FreeRTOS Heap 4
  • Add FreeRTOS + TCP stack to sce_tst_thread from New Stack -> Networking -> FreeRTOS+TCP and set properties
Property Value
Network Events call vApplicationIPNetworkEventHook Disable
Use DHCP Disable

2.) Create a 'dummy' Renesas RA C Project Using RA Library.

  • Click File->New->RA C/C++ Project
  • Click Renesas RA C Project Using RA Library. Click Next
  • Enter dummy_app as the project name. Click Next.
  • Under Executable Using an RA Static library
  • Enter dummy_app as the project name. Click Next
  • Select dummy_library from Select Renesas RA library project.
  • Click Finish.

3.) Import all the wolfSSL Projects into e2studio workspace.

  • Click File->Open Projects from File System
  • Click Directory... to the right of Import source
  • Select the RA6M3 folder location that contains the projects\ example path: wolfssl/IDE/Renesas/e2studio/RA6M3
  • Deselect the Non-Eclipse project, RA6M3, by clicking the checkbox\ Only the folders with 'Eclipse project' under 'Import as' need to be selected.
  • Click Finish.

4.) Copy files from dummy_library into wolfSSL_RA6M3

  • Expand the dummy_library and wolfSSL_RA6M3 projects\ (Click the drop-down arrow to the left of the project name.)
  • Select and Copy the following folders/files inside dummy_library\

ra/\ ra_gen/\ ra_cfg/\ script/\ R7FA6M3AH3CFC.pincfg\ configuration.xml

  • Paste the copied folders/files into wolfSSL_RA6M3
  • The dummy_library project can now be deleted.
  • Generate Project Content.
    • Click Open RA Configuration in the top bar (Grey Settings Cog)
    • Click Generate Project Content at top right (Green Icon)
  • Build wolfSSL_RA6M3.

5.) Copy files from dummy_app into each executable projects

  • Select and Copy the following folder inside dummy_app\

script/

  • Paste the copied folders into each executable projects which are Crypt test, benchmark, client and server projects\
  • The dummy_app project can now be deleted.

6.) Setup Network Environment

    The client and server projects have defines inside their wolfssl_thread_entry.h.
    These defines (ucIPAddress ... ucDNSServerAddress) may need to be changed
    based on your internal network environment.  The g_ether0_mac_address is the default
    mac address found inside the RA configuration inside the wolfssl project.
    The client wolfssl_thread_entry.h has defines (SERVER_IP and DEFAULT_PORT) that
    will need to be changed based on the server you're trying to connect to over
    the ethernet connection.

Build and Run

Build Each Project

Right-Click each Project and select Build.

Run wolfCrypt Test and Benchmark

1.) Right-Click the Project name.\ 2.) Select Debug As -> Renesas GDB Hardware Debugging\ 3.) Select J-Link ARM. Click OK.\ 4.) Select R7FA6M3AH. Click OK.

Run the wolfSSL TLS Server Example.

1.) Right-Click the Project name.\ 2.) Select Debug As -> Renesas GDB Hardware Debugging\ 3.) Select J-Link ARM. Click OK.\ 4.) Select R7FA6M3AH. Click OK.\ 5.) Run the following wolfSSL example client command inside the base of the wolfssl directory.

./examples/client/client -v 4 -h "ucIPAddress" -p 11111 -A ./certs/1024/ca-cert.pem

NOTE: "ucIPAddress" is "192.168.1.241" by default. (See wolfssl_thread_entry.h)

Run the wolfSSL TLS Client Example.

1.) Run the following wolfSSL example server command inside the base of the wolfssl directory.

./examples/server/server -v 4 -b -d -p 11111 -c ./certs/1024/server-cert.pem -k ./certs/1024/server-key.pem

NOTE: The port 11111 is the DEFAULT_PORT inside wolfssl_thread_entry.h.

2.) Right-Click the Project name.\ 3.) Select Debug As -> Renesas GDB Hardware Debugging\ 4.) Select J-Link ARM. Click OK.\ 5.) Select R7FA6M3AH. Click OK.

Troubleshooting

  • The commands for the example client/server assumes it is being run from the base directory of wolfssl.

  • Enter "#define DEBUG_WOLFSSL" inside user_settings.h or wolfssl_thread_entry.c\ to enable wolfssl debug messages to the Renesas Virtual Debug Console.

  • Some linking errors can be caused by the e2studio project files needing to be rebuilt and freshened. Right-Click a project, select Index, click Rebuild and then click Freshen Files. Repeat for each project.

Support Forum

Support Email: support@wolfssl.com

Resources

wolfSSL Website

wolfSSL Wiki

wolfSSL Manual

wolfSSL API Reference

wolfCrypt API Reference

TLS 1.3