README 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. WolfSSL MPLAB X Project Files
  2. This directory contains project files for the Microchip MPLAB X IDE. These
  3. projects have been set up to use the Microchip PIC32 Ethernet Starter Kit
  4. and the Microchip XC32 compiler, and have been created specifically to test
  5. the Microchip-specific WolfCrypt API with compression support. For MPLAB X
  6. projects that don't use compression and are generic to the WolfCrypt API,
  7. please see the <wolfssl_root>/mplabx directory.
  8. In order to generate the necessary auto-generated MPLAB X files, make sure
  9. to import the cyassl.X and zlib.X projects into your MPLAB X workspace before
  10. trying to build either the WolfCrypt test or benchmark applications. This will
  11. correctly set up the respective project's Makefiles.
  12. Included Project Files
  13. -----------------------
  14. 1. wolfSSL library (wolfssl.X)
  15. This project builds a static wolfSSL library. Prior to building this
  16. project, uncomment the MICROCHIP_PIC32 define located in:
  17. <wolfssl_root>/wolfssl/wolfcrypt/settings.h
  18. After this project has been built, the compiled library will be located
  19. at:
  20. <wolfssl_root>/mplabx/wolfssl.X/dist/default/production/wolfssl.X.a
  21. Note that this project includes the zlib header location in the project's
  22. include paths. This is because this project has been set up to be compiled
  23. with zlib support to enable compression and decompression features.
  24. 2. wolfCrypt Test App (wolfcrypt_test.X)
  25. This project tests the wolfCrypt cryptography modules. It is generally
  26. a good idea to run this first on an embedded system after compiling
  27. wolfSSL in order to verify all underlying crypto is working correctly.
  28. 3. wolfCrypt Benchmark App (wolfcrypt_benchmark.X)
  29. This project builds the wolfCrypt benchmark application. If the wolfSSL
  30. project (wolfssl.X) has been compiled with libz support and is being
  31. used to build this project, the zlib.X project will need to added to
  32. the "Libraries" folder under the wolfcrypt_benchmark.X project before
  33. it will compile successfully.
  34. 4. wolfCrypt MCAPI Test App (wolfcrypt_mcapi.X)
  35. This project tests the Microchip crytpo API layer. The Microchip crypto
  36. layer is located under the <wolfssl_root>/mcapi directory.
  37. 5. zlib library (zlib.X)
  38. This project builds the zlib library for use in the wolfcrypt_test.X
  39. and wolfcrypt_mcapi.X projects. This project expects the zlib sources
  40. to be located under the wolfSSL root directory. Currently it is set up
  41. to work with zlib 1.2.8, and looks for sources under:
  42. <wolfssl_root>/zlib-1.2.8
  43. PIC32MX/PIC32MZ
  44. ---------------
  45. The projects are set for PIC32MX by default. For PIC32MZ, change project
  46. properties->Devices and add "WOLFSSL_MICROCHIP_PIC32M" to
  47. XC32-gcc->Preprocessing and messages-> Preprocessor macros.
  48. MIPS16 and MIPS32 Support
  49. -------------------------
  50. These projects support both MIPS16 and MIPS32 instruction sets. Switching
  51. between these two instruction sets can be done in each project's properties
  52. settings by checking the "Generate 16-bit code" checkbox.
  53. Support
  54. -------
  55. Please send questions or comments to support@wolfssl.com