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

   1 //------------------------------------------------------------------------\r
   2 //  Readme.txt\r
   3 //------------------------------------------------------------------------\r
   4 This project stationery is designed to get you up and running\r
   5 quickly with CodeWarrior for MC9S12C32.\r
   6 It is set up for the selected CPU and target connection,\r
   7 but can be easily modified.\r
   8 \r
   9 Sample code for the following language(s) is at your disposal:\r
  10 - C\r
  11 \r
  12 The wizard has prepared CodeWarrior target(s) with the connection methods of\r
  13 your choice:\r
  14 - Simulator:\r
  15   This interface/target is prepared to use the FCS (Full Chip Simulation).\r
  16 \r
  17 - SofTec:\r
  18   This target interface connects to any of the USB-based SofTec Microsystems tools for HC(S)12.\r
  19   \r
  20 \r
  21 Additional connections can be chosen in the simulator/debugger,\r
  22 use the menu Component > Set Target.\r
  23 \r
  24 //------------------------------------------------------------------------\r
  25 //  Processor Expert\r
  26 //------------------------------------------------------------------------\r
  27 This project is prepared to be designed with Processor Expert.\r
  28 The project has an additional 'tab' named 'Processor Expert' where you\r
  29 can configure the CPU and its beans.\r
  30 The CPU selected is inserted into the Processor Expert project panel, in\r
  31 the Debug and Release configurations.\r
  32 Change of the configuration is possible by the mouse double-click on it.\r
  33 All the installed Embedded Beans are accessible in the Bean Selector\r
  34 window, grouped into folders according to their function. The mouse\r
  35 double-click on selected Embedded Bean in the Bean Selector window adds\r
  36 the Bean to the project. The mouse double-click on the Bean icon in the\r
  37 Project panel opens the Bean Inspector window, which is used to set the\r
  38 Bean properties. Source code is generated after selecting the\r
  39 (Code Design 'Project_name.mcp') menu command from the CodeWarrior main\r
  40 window (Processor Expert > Code design 'Project_name.mcp').\r
  41 Use the bean methods and events to write your code in the main module\r
  42 'Project_name'.c and the event module Events.c.\r
  43 \r
  44 For more help please read Processor Expert help:\r
  45  (Processor Expert > Help > 'Topic').\r
  46 \r
  47 The following folders are used in CodeWarrior project window for\r
  48 ProcessorExpert:\r
  49 - User modules: contains your sources. The main module 'Project_name'.c\r
  50   and event module Events.c are located here after the Processor Expert\r
  51   code generation.\r
  52 - Prm: Linker parameter file used for linking. Note that the file used\r
  53   for the linker is specified in the Linker Preference Panel. To open\r
  54   the Preference Panel, please press <ALT-F7> or open the\r
  55   (Edit > 'Current Build Target Name' Settings...) menu item in the\r
  56   CodeWarrior main window menu, while the project window is opened).\r
  57   After Processor Expert code generation 'Project_name'.prm file\r
  58   will be placed here. You can switch off the .prm file generation in\r
  59   Processor Expert if you want (in the CPU bean, Build Options)\r
  60 - Generated code: this folder appears after the Processor Expert code\r
  61   generation and contains generated code from Processor Expert.\r
  62 - Doc: other files generated from the Processor Expert (documentation)\r
  63 \r
  64 //------------------------------------------------------------------------\r
  65 //  Getting Started\r
  66 //------------------------------------------------------------------------\r
  67 To build/debug your project, use the menu Project > Debug or press F5.\r
  68 This will open the simulator/debugger.\r
  69 Press again F5 in the debugger (or menu Run > Start/Continue) to start\r
  70 the application. The menu Run > Halt or F6 stops the application.\r
  71 In the debugger menu Component > Open you can load additional components.\r
  72 \r
  73 //------------------------------------------------------------------------\r
  74 // Project structure\r
  75 //------------------------------------------------------------------------\r
  76 The project generated contains various files/folders:\r
  77 - readme.txt: this file\r
  78 - Sources: folder with the application source code\r
  79 - Startup Code: C/C++ startup code\r
  80 - Prm:\r
  81    - burner.bbl file to generate S-Records\r
  82 - Linker Map: the .map file generated by the linker\r
  83 - Libraries: needed library files (ANSI, derivative header/implementation files)\r
  84 - Debugger Project File: contains a .ini file for the debugger for each\r
  85   connection\r
  86 - Debugger Cmd Files: contains sub-folders for each connection with command\r
  87   files\r
  88 \r
  89 //------------------------------------------------------------------------\r
  90 //  Adding your own code\r
  91 //------------------------------------------------------------------------\r
  92 Once everything is working as expected, you can begin adding your own code\r
  93 to the project. Keep in mind that we provide this as an example of how to\r
  94 get up and running quickly with CodeWarrior. There are certainly other\r
  95 ways to handle interrupts and set up your linker command file. Feel free\r
  96 to modify any of the source files provided.\r
  97 \r
  98 //------------------------------------------------------------------------\r
  99 //  Simulator/Debugger: Additional components\r
 100 //------------------------------------------------------------------------\r
 101 In the simulator/debugger, you can load additional components. Try the menu\r
 102 Component > Open.\r
 103 \r
 104 //------------------------------------------------------------------------\r
 105 //  Additional documentation\r
 106 //------------------------------------------------------------------------\r
 107 Check out the online documentation provided. Use in CodeWarrior IDE the\r
 108 menu Help > Online Manuals.\r
 109 \r
 110 //------------------------------------------------------------------------\r
 111 //  Contacting Metrowerks\r
 112 //------------------------------------------------------------------------\r
 113 For bug reports, technical questions, and suggestions, please use the\r
 114 forms installed in the Release_Notes folder and send them to:\r
 115 USA:          support@metrowerks.com\r
 116 EUROPE:       support_europe@metrowerks.com\r
 117 ASIA/PACIFIC: j-emb-sup@metrowerks.com