diff --git a/tirtos_ccs_examples/README.md b/tirtos_ccs_examples/README.md index 659b5d22..033263dd 100644 --- a/tirtos_ccs_examples/README.md +++ b/tirtos_ccs_examples/README.md @@ -1,40 +1,148 @@ -Disclaimer ---------------------------------------------------------- -These have currently been tested in windows CCS only. Once testing on the linux distribution for CCS is complete this README will be updated. - -Setting up the file system ---------------------------------------------------------- -ensure that wolfssl is on the C:/ drive and remove any version numbers on the file. For example if your wolfssl directory is named "wolfssl_3_1_0 or wolfssl-3.1.0" rename it to "wolfssl". You should now have C:/wolfssl directory. - -Clone this repository using "github for windows". The projects have been made portable so you can run them straight from the github clone repo or you can copy and paste the "tirtos_ccs_examples" folder out of the repo to wherever and -they should still debug just fine once imported into your workspace (see end of this README). - -Instructions for building wolfSSL application for TI-RTOS ---------------------------------------------------------- - -Installing the software ------------------------ -1. Install the NDK product ndk 2.24.00.05 in C:/ti using the following URL (http://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/tmp/ndk_2_24_00_05_eng.zip) -2. Open CCS. A prompt opens asking to install discovered product. Select the ndk product and click finish. Restart if prompted. -3. In CCS, open View -> CCS App Center. Search "ti-rtos". Select "TI-RTOS for TivaC" from the results and click Install Software. Follow the instructions. - - -Building wolfSSL libraries for TI-RTOS -------------------------------------- -1. Replace tirtos.mak in C:\ti\tirtos_tivac_2_00_02_36 with the tirtos.mak from git@github.com:wolfSSL/wolfssl.git. Ensure you have wolfssl in the proper location (should be C:/wolfssl). -2. Open a command prompt. CD into C:\ti\tirtos_tivac_2_00_02_36. -3. Run the make command to build wolfSSL libaries. +Step 1: Download CCS +-- +(If you already have Code Composer Studio (CCS) installed skip to step 2)
+Download CCS here: http://www.ti.com/tool/ccstudio
+
+Installer will walk you through setting up CCS. Choose options for your platform and desired compiler(s).
+
+expected install location: C:\ti
+
+Step 2: Download tivac +-- +(If you already have TIRTOS for TivaC skip to step 3)
+Find CCS App Center it will be an option on the "Getting Started" page or click View -> CCS App Center
+Under the title "Code Composer Studio Add-ons" check the box under "TI-RTOS for TivaC"
+Now on the top of the page click "Install Software"
+
+expected install location: C:\ti
+
+Step 3: Download wolfSSL +-- +Download wolfSSL from here: https://wolfssl.com/wolfSSL/download/downloadForm.php
+or
+clone wolfSSL development branch from here: https://github.com/wolfSSL/wolfssl
+
+expected install location: C:\wolfssl
+
+Step 4: Build the libraries +-- +At this point we are ready to build wolfssl libraries with TIRTOS
+
+WINDOWS:
+ in the file browser navigate to: `C:\ti\ccsv6\tools\compiler` and see which
+ compiler you have installed `ti-cgt-arm_x.x.x` and make a note of it.
+ now in the file browser navigate to `C:\ti\tirtos_tivac_xxxxxxx`
+ open `tirtos.mak` in your preferred text editor
+ locate the line specifying your compiler should be on or around line 11 and
+ will look something like this:
+ `ti.targets.arm.elf.M4F ?= $(DEFAULT_INSTALLATION_DIR)/ccsv6/tools/compiler/ti-cgt-arm_5.2.5`
+ make sure you are using the `ti-cgt-agrm_x.x.x` that you noted previously
+ next locate the wolfSSL section should be on or around line 45 and looks like this:
+ `WolfSSL settings`
+ `WOLFSSL_INSTALLATION_DIR ?= C:\wolfssl`
+ `WOLFSSL_TIRTOS_DIR = $(WOLFSSL_INSTALLATION_DIR)/tirtos
`
+ Modify WOLFSSL_INSTALLATION_DIR to be the location of your wolfssl directory. Should be C:\wolfssl.
+ Open a command promp and navigate to `C:\ti\tirtos_tivac_xxxxxxx`
+ use the following command to build TIRTOS and wolfssl
+ `..\xdctools_3_31_01_33_core\gmake.exe -f tirtos.mak wolfssl`
+
+ The libraries should build without issues.
+
+Step 5: Loading first example +-- + In CCS click dropdown for "Project" and select "Examples..."
+ 
+    Locate: TI-RTOS for TivaC

+              -> Tiva C Series

+                 -> Tiva TM4C1294NCPDT

+                   -> EK-TM4C1294XL Evaluation Kit

+                     -> Network Examples

+                       -> TI Network Examples

+                         -> Ethernet Examples

+                           -> TCP Echo with TLS

+
+ In the "TI Resource Explorer window" Click on the link in "Step 1" to import the project.
+
+Step 6: Setting up the environment +-- + Before building we have to do a little setup.
+ Step 6.a
+ Right click on the imported project and select `Properties`
+ under `Build -> ARM Compiler -> Include Options`
+ You will see a little file with a green "plus" symbol in the browser window
+ (NOTE: include the quotes)
+ Click on that and add this line `"C:/wolfssl"`
+
+ Step 6.b
+ Now still in the Properties window
+ under `Build -> ARM Linker -> File Search Path`
+ In the browser window on the right under "Include library file or command file as input"
+ Click the add button and add this line `"C:\wolfssl\tirtos\packages\ti\net\wolfssl\lib\wolfssl.aem4f"`
+ In the browser window on the right under "Add to library search path"
+ Click the add button and add this line `"C:\wolfssl\tirtos\packages\ti\net\wolfssl\lib"`
+
+ Step 6.c
+ Hit OK and we're ready to build the example project.
+Step 7: Build the project +-- + In the "TI Resource Explorer window" Click on the link in "Step 2" to build the project.
+
+Step 8: Prepare for debugging +-- + (If you have already hooked up your board skip to step 9)
+ Take a Micro-USB cable and plug the micro-USB end into the port on the Tiva Board labeled "DEBUG"
+ (This is the Micro-USB port on the opposite end of the board from the Ethernet port)
+ Insert the USB end into your PC
+ Plug one end of an Ethernet cable into the Tiva board Ethernet port and the other end
+ into your local network.
+
+Step 9: Get Debug Working +-- + In the "TI Resource Explorer window" Click on the link in "Step 3"
+ Click the drop down options and select "Stellaris In-Circuit Debug Interface"
+ In the "TI Resource Explorer window" Click on the link in "Step 4"
+ This should alert you to the need for some additional setup. Click OK and a new tab will open.
+ In the field "Board or Device" type in `Tiva TM4C1294NCPDT` and check the box
+ In the right-hand side of this same window click "save" to save the configuration.
+ Close this tab.
+ In the "TI Resource Explorer window" Click on the link in "Step 4" a second time.
+ The project will be flashed onto the Tiva Board. Wait for a few seconds.
+ Now hit the key "F8" or in the top left of CCS click the green "Play" Button
+ (The buton says "Resume" in the drop down if you scroll over it)
+ You will see output in the "Console" Window at the bottom of CCS.
+ A line will read `Network Added: If-1:192.168.1.xxx` or some other IP
+ This is the IP of the tcpEchoTLS server that is now running on the board in step 9
+ we will refer to this IP as `TCP_ECHO_IP`
+
+Step 10: Test the server +-- + Option 1:
+ To test the server here at wolfSSL we either build the client example in Microsoft Visual Studios
+ and run it against the IP above and using port 1000 (the default port for the tcpEchoTLS example)
+
+ Option 2:
+ Using Linux or Unix build our libraries and run the following command from the wolfssl root
+ directory from any computer running on the local network
+ `./examples/client/client -h TCP_ECHO_IP -p 1000`
+
+ The client should receive the following response:
+ ` + SSL version is TLS1.2
+ SSL cipher suite is
+ Server response: hello wolfssl!
+ `
+
+Step 11: Success +-- + If you received that response your server is working correctly.
+ You are now ready to begin development for your project!
+
+ Contact us anytime with questions:
+ `info@wolfssl.com`
+ `support@wolfssl.com`
+
- ..\xdctools_3_30_01_25_core\gmake.exe -f tirtos.mak wolfssl - -Running wolfSSL wolfCrypt benchmark and test application. --------------------------------------------------------- -1. After running the TCP Echo Server application, in the Debugger View, open Run -> Load Program. Browse to the Benchmark application (C:\wolfssl\tirtos\packages\ti\net\wolfssl\tests\wolfcrypt\benchmark). Select benchmark.xem4f and Click Open and Click OK to load the application. -2. Test by running the application. -3. Repeat the steps 1 and 2 for Test application (C:\wolfssl\tirtos\packages\ti\net\wolfssl\tests\wolfcrypt\test). -4. The example wolfssl_tirtos_benchmark in this repository has all the correct optimization settings and will re-build the relevant c files at compile time for optimal results and additional benchmarks for camellia, rabbit, chacha, poly1305, sha512, and ECC. - -Import a project into your workspace. --------------------------------------------------------- -In CCS go to the Project tab. Click "Import CCS Projects...". -Click "Browse..." and navigate to tirtos_ccs_examples/ file and click "OK". In the "Discovered projects" window you will see all CCS projects. Check the ones you would like to import into the workspace, and check the box at the bottom labled "Copy projects into workspace", now click "Finish". Build and debug the desired projects. + + + +