ReadMe.txt 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. /*****************************************************************************
  2. * @file ReadMe.txt
  3. * @brief Explanation how to use the Device folder and template files
  4. * @version V3.0.3
  5. * @date 10. January 2018
  6. *****************************************************************************/
  7. Following directory structure and template files are given:
  8. - <Vendor>
  9. |
  10. +-- <Device>
  11. |
  12. +-- Include
  13. | +- <Device>.h header file
  14. | +- system_Device.h system include file
  15. +-- Source
  16. |
  17. +- system_<Device>.c system source file
  18. |
  19. +-- ARM Arm RVCT toolchain
  20. | +- startup_<Device>.s ASM startup file for ARMCC
  21. |
  22. +-- GCC Arm GNU toolchain
  23. |
  24. +-- IAR IAR toolchain
  25. Copy the complete folder including files and replace:
  26. - folder name 'Vendor' with the abbreviation for the device vendor e.g.: NXP.
  27. - folder name 'Device' with your specific device name e.g.: LPC17xx.
  28. - in the filenames 'Device' with your specific device name e.g.: LPC17xx.
  29. The template files contain comments starting with 'ToDo: '
  30. There it is described what you need to do.
  31. The template files contain following placeholder:
  32. <Device>
  33. <Device> should be replaced with your specific device name.
  34. e.g.: LPC17xx
  35. <DeviceInterrupt>
  36. <DeviceInterrupt> should be replaced with a specific device interrupt name.
  37. e.g.: TIM1 for Timer#1 interrupt.
  38. <DeviceAbbreviation>
  39. <DeviceAbbreviation> should be replaced with a dedicated device family
  40. abbreviation (e.g.: LPC for LPC17xx device family)
  41. Cortex-M#
  42. Cortex-M# can be replaced with the specific Cortex-M number
  43. e.g.: Cortex-M3
  44. Note:
  45. Template files (i.e. startup_Device.s, system_Device.c) are application
  46. specific and therefore expected to be copied into the application project
  47. folder prior to use!