rpp/loadti/readme.txt

   1 ******************************************************************************
   2 DSS Generic Loader (loadti)
   3 readme.txt
   4 ******************************************************************************
   5
   6
   7 DESCRIPTION
   8 ===========
   9
  10 Command line loader for TI Targets. Leverages Debug Server Scripting and thus
  11 works with any TI target, hardware, or simulator supported by the base Debug
  12 Server.
  13
  14
  15 INSTRUCTIONS
  16 ============
  17
  18 Run loadti batch file (WINDOWS) or shell script (LINUX):
  19
  20   Usage: loadti [OPTION]... [OUT_FILE1[+OUT_FILE2]...] [ARGUMENT]...
  21   Load OUT_FILE executable(s) to TI target and run, passing ARGUMENT(s) to main.
  22
  23   Available options:
  24
  25   -a,   --async-run             Run the specified executable and return without halting
  26
  27   -c,   --cfg-file=CONFIG_FILE
  28                                                 Target setup config file
  29
  30   -h,   --help                  Print help
  31
  32   -l,   --load                  Load program only
  33
  34   -r,   --reset                 Reset target before run
  35
  36   -s,   --stdout-file=FILE
  37                                                 Save C I/O to specified file
  38
  39   Debug Server configuration is done using the '-c' option The '-c' option
  40   takes a target setup configuration file as the parameter. These files have a
  41   *.ccxml extension and by default reside in
  42   '<Install Dir>/common/targetdb/configurations'.
  43
  44   Examples:
  45
  46   Windows: loadti -c=..\..\..\..\common\targetdb\configurations\tisim_dm6446le.ccxml ..\C64\shapes\Debug\shapes.out
  47   Linux:   loadti.sh -c=../../../../common/targetdb/configurations/tisim_c64xple.ccxml ../C64/shapes/Debug/shapes.out
  48
  49   Run 'loadti --help' for the latest list and definition of all available
  50   options.
  51
  52   Aborting loadti execution:
  53
  54   Pressing CTRL-C during script execution will prematurely quit execution of
  55   loadti. When CTRL-C is pressed when the application is running on the target
  56   ("Interrupt to abort . . ."), loadti will abort and if running on a
  57   simulator, the simulator will be shutdown with the rest of the Debug Server.
  58   When running on a HW target, loadti will terminate but the target will be
  59   left continuing execution.
  60
  61   Multiple runs:
  62
  63   Multiple runs of loadti can be done from a batch or bash file that calls
  64   loadti. On Windows, since loadti is also a batch file, make sure calls are
  65   done using the 'CALL' command. On Linux, calls to loadti can be made
  66   directly:
  67
  68   Windows (Example batch file):
  69   ------------------------------------------------------------------------------
  70   CALL loadti -c dm6446_sim_custom.ccxml myapp1.out
  71   CALL loadti -c C:\TI\CCSv4\common\targetdb\configurations\tisim_c64xpbe.ccxml myapp3.out
  72   CALL loadti -c C:\TI\CCSv4\common\targetdb\configurations\tisim_c55xp_ca.ccxml myapp2.out arg1 arg2
  73   ------------------------------------------------------------------------------
  74
  75   Linux (Example shell script):
  76   ------------------------------------------------------------------------------
  77   loadti.sh -c dm6446_sim_custom.ccxml myapp1.out
  78   loadti.sh -c /opt/ti/ccs4/common/targetdb/configurations/tisim_c64xpbe.ccxml myapp3.out
  79   loadti.sh -c /opt/ti/ccs4/common/targetdb/configurations/tisim_c55xp_ca.ccxml myapp2.out arg1 arg2
  80   ------------------------------------------------------------------------------
  81
  82
  83 FILES
  84 =====
  85
  86 - loadti.bat
  87   Windows batch file that executes loadti.
  88
  89 - loadti.sh
  90   Linux shell script that executes loadti.
  91
  92 - main.js
  93   Main JavaScript.
  94   This is a modified version inspired by the one provided by Ti in <CCS_ROOT>/ccs_base/scripting/examples/loadti.
  95   It has reduced features and some improvements to fit our needs. The main feature is that the loaded program
  96   starts running right after it is loaded, only necessary sectors of the FLASH memory are erased.
  97
  98 - dsSetup.js
  99   JavaScript used to configure the Debug Server.
 100
 101 - getArgs.js
 102   JavaScript used for parsing command-line arguments.
 103   This is a modified version inspired by the one provided by Ti in <CCS_ROOT>/ccs_base/scripting/examples/loadti.
 104   It reflects reduced feature set by reducing accepted parameters.
 105
 106 - readme.txt
 107   This text file.
 108
 109
 110 KNOWN ISSUES
 111 ============
 112
 113 - Known issue of an internal status message sent to console (CQ #22136)
 114
 115 - Known issue where passing in an absolute path + file name for the xml log
 116   (via -x option) will cause an error if the file name does not exist. There
 117   is no issue with relative paths (CQ #21557).
 118
 119 - Linux: Known issue where the cycle count is incorrect for some simulators
 120   (C55x+) (CQ #24284).
 121
 122 - Linux: Known issue where the C55x+ and C64x+ simulators are slowed down by
 123   the profile clock (CQ #24277). Workaround is to use option '-n' to disable
 124   application profiling.
 125
 126 - Known issue where DSS is unable to create a xml log file (-x option) in a
 127   location where the folder does not exist.
 128
 129 - On certain HW targets, the following error message may appear:
 130
 131   "SEVERE: TMS320C6400_0: Error enabling a profile counter: Profiling not
 132   supported with existing configuration.  Check that Advanced Event Triggering
 133   components are enabled. Sequence ID: 0 Error Code: 0 Error Class: 0x00000000"
 134
 135   This error occurs when attempting to profile on targets with cTools (AET).
 136
 137 - For applications where there is an .args section of greater than size zero,
 138   argc/argv will be passed to main only if there are arguments passed to loadti
 139   for main.
 140
 141   Ex #1 (no argument): loadti app.out
 142
 143   argc=0
 144   argv[0]=null
 145
 146   Ex #2 (1 argument): loadti app.out arg1
 147
 148   argc=2
 149   argv[0]=app.out
 150   argv[1]=arg1
 151
 152 - On some Windows environments it may be necessary to call batch scripts
 153   (loadti.bat) with full filename extension.