Commit Graph

155 Commits

Author SHA1 Message Date
zwelch
83902cc984 David Brownell <david-b@pacbell.net>:
Update the "Reset Configuration" information in the User's guide:

 - Convert to @deffn syntax
 - Move tutorial text from command descriptions into new sections
 - Describe several different types of JTAG-visible reset
 - Expand descriptions of configuration tweaks for SRST and TRST 
 - Link to the "reset" command, and vice versa
 - Bugfix the "reset_config" description (it didn't match the code)

Plus, be more proscriptive:  do it in board config files, except for
the oddball cases where that won't work. (Current target.cfg files
seem to have much goofage there; several seem board-specific.)


git-svn-id: svn://svn.berlios.de/openocd/trunk@1913 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-26 00:23:23 +00:00
zwelch
ad8f1b4295 David Brownell <david-b@pacbell.net>:
Doc (mostly) update for jtag_khz:
 - switch to @deffn syntax
 - add entry for "jtag_rclk"
 - move deprecated "jtag_speed" into collection of deprecated calls

And for ft2232, don't be the only adapter to *log* an error if RTCK
is requested; it's already reported properly, like any other nonfatal
command parameter.  "jtag_rclk" just works as expected, without any
scarey messages.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1910 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-24 21:13:29 +00:00
zwelch
5ecae346cc David Brownell <david-b@pacbell.net>:
Make startup for the various server ports be quiet, unless
debugging is active:  don't emit needless scarey messages.
Update the relevant documentation and its references:

 - For these port commands ... cover the default values;
   convert to @deffn syntax; include their use outside of
   the configuration stage; and alphabetize.

Similar updates to the rest of that small chapter:

 - Highlight that there even *IS* a configuration stage, after
   which some command functionality is no longer available.

 - For GDB commands ... convert to @deffn syntax; alphabetize;
   include a missing command (!); add missing helptext (!) for
   one non-missing command; update relevant cross-references
   and index entries.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1909 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-24 21:08:42 +00:00
zwelch
eb385b2e70 David Brownell <david-b@pacbell.net>:
Update two oddball NAND commands to work with {offset, length}
instead of block numbers, matching the other commands as well
as usage in U-Boot and the Linux-MTD utilities.

Document them accordingly.  Update the single in-tree use of
those commands (sheevaplug).

ALSO:

 (a) Document the current 2 GByte/chip ceiling for NAND chipsize.
     (32 bit offset/length values can't represent 4 GBytes.)  Maybe
     after the upcoming release, the code can switch to 64-bits.

 (b) The "nand check_bad_blocks" should report "bad" blocks.  They
     are not "invalid" blocks; they're "bad" ones.

 (c) Tweak the "nand info" command to handle the "no arguments"
     case sanely (show everything, instead of showing garbage) and
     not listing the blocksize in hex kbytes (duh).


git-svn-id: svn://svn.berlios.de/openocd/trunk@1904 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-24 01:57:13 +00:00
zwelch
c0fc8f93f1 David Brownell <david-b@pacbell.net>:
NAND support for DaVinci-family drivers, with HW ECC support.
Declare the NAND chip on the DM355 EVM board.

Currently tested on DM355 for Linux interop using the standard
large page (2KB) chip in the EVM socket; "hwecc1" and "hwecc4"
work fine.  (Using hwecc4 relies on patches that haven't quite
made it through the Linux-MTD bottlenecks yet.)

Not yet tested:  1-bit on small-page (although it's hard to see
how that could fail); 4-bit on small page (picky layout issues);
the "hwecc_infix" mode (primarily for older boot ROMs; testing
there is blocked on having new bootloader code).


git-svn-id: svn://svn.berlios.de/openocd/trunk@1903 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-24 01:38:19 +00:00
zwelch
67dd29a4af Fix two problems with openocd.texi:
- Fix minor issues with xrefs not liking parentheses around them.
- Change 'Building' section to 'Building OpenOCD'.  It reads better.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1902 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-24 01:33:54 +00:00
zwelch
045362d74a Add section identifiers to developer scripting introduction.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1898 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-23 22:53:39 +00:00
zwelch
08d5f114c9 Update main page of doxygen developer documentation:
- Rewrite copy to give a better introduction and overview.
- Add subpages: The List, Style Guide, Patch Policies, and Bug Reporting.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1897 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-23 22:52:47 +00:00
zwelch
3131636492 Add extended doxygen-based style guide draft; requires more work.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1896 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-23 22:39:03 +00:00
zwelch
a0f9869030 Update user guide documentation:
- Remove style guide from user guide; moved to doxygen manual.
- Replace with improved introduction for developers and packagers.
- Move introductory paragraph about the project under the About page.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1895 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-23 22:37:19 +00:00
zwelch
61c77af0ab Submitted by David Brownell <david-b@pacbell.net>:
Add a "NAND Commands" section to to the TEXI docs, covering the basic
commands except for those previously discussed as being due for removal
("nand copy") or switching to use byte offsets not block numbers.

This uses the "@deffn..." syntax for defining commands, as somewhat
suggested by the TEXI documentation, and adds a new "Command Index".
We might prefer to merge those indexes for the near term, but I think
the "@deffn" approch is probably worth switching to.

Updates a few other bits to clarify that "flash" doesn't just mean NOR.  
And to fix one niggling falsity:  the "reset-init" event *is* used, and
in fact it's quite important.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1879 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-22 02:25:18 +00:00
zwelch
8686a33807 Add initial OpenOCD server documentation (Duane Ellis and myself).
git-svn-id: svn://svn.berlios.de/openocd/trunk@1857 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 09:01:01 +00:00
zwelch
5a080c8f6e Add new TCL Primer under the main Technical Primer page.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1856 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 08:58:09 +00:00
zwelch
c46dc5ba2d Move TCL overview from source tree to doxygen manual.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1855 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 08:48:19 +00:00
zwelch
5545aca4d7 Fix doc/Makefile.am dist-hook to include all sections of manual.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1854 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 08:44:37 +00:00
zwelch
ed294121ef Move non-arm target overview from source tree to doxygen manual.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1853 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 08:43:18 +00:00
zwelch
2cca6fcb8b Move scripting overview from source tree to doxygen manual.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1852 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 08:16:50 +00:00
zwelch
5fe786f166 Wookey <wookey@wookware.org>: add user documentation for echo command.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1839 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-19 18:30:01 +00:00
kc8apf
6416474891 Relocate documentation on working area to better align with use of new syntax. Provided by David Brownell <david-b@pacbell.net>
git-svn-id: svn://svn.berlios.de/openocd/trunk@1806 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-18 04:47:06 +00:00
kc8apf
c977616cda Consolidate target selection code into single get_target() that handles both names and numbers. Provided by David Brownell <david-b@pacbell.net>
git-svn-id: svn://svn.berlios.de/openocd/trunk@1804 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-18 04:44:28 +00:00
kc8apf
cafad4969c ETM/ETB documentation from David Brownell <david-b@pacbell.net>
git-svn-id: svn://svn.berlios.de/openocd/trunk@1803 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-18 04:40:11 +00:00
zwelch
8ed887456d Add current draft of The List of Pending and Open Tasks.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1791 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-15 00:49:30 +00:00
zwelch
30f6b1ebbc Several minor fixes for the new doxygen manual.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1789 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-14 22:16:20 +00:00
zwelch
7626139950 Add JTAG Primer to doxygen manual, contributed by Strontium.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1776 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13 11:10:35 +00:00
zwelch
624aa80f84 Commit skeleton files for high-level developer manual using doxygen.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1771 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13 08:58:08 +00:00
oharboe
9b7bd65883 stm32.cfg can expect one of 4 id's.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1516 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-04-23 14:03:42 +00:00
ntfreak
aed582e422 - add openocd coding style to texi
git-svn-id: svn://svn.berlios.de/openocd/trunk@1454 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-04-03 12:55:25 +00:00
oharboe
03caa01ae5 a few words about motivation for standalone JTAG debugger.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1434 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-30 13:35:38 +00:00
ntfreak
d2189fdfe6 - fix typo's in last commit
git-svn-id: svn://svn.berlios.de/openocd/trunk@1433 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-24 12:09:54 +00:00
oharboe
f7f37ea289 Hiroshi Ito <ito@mlb.co.jp> Linux for arm has arm generic debug option which send debug messages via
DCC channel.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1432 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-24 11:27:49 +00:00
oharboe
0cfcd0bc9b Uwe Hermann <uwe@hermann-uwe.de>
- Explicitly mention autoconf >= 2.59 as requirement (as per
  configure.in). Also automake >= 1.9 (though I'm not sure which
  if that's really the minimum requirement).

 - Document various missing configure options.

 - Fix various typos and inconsistencies.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1426 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-23 07:43:46 +00:00
ntfreak
39423e9856 - docs patch from Thomas Kindler
git-svn-id: svn://svn.berlios.de/openocd/trunk@1422 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-20 13:27:02 +00:00
ntfreak
0b26e59b01 - revert texi changes from rev 1418 as it breaks build
- original patch will be reviewed before next commit

git-svn-id: svn://svn.berlios.de/openocd/trunk@1420 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-20 10:29:12 +00:00
oharboe
af6d1db2fb Thomas Kindler <mail+ocd@t-kindler.de> typos
git-svn-id: svn://svn.berlios.de/openocd/trunk@1418 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-19 15:51:28 +00:00
oharboe
9f2a76e7b6 Hiroshi Ito <ito@mlb.co.jp> typos
git-svn-id: svn://svn.berlios.de/openocd/trunk@1417 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-18 11:59:31 +00:00
ntfreak
7f1b58a5cd - fix small typo in texi (section HostOS)
git-svn-id: svn://svn.berlios.de/openocd/trunk@1406 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-09 21:04:33 +00:00
duane
e211e4c6d2 Patch from Dimitar Dimitrov adding support for Olimex ARM-JTAG-EW
git-svn-id: svn://svn.berlios.de/openocd/trunk@1402 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-08 15:14:18 +00:00
duane
7a731eb637 Added HostOS variable
git-svn-id: svn://svn.berlios.de/openocd/trunk@1400 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-03-07 15:19:21 +00:00
oharboe
4d3b6e4163 Holger Schurig <hs4233@mail.mn-solutions.de> incorporate some comments from Rick
git-svn-id: svn://svn.berlios.de/openocd/trunk@1376 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-02-18 09:09:11 +00:00
ntfreak
b298cc07a0 - add --enable-release to docs
git-svn-id: svn://svn.berlios.de/openocd/trunk@1351 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-20 09:08:39 +00:00
kc8apf
93180753be Fix 'make maintainer-clean' courtesy of Zach Welch <zw@superlucidity.net>
git-svn-id: svn://svn.berlios.de/openocd/trunk@1345 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-20 03:55:38 +00:00
kc8apf
8f513f039a Fix support for ADuC702x flash. Courtesy of Michael Ashton <data@gtf.org>
git-svn-id: svn://svn.berlios.de/openocd/trunk@1343 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-20 03:49:31 +00:00
kc8apf
784a519170 Fix to install manpage as part of 'make install' by Uwe Hermann <uwe@hermann-uwe.de>
git-svn-id: svn://svn.berlios.de/openocd/trunk@1335 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-17 23:13:02 +00:00
ntfreak
ebd5afbb0e Updates and fixes for the manpage from Uwe Hermann
- Mention that MIPS systems are supported
- Mention Jim Tcl engine
- Point to info page (not README) for a list of supported stuff
- Document missing --pipe option
- Fix copy-paste error ("flex" should have been "openocd")

git-svn-id: svn://svn.berlios.de/openocd/trunk@1307 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-08 17:23:55 +00:00
ntfreak
fb06f353b1 - a few more docs tweaks
git-svn-id: svn://svn.berlios.de/openocd/trunk@1306 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-08 11:46:55 +00:00
ntfreak
8e88e8f36e - minor doc updates regarding tap creation and gdb connection using pipes
git-svn-id: svn://svn.berlios.de/openocd/trunk@1305 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-07 21:16:06 +00:00
ntfreak
ab87627c5c - add gdb pipe support to native win32 (--pipe option)
git-svn-id: svn://svn.berlios.de/openocd/trunk@1294 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-01-01 16:06:46 +00:00
duane
b18966d0ba Added note to user manual for packagers of OpenOCD
git-svn-id: svn://svn.berlios.de/openocd/trunk@1286 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2008-12-27 21:00:16 +00:00
duane
21eff7095c Added dongle VSLLINK - from Simon Qian
git-svn-id: svn://svn.berlios.de/openocd/trunk@1280 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2008-12-27 02:56:55 +00:00
duane
e03f4f5a9b From Dirk Behme - Further docu fixes
git-svn-id: svn://svn.berlios.de/openocd/trunk@1278 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2008-12-27 02:18:06 +00:00