aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2009-12-07ARM: list number of HW breakpoints/watchpointsDavid Brownell
When starting up, say how many hardware breakpoints and watchpoints are available on various targets. This makes it easier to tell GDB how many of those resources exist. Its remote protocol currently has no way to ask OpenOCD for that information, so it must configured by hand (or not at all). Update the docs to mention this; remove obsolete "don't do this" info. Presentation of GDB setup information is still a mess, but at least it calls out the three components that need setup. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-12-07User's Guide: add quickie setup notesDavid Brownell
Add a brief "setup with no customization" note showing the how easily things can work if standard OpenOCD config scripts already exist. We've had some new users comment that this information is needlessly hard to find, so that starting to use OpenOCD is more difficult than it should be. Plus describe a few other issues that come up when setting up an OpenOCD server. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-12-07User's Guide: mention ETM on ARM11 comes up tooDavid Brownell
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-12-06add 'flash list', rewrite 'flash banks'Zachary T Welch
Rename the existing 'flash banks' implementation as 'flash list', and replace the broken 'flash_banks' TCL wrapper with a new command handler. Adds documentation for the new 'flash list' command in the user guide.
2009-12-04User's Guide: more semihosting infoDavid Brownell
List it in the concept index, in the section about target software changes a project might want to consider, and in the section about debug messaging. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-12-03basic ARM semihosting supportNicolas Pitre
Semihosting enables code running on an ARM target to use the I/O facilities on the host computer. The target application must be linked against a library that forwards operation requests by using the SVC instruction that is trapped at the Supervisor Call vector by the debugger. The "hosted" library version provided with CodeSourcery's Sourcery G++ Lite for ARM EABI is one example. This is currently available for ARM9 processors, but any ARM variant should be able to support this with little additional work. Tested using binaries compiled with Sourcery G++ Lite 2009q1-161 and ARM RVCT 3.0. [dbrownell@users.sourceforge.net: doc tweaks, NEWS] Signed-off-by: Nicolas Pitre <nico@marvell.com> Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-12-01Tcl and doc: update to match new 'arm mcr ...' etcDavid Brownell
Make them match the C code. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-29XScale: initial PXA3xx supportMarek Vasut
[dbrownell@users.sourceforge.net: user's guide; variant param is optional] Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-27target: groundwork for "reset-assert" eventDavid Brownell
This defines a "reset-assert" event and a supporting utility routine, and documents both how targets should implement it and how config scripts should use it. Core-specific updates are needed to make this work. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-26update bug reporting informationUwe Hermann
The Berlios bug-tracker is disabled, bug reports go to the list. Signed-off-by: Zachary T Welch <zw@superlucidity.net>
2009-11-26styleguide: add some embedded style rules.Øyvind Harboe
Embedded and pthreads rely on modest and predictable stack usage. Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2009-11-25update command handler documentationZachary T Welch
Adds sections on command registration and chaining, giving an overview to developers that want to use these features.
2009-11-24support for scripts in $HOME/.openocdAndreas Fritiofson
Add $HOME/.openocd as the first default script search directory, allowing the user to override the standard scripts. Update the user guide with information on where OpenOCD expects to find configuration files and scripts. Also fixed some minor formatting issues. Add entry to NEWS as well. Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2009-11-23arm926ejs: retire cp15 commands, handled by mrc/mcr.Øyvind Harboe
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2009-11-20ARM7/ARM9: remove old "debug commands"David Brownell
Remove two commands that were documented as "debug commands" and where "you probably don't want to use this". We never intended to support them, and at least one problem report boiled down to using this when it shouldn't have been used. Update the docs on the existing register commands to talk a bit more about register access and cache behavior. (Those debug commands existed largely to *bypass* the cache.) And fix some minor doc goofs that snuck in with recent changes, renaming "armv4_5" as "arm" and "arm9tdmi" as "arm9". Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-19document new flash syntaxZachary T Welch
Updates the user documentation with the new syntax for defining flash and nand banks.
2009-11-17update command_handler documentationZachary T Welch
Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-16ARMv7A: use standard disassemblerDavid Brownell
We no longer need v7A-specific code for this. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-16ARM: "armv4_5" command prefix becomes "arm"David Brownell
Rename the "armv4_5" command prefix to straight "arm" so it makes more sense for newer cores. Add a simple compatibility script. Make sure all the commands give the same "not an ARM" diagnostic message (and fail properly) when called against non-ARM targets. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-16Add 'nand verify' commandZachary T Welch
Add the 'nand verify' command to perform a dump and fake-write simultaneously, checking the read bits against those generated by the write process. Appropriate user documentation for this command has been added to the user guide as well. The algorithm presently makes a relatively naive comparison. Some chips that use ECC may not verify correctly using this implementation, but the new documentation provides details about this limitation.
2009-11-13update developer manual for new typesZachary T Welch
Update the style guide and chase obvious references to structures that have been renamed.
2009-11-13add documention for writing built-in commandsZachary T Welch
This documentation update provides an introduction to the command handling facilities provided by command.[ch]. A primer walks the user through the elements of a pointedly pedantic module: src/hello.c. A summary of the API is provided in the OpenOCD Architecture section.
2009-11-12ETM: start support for ETMv2+David Brownell
ARM11 and newer cores include updated ETM modules. Recognize their version codes and some key config differences. Sanity checked on an OMAP2, with an ETM11RV r0p1 (ETMv3.1). This still handles only scan chain 6, with at most 128 registers. Newer cores (mostly, Cortex) will need to use the DAP instead. Note that the newer ETM modules don't quite fit the quirky config model of the older ones ... having more port widths is easy, but the modes aren't the same. That still needs to change. Fix a curious bug ... how did the register cache NOT get saved?? Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-12parport: add support for the jtag_khz command.Jonas Horberg
Add the khz and speed_div functions to the parport interface driver. Add the parport_toggling_time function that tells the parport driver how long (in nanoseconds) it takes for the hardware to toggle TCK. [dbrownell@users.sourceforge.net: tweak doc for clarity, mention multimeter, and whitespace fixes] Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-10target: MMU-aware init for memory read/writeDavid Brownell
Start switching MMU handling over to a more sensible scheme. Having an mmu() method enables MMU-aware behaviors. Not having one kicks in simpler ones, with no distinction between virtual and physical addresses. Currently only a handful of targets have methods to read/write physical memory: just arm720, arm920, and arm926. They should all initialize OK now, but the arm*20 parts don't do the "extra" stuff arm926 does (which should arguably be target-generic). Also simplify how target_init() loops over all targets by making it be a normal "for" loop, instead of scattering its three parts to the four winds. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-10ARM11: remove old mrc/mcr commandsØyvind Harboe
Switch to new commands in config scripts Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2009-11-09finish removing deprecated/obsolete commandsDavid Brownell
It's been about a year since these were deprecated and, in most cases, removed. There's no point in carrying that documentation, or backwards compatibility for "jtag_device" and "jtag_speed", around forever. (Or a few remnants of obsolete code...) Removed a few obsolete uses of "jtag_speed": - The Calao stuff hasn't worked since July 2008. (Those Atmel targets need to work with a 32KHz core clock after reset until board-specific init-reset code sets up the PLL and enables a faster JTAg clock.) - Parport speed controls don't actually work (tops out at about 1 MHz on typical HW). - In general, speed controls need to live in board.cfg files (or sometimes target.cfg files), not interface.cfg ... Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-09User's Guide: Flash/NAND doc tweaksDavid Brownell
Rename the "Drivers, Options, and Commands" sections to be just "Driver List" matching the earlier reference. Add an example of parallel CFI flash. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-09User's Guide: bugfix global state infoDavid Brownell
The "$ocd_HOSTOS" variable was wrongly documented. Fix its documentation, and its value on Linux. Shrink a few of the too-long lines. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-08target.cfg: remove "-work-area-virt 0"David Brownell
The semantics of "-work-area-virt 0" (or phys) changed with the patch to require specifying physical or virtrual work area addresses. Specifying zero was previously a NOP. Now it means that address zero is valid. This patch addresses three related issues: - MMU-less processors should never specify work-area-virt; remove those specifications. Such processors include ARM7TDMI, Cortex-M3, and ARM966. - MMU-equipped processors *can* specify work-area-virt... but zero won't be appropriate, except in mischievous contexts (which hide null pointer exceptions). Remove those specs from those processors too. If any of those mappings is valid, someone will need to submit a patch adding it ... along with a comment saying what OS provides the mapping, and in which context. Example, say "works with Linux 2.6.30+, in kernel mode". (Note that ARM Linux doesn't map kernel memory to zero ...) - Clarify docs on that "-virt" and other work area stuff. Seems to me work-area-virt is quite problematic; not every operating system provides such static mappings; if they do, they're not in every MMU context... Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-05User's Guide: TAP setup tweakageDavid Brownell
Highlight that the "-expected-id" probably comes from vendor documentation, and that it *should* be used where possible. Don't use ircapture/irmask in examples, to help discourage use of those params when they're not required. Explain a bit better about why/when those params get used. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-04Release docs: fix notesDavid Brownell
We currently do something unusual: version codes in config.in get updated after the release, which means that "git describe" won't match up to development version labels. Comment that trouble spot. We can fix this by switching away from the major/minor/micro type release numbering, as various other projects have done. The major numbers basically don't tend to change, and doing a good job with micro versions is so annoying that they rarely change either.
2009-11-04Doc: fix broken linkDavid Brownell
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-04Other files: stop referring to ChangeLog tooDavid Brownell
The ChangeLog idiom is redundant given any decent SCM. Time to phase it out here. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-04Tweak release docsDavid Brownell
Contrast releases to git snapshot tarballs. Mention that releases have some quality-improvement focus, with special non-"dev" version IDs. Explain more about version IDs, using "openocd -v" to see them, etc; Make release milestone info be less specific about timing, and presume we have both a merge window and an RC stage. Rework the release process information to match reality a bit more closely. Reference the version.sh script (in one place the wrong script was referenced). Bugfix branches get special treatment, while non-bugfix releases are more or less what *defines* being the mainline branch. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-01User's Guide: more init info, autoprobing, etcDavid Brownell
Mention the autoprobing as a tool that may be useful when figuring out how to set up; and add a section showing how to use that mechanism (with an example). Strengthen the differences between config and run stage descriptions; add a section for the latter. Mention Dragonite. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-10-27Rewrite release script to use GIT.Zachary T Welch
Update documentation to reflect GIT methodology. Rewrite release.sh script to use appropriate process. With this update, tools/release.sh can be used for producing private release tags on local branches. The documentation still needs work, but their use for v0.3.x should help rectify the deficiences.
2009-10-25ARM: rename "arm9tdmi vector_catch" to "arm9 ..."David Brownell
And update doc accordingly. That EmbeddedICE register was introduced for ARM9TDMI and then carried forward into most new chips that use EmbeddedICE.
2009-10-23arm9tdmi vector_catch: reserved means "don't use"David Brownell
Bit 5 shouldn't be used. Remove all support for modifying it. Matches the exception vector table, of course ... more than one bootloader uses that non-vector to help distinguish valid boot images from random garbage in flash.
2009-10-22ETM: rename registers, doc tweaksDavid Brownell
The register names are perversely not documented as zero-indexed, so rename them to match that convention. Also switch to lowercase suffixes and infix numbering, matching ETB and EmbeddedICE usage. Update docs to be a bit more accurate, especially regarding what the "trigger" event can cause; and to split the issues into a few more paragraphs, for clarity. Make "configure" helptext point out that "oocd_trace" is prototype hardware, not anything "real". Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-10-21mww_phys retired. Replaced by generic mww phys in target.cØyvind Harboe
2009-10-21virt2phys is now implemented by target.c globally, retire target specific ↵Øyvind Harboe
documentation.
2009-10-21Added target_read/write_phys_memory() fn's. mdX/mwX commands updated to ↵Øyvind Harboe
support phys flag to specify bypassing of MMU.
2009-10-20XSVF: use svf_add_statemove()David Brownell
XSVF improvements: - Layer parts of XSVF directly over SVF, calling svf_add_statemove() instead of expecting jtag_add_statemove() to conform to the SVF/XSVF requirements (which it doesn't). This should improve XSTATE handling a lot; it removes most users of jtag_add_statemove(), and the comments about how it should really do what svf_add_statemove() does. - Update XSTATE logic to be a closer match to the XSVF spec. The main open issue here is (still) that this implementation doesn't know how to build and submit paths from single-state transitions ... but now it will report that error case. - Update the User's Guide to mention the two utility scripts for working with XSVF, and to mention the five extension opcodes. Handling of state transition paths is, overall, still a mess. I think they should all be specified as paths not unlike SVF uses, and compiled to the bitstrings later ... so that we can actually make sense of the paths. (And see the extra clocks, detours through RUN, etc.) Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-10-20Added 'unlock' option to flash write_imageØyvind Harboe
2009-10-19Doc: jtag_init must validate scan chain tooDavid Brownell
Same requirement as like init_reset, and for the same reason: we need to start with a known and working state.
2009-10-14doc updates to match "help" betterDavid Brownell
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>
2009-10-13Retired gdb_attach. gdb-detach event covers this functionality.Øyvind Harboe
2009-10-12arm11 burst writes are now only enabled for writes larger than 1 word. ↵Øyvind Harboe
Single word writes are frequently used from reset init scripts to non-memory peripherals.
2009-10-12Retire arm11 no_increment. Intended for future expansion to read/write to ↵Øyvind Harboe
ports. New arm11 commands would have to be added to exploit it.