auracaster/openocd
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc updates to match "help" better

Browse Source 
This makes the documentation a closer match to "help" output:

 - "pathmove" somehow was not documented in the User's Guide

 - "jtag_nsrst_assert_width" and "jtag_ntrst_assert_width"
   are new; both needed descriptions.

 - Removed two undocumented and fairly useless script mechanisms:
    * production/production_info/production_test ... using it,
      requires replacing everything; so having it adds no value.
    * cpu ... way out of date; hopeless to keep that current

Note that anyone using that "production" stuff already defines
their own procedures, and can keep using them with no change.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
This commit is contained in:
David Brownell
2009-10-14 15:18:00 -07:00
parent dd54981702
commit bc792857a5
2 changed files with 40 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
src/helper/startup.tcl
View File

@@ -291,59 +291,10 @@ proc ocd_process_reset_inner { MODE } {
}
}
# stubs for targets scripts that do not have production procedure
proc production_info {} {
return "Imagine an explanation here..."
}
add_help_text production_info "Displays information on production procedure for target script. Implement this procedure in target script."
#########
proc production {firmwarefile serialnumber} {
puts "Imagine production procedure running successfully. Programmed $firmwarefile with serial number $serialnumber"
}
add_help_text production "<serialnumber> - Runs production procedure. Throws exception if procedure failed. Prints progress messages. Implement this procedure in the target script."
proc production_test {} {
puts "Imagine nifty test procedure having run to completion here."
}
add_help_text production_test "Runs test procedure. Throws exception if procedure failed. Prints progress messages. Implement in target script."
add_help_text cpu "<name> - prints out target options and a comment on CPU which matches name"
# A list of names of CPU and options required
set ocd_cpu_list {
{
name IXP42x
options {xscale -variant IXP42x}
comment {IXP42x cpu}
}
{
name arm7
options {arm7tdmi -variant arm7tdmi}
comment {vanilla ARM7}
}
}
# Invoked from Tcl code
proc ocd_cpu {args} {
set name $args
set result ""
global ocd_cpu_list
foreach a [lsort $ocd_cpu_list] {
if {[string length $args]==0||[string first [string toupper $name] [string toupper "$a(name)$a(options)$a(comment)"]]!=-1} {
lappend result $a
}
}
return $result
}
proc cpu {args} {
# 0123456789012345678901234567890123456789012345678901234567890123456789
puts "CPU Options Comment"
foreach a [lsort [ocd_cpu $args]] {
puts [format "%-20s%-40s%s" $a(name) $a(options) $a(comment)]
}
}
# REVISIT power_restore, power_dropout, srst_deasserted, srst_asserted
# are currently neither documented nor supported except on ZY1000.
proc power_restore {} {
puts "Sensed power restore."
@@ -366,6 +317,8 @@ proc srst_asserted {} {
puts "Sensed nSRST asserted."
}
#########
# catch any exceptions, capture output and return output
proc capture_catch {a} {
catch {