git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/ColdFire_MCF52221_CodeWarrior/readme.txt

   1 //------------------------------------------------------------------------\r
   2 //  Readme.txt\r
   3 //------------------------------------------------------------------------\r
   4 This project is configure to get you up and running quickly using \r
   5 CodeWarrior with the Freescale MCF52221 board.\r
   6 \r
   7 This project provides full support for the selected board.\r
   8 The created project provides Standard IO Support through console and terminal window.\r
   9 \r
  10 Sample code for the following language:\r
  11 - C\r
  12 \r
  13 \r
  14 //------------------------------------------------------------------------\r
  15 // Memory Maps\r
  16 //------------------------------------------------------------------------\r
  17 The Hardware has the following memory map:\r
  18 \r
  19 # MCF52221 Derivative Memory map definitions from linker command files:\r
  20 # __IPSBAR, __RAMBAR, __RAMBAR_SIZE, __FLASHBAR, __FLASHBAR_SIZE linker\r
  21 # symbols must be defined in the linker command file.\r
  22 \r
  23 # Memory Mapped Registers (IPSBAR= 0x40000000)\r
  24    ___IPSBAR         = 0x40000000;\r
  25 \r
  26 # 16 Kbytes Internal SRAM\r
  27    ___RAMBAR         = 0x20000000;\r
  28    ___RAMBAR_SIZE    = 0x00004000;\r
  29 \r
  30 # 128 KByte Internal Flash Memory\r
  31    ___FLASHBAR       = 0x00000000;\r
  32    ___FLASHBAR_SIZE  = 0x00020000;\r
  33 \r
  34 \r
  35 \r
  36 //------------------------------------------------------------------------\r
  37 // Project Structure\r
  38 //------------------------------------------------------------------------\r
  39 The project generated contains various files/groups:\r
  40 - readme.txt: information for this project\r
  41 - Sources: application source codes, user customizable startup \r
  42   code, uart library, exception table\r
  43 - Includes: derivative and board header files, ... \r
  44 - Libs: runtime and libs \r
  45 - Project Settings: linker command files for the different build \r
  46   targets, the initialization and memory configuration files for \r
  47   the hardware debugging, the common startup code, etc...\r
  48   \r
  49 //------------------------------------------------------------------------\r
  50 // Build Targets\r
  51 //------------------------------------------------------------------------\r
  52 - CONSOLE_INTERNAL_RAM:\r
  53 This project target is setup to load and debug code from internal RAM.\r
  54 It should be used during your application development.\r
  55 The application outputs to the CodeWarrior's console window.\r
  56 \r
  57 - INTERNAL_RAM:\r
  58 This project target is setup to load and debug code from internal RAM.\r
  59 It should be used during your application development.\r
  60 This is the very basic project that outputs to the UART.\r
  61 You needs to connect a Terminal Program to see the output.\r
  62 \r
  63 - INTERNAL_FLASH:\r
  64 This project target is setup to load and debug code in Internal FLASH.\r
  65 This is the very basic project that outputs to the UART. User needs\r
  66 to connect the terminal to see the output.\r
  67 \r
  68 \r
  69 \r
  70 ===================================================================\r
  71 WARNING regarding debugging new project wizard code with CCS-SIM\r
  72 ===================================================================\r
  73 The CCS-SIM is an instruction set simulator, it does not implement\r
  74 any peripherals.\r
  75 The new project generated by the wizard are using startup code \r
  76 performing some hardware peripheral initializations.\r
  77 When debugging with the CCS-SIM  it might happen that the simulation\r
  78 stuck on loop using non implemented peripheral register flag as \r
  79 condition (PLL initialization as example).  \r
  80 In this case, you should either:\r
  81 - move the PC to next statement\r
  82 - use a skip point\r
  83 - define a simulator specific macro which used when define allos you \r
  84 to comment out the unwanted code in order to debug with CCS-SIM\r
  85  \r
  86 \r
  87 ===================================================================\r
  88 WARNING regarding code located in RAM\r
  89 ===================================================================\r
  90 Many possible ColdFire target processors have an external bus, so \r
  91 you can use large external RAM devices for debugging applications \r
  92 during development. But some processors do not have an external \r
  93 bus, so you must accommodate applications in on-chip memory. \r
  94 Although this on-chip RAM accommodates this CodeWarrior project, \r
  95 it probably is too small for full development of your application. \r
  96 Accordingly, for a processor without external bus, you should locate \r
  97 your applications in flash memory. \r
  98 \r
  99 //------------------------------------------------------------------------\r
 100 //  Flashing the code\r
 101 //------------------------------------------------------------------------\r
 102 1. Select the appropriate project target and build it\r
 103 2. Make sure the correct remote connection is selected in the Remote \r
 104    Connection debugger panel\r
 105 3. In the CodeWarrior IDE menu, select Project > Set Default Project \r
 106    and select your project\r
 107 4. In the CodeWarrior IDE menu, select Project > Set Default Target \r
 108    and select the project target that has the code you want to flash\r
 109 5. In the CodeWarrior IDE menu, select Tools > Flash Programmer\r
 110 6. Go to the flash programmer Target Configuration panel, click Load \r
 111    Settings \r
 112 7. Browse to the <your project location>\cfg sub folder and\r
 113    select the flash settings xml file matching your build target \r
 114 8. Check that Use Custom Settings checkbox is not selected\r
 115 9. Go to the Erase/Blank Check panel, select the All Sectors option and \r
 116    click Erase\r
 117 10. Go to Program/Verify panel, click Program\r
 118 11. Your code should now be flashed\r
 119 \r
 120 //------------------------------------------------------------------------\r
 121 // Terminal Settings\r
 122 //------------------------------------------------------------------------\r
 123 In case the UART is supported, the terminal should be setup with:\r
 124 - 19200 bauds,\r
 125 - 8 data bits,\r
 126 - no parity,\r
 127 - 1 stop bit,\r
 128 - no flow control.\r
 129 \r
 130 Please check this file in the project.\r
 131 \r
 132 //------------------------------------------------------------------------\r
 133 //  Getting Started\r
 134 //------------------------------------------------------------------------\r
 135 To build/debug your project, use the CodeWarrior IDE menu Project > Debug \r
 136 or press F5. This will launch the debugger. Press again F5 in the \r
 137 debugger (or the CodeWarrior IDE menu Project > Run) to start the \r
 138 application. The CodeWarrior IDE menu Project > Break stops the \r
 139 application.\r
 140 \r
 141 //------------------------------------------------------------------------\r
 142 //  Adding your own code\r
 143 //------------------------------------------------------------------------\r
 144 Once everything is working as expected, you can begin adding your own code\r
 145 to the project. Keep in mind that we provide this as an example of how to\r
 146 get up and running quickly with CodeWarrior. There are certainly other\r
 147 ways to handle interrupts and set up your linker command file. Feel free\r
 148 to modify any of the source files provided.\r
 149 \r
 150 //------------------------------------------------------------------------\r
 151 //  Additional documentation\r
 152 //------------------------------------------------------------------------\r
 153 Read the online documentation provided. In CodeWarrior IDE menu, select\r
 154 Help > CodeWarrior Help.\r
 155 \r
 156 //------------------------------------------------------------------------\r
 157 //  Contacting Freescale\r
 158 //------------------------------------------------------------------------\r
 159 For bug reports, technical questions, and suggestions, please use the\r
 160 forms installed in the Release_Notes folder.\r