lpc3180_nand_controller_t -> struct lpc3180_nand_controller

Remove misleading typedef and redundant suffix from struct lpc3180_nand_controller.

lpc2900_flash_bank_t -> struct lpc2900_flash_bank

Remove misleading typedef and redundant suffix from struct lpc2900_flash_bank.

lpc288x_flash_bank_t -> struct lpc288x_flash_bank

Remove misleading typedef and redundant suffix from struct lpc288x_flash_bank.

lpc2000_flash_bank_t -> struct lpc2000_flash_bank

Remove misleading typedef and redundant suffix from struct lpc2000_flash_bank.

flash_driver_t -> struct flash_driver

Remove misleading typedef and redundant suffix from struct flash_driver.

flash_sector_t -> struct flash_sector

Remove misleading typedef and redundant suffix from struct flash_sector.

faux_flash_bank_t -> struct faux_flash_bank

Remove misleading typedef and redundant suffix from struct faux_flash_bank.

ecosflash_flash_bank_t -> struct ecosflash_flash_bank

Remove misleading typedef and redundant suffix from struct ecosflash_flash_bank.

cfi_fixup_t -> struct cfi_fixup

Remove misleading typedef and redundant suffix from struct cfi_fixup.

cfi_unlock_addresses_t -> struct cfi_unlock_addresses

Remove misleading typedef and redundant suffix from struct cfi_unlock_addresses.

cfi_spansion_pri_ext_t -> struct cfi_spansion_pri_ext

Remove misleading typedef and redundant suffix from struct cfi_spansion_pri_ext.

cfi_atmel_pri_ext_t -> struct cfi_atmel_pri_ext

Remove misleading typedef and redundant suffix from struct cfi_atmel_pri_ext.

cfi_intel_pri_ext_t -> struct cfi_intel_pri_ext

Remove misleading typedef and redundant suffix from struct cfi_intel_pri_ext.

cfi_flash_bank_t -> struct cfi_flash_bank

Remove misleading typedef and redundant suffix from struct cfi_flash_bank.

avrf_flash_bank_t -> struct avrf_flash_bank

Remove misleading typedef and redundant suffix from struct avrf_flash_bank.

avrf_type_t -> struct avrf_type

Remove misleading typedef and redundant suffix from struct avrf_type.

at91sam7_flash_bank_t -> struct at91sam7_flash_bank

Remove misleading typedef and redundant suffix from struct at91sam7_flash_bank.

jtag_command_t -> struct jtag_command

Remove useless typedef from struct jtag_command.

jtag_command_container_t -> union jtag_command_container

Remove misleading typedef from union jtag_container.

sleep_command_t -> struct sleep_command

Remove misleading typedef from struct sleep_command.

end_state_command_t -> struct end_state_command

Remove misleading typedef from struct end_state_command.

reset_command_t -> struct reset_command

Remove misleading typedef from struct reset_command.

stableclocks_command_t -> struct stableclocks_command

Remove misleading typedef from struct stableclocks_command.

runtest_command_t -> struct runtest_command

Remove misleading typedef from struct runtest_command.

pathmove_command_t -> struct pathmove_command

Remove misleading typedef from struct pathmove_command.

statemove_command_t -> struct statemove_command

Remove misleading typedef from struct statemove_command.

cmd_queue_page_t -> struct cmd_queue_page

Remove misleading typedef from struct cmd_queue_page.

scan_command_t -> struct scan_command

Remove misleading typedef on struct scan_command.

more vsllink typedef cleanup

Remove useless typedef for struct insert_insignification_operation.

vsllink_jtag_t -> struct vsllink

Remove misleading typedef and redundant suffix.

presto_t -> struct presto

Remove useless typedef.

ft2232_device_t -> struct ft2232_device

Remove misleading typedef from ft2232_device; it was barely used.

jlink_jtag_t -> struct jlink

Remove misleading typedef and redundant suffix.

cable_t -> struct cable

Remove useless typedef and redundant suffix from parport struct cable.

pending_scan_result_t -> struct pending_scan_result

Remove misleading typedef from struct struct pending_scan_result.
Future patches need to remove these duplicated types and code.

armjtagew_jtag_t -> struct armjtagew

Remove useless typedef and redundant suffix from struct armjtatew_jtag.

use struct jtag_tap_event_action

Remove useless typedef and redundant suffix from jtag_tap_event_action.

jtag_event_callback_t -> struct jtag_event_callback

Remove useless typedef and redundant suffix from jtag_event_callback.
Add documentation for the structure.

jtag_interface_t -> struct jtag_interface

Remove useless typedef and redundant suffix from struct jtag_interface.

bitbang_interface_t -> struct bitbang_interface

Removes another useless typedef and suffix.

bitq_interface_t -> struct biq_interface

Remove useless typedef and redundant suffix.

encapsulate bitq_state structure

Move the bitq_state structure from the header to source file, as it
is used internally.

Also removes its silly typedef.

scan_field_t -> struct scan_field

Remove useless structure typedef.

jtag_tap_t -> struct jtag_tap

Search and destroy the jtag_tap_t typedef.  This also cleans up a
layering violation, removing the declaration from types.h.

fileio_t -> struct fileio

Remove useless structure typedef.

log_callback_t -> struct log_callback

Removes useless and confusing typedef for log callback structure.
Types with _t should be suitable for passing by-value as arguments.

remove accidental artifact

Somehow I managed to slip a temporary build file into the tree.
Remove it and update the .gitignore file so it doesn't happen again.

add documention for writing built-in commands

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.

add src/hello.c to augment new command tutorial

The hello module provides the 'hello' command, printing a greetings
to the command console.  It can grow to serve as pedagogical example
of services that OpenOCD developers should use: a runnable style guide.

command_handler_t: make cmd an indirect parameter

This patch removes 'cmd' from the list of direct parameters, moving
that pointer to args[-1] (by way of the new CMD_NAME macro).

command_handler_t: make args parameter const

This patch prevents command handlers from modifying the strings passed
in the 'args' array.

command_handler_t: make cmd parameter const

Prevents the command name from being modified in command handlers.
Again, this has cascading effects, but the patches are fairly minimal.

command_handler_t: make argc unsigned

The number of command arguments will always be 0 or more, so use
the right type in handlers.  This has a cascading effect up through
the layers, but the new COMMAND_HANDLER macros prevented total chaos.

add CMD_NAME macro for command handlers

By introducing the CMD_NAME macro, this parameter may be integrated
as args[-1] in command.[ch], without touching any other call sites.

use CALL_COMMAND_HANDLER instead of direct calls

By using CALL_COMMAND_HANDLER, parameters can be reordered, added, or
even removed in inherited signatures, without requiring revisiting
all of the various call sites.

add PLD_DEVICE_COMMAND_HANDLER macro

Update virtex module to use abstracted PLD command handling.

nand: add NAND_DEVICE_COMMAND_HANDLER macro

Abstracts the extended NAND command handling to allow the function
signature to be controlled by __COMMAND_HANDLER.

use FLASH_BANK_COMMAND_HANDLER macro

Defines all flash_bank_command handlers using the new macro.

add FLASH_BANK_COMMAND_HANDLER macro

The FLASH_BANK_COMMAND_HANDLER provides an extended command handler
using the __COMMAND_HANDLER macro, whereby changing that macro is
sufficient to update flash handlers with the new signature.  It also
enforces uniform style and scope when implementing this handler.

s3c24xx: use COMMAND_HANDLER with command helper

Add S3C24XX_DEVICE_COMMAND macros to abstract common command handler
conventions.

arm_adi,armv7[am]: use COMMAND_HELPER for helpers

Rewrites the dap_* command helpers to use the COMMAND_HELPER paradigm.
Uses CALL_COMMAND_HELPER to hide inherited calling conventions.

use COMMAND_HELPER for command helper functions

Define the numerous helpers that inherit command handler parameters
using the COMMAND_HELPER macro.

use COMMAND_HANDLER macro to define all commands

add command_handler_t type

This patch adds new typedefs for command handler callback functions.
Users of this type signature were updated to use these new types.
It uses the new __COMMAND_HANDLER macro to prevent duplication.

add COMMAND_HANDLER and COMMAND_HELPER macros

The COMMAND_HANDLER and COMMAND_HELPER macros allow commands to be
defined in a manner that decouples them from the exact order and type of
their parameters.  Once converted, incremental changes to the command
handler type can be addressed in incremental patches that do not need to
touch the entire tree.

These macros' implementation, __COMMAND_HANDLER, is used to define the
new command_handler_t type, and additional patches will use it to derive
new macros to define extended command types (e.g. flash, nand, pld).
The CALL_COMMAND_HANDLER provides a means of calling helpers or nested
handlers from withing a command handler.

This patch uses C99 varadic macro expansion.  Please report compilers
that cannot handle this code.

add command_output_handler_t

Add a typedef for command output handler function type, simplifying
the appearance of functions that use it and eliminating duplicate code.

Cortex-A8: fix indent

The "remove (forward) declarations" patch goofed indentation on the
"cortexa8_target" struct; fix.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

nand: rename device to nand

To be more informative (and consistent with flash and pld trees), change
'device' parameter name to 'nand' in NAND source files.  This change
eliminates confusing 'device->device->' instance from the code, and
it simplifies the forthcoming command handler patches.

ETM: start support for ETMv2+

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>

WinXP-x64: find right D2XX libraries

This trivial patch allows the config script to find the correct
FTDI2xx libraries under Windows XP x64 using msys.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

parport: add support for the jtag_khz command.

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>

ETM: remove old mid-level ETM handle

Now that nothing uses the old ETM handle any more, remove it.
Add minimal header tweaks, letting non-ARM7 and non-ARM9 cores
access ETM facilities.

Now ARM11 could support standard ETM (and ETB) access as soon as
it derives from "struct arm" ... its scanchain 6 is used access
the ETM, just like ARM7 and ARM9.

The Cortex parts (both M3 and A8) will need modified access methods
(via ETM init parameters), so they use the DAP.  Our first A8 target
(OMAP3) needs that for both ETM and ETB, but the M3 ETM isn't very
useful without SWO trace support (it's painfully stripped down), so
that support won't be worth adding for a while.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

ETM: use new toplevel ETM handle

Make ETM itself use the new toplevel ETM handle, instead
of the to-be-removed lower level one.  As of this patch,
nothing should be using the old ARM7/ARM9-specific handle.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

ETM: update port drivers

Make both useful ETM port drivers (etb, etm_dummy) use the new
toplevel ETM handle, instead of the to-be-removed lower level one.

Do the same for the "oocd-trace" prototype too; and fix its
error reporting paths:  return failure codes, don't exit(), etc

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

ETM: update arm[79]tdmi_examine()

Make ARM7 and ARM9 cores use the new toplevel ETM handle to
trigger ETM setup, not the to-be-removed lower level one.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

ARM: start generalized base type

Rename "struct armv4_5_common_s" as "struct arm".  It needs
a bit more work to be properly generic, and to move out of
this header, but it's the best start we have on that today.

Add and initialize an optional ETM pointer, since that will
be the first thing that gets generalized.

The intent being:  all ARMs should eventually derive from
this "struct arm", so they can reuse the current ETM logic.
(And later, more.)  Currently the ARM cores that *don't* so
derive are only ARMv7-M (and thus Cortex-M3) and ARM11.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

fix 'jtag interface' behavior

Without this patch, running "openocd -c 'jtag interface'" segfaults.
Now, it returns the string "undefined" when the interface is unset.

improve command registration

Eliminate duplicate code for linking commands into a list.

Adds a check to ensure the command does not already exist;
if it does, return that one instead of creating a duplicate.

add help regardless of callback

Add help for commands regardless of whether a handler is involved.
With this, all sorts of new commands can be found in 'help' text.
Hopefully, all of them have been documented....

Sadly, the lsort function appears to handle nested lists poorly, such
that sub-commands do not group with their parents.

eliminate duplicate helptext management

Add helpers to manage adding entries to the helptext list.
Adds support for arbitrarily nested commands.

add command_name helper

The command_name function returns a malloced string for a given
command and its parents.  This can be used to display a message
to the user, but it is used internally to handle registration
and syntax errors.  This helps permit arbitrary command nesting.

wrap help command

Use continuation characters to wrap the help command into 80 columns.

remove obsolete doxygen comments

Documenting command handler parameters is redundant and pointless.

remove more useless declarations

Removes forward declarations by moving command registration after
defintion of the command handlers.

cortex_a8: remove declarations, use static keyword

add const keyword to some APIs

Add 'const' keyword to 'char *' parameters to allow command handlers to
pass constant string arguments.  These changes allow the 'args' command
handler to be changed to 'const' in a subsequent patch.

change argv to args in command handlers

Subsequent patches expect all command handlers to use a uniform
parameter naming scheme.  In the entire tree, these two files used
standard 'argv' instead of our non-standard 'args'.  This patch opts
to reduces the noise required to unify the command handlers, using
dominant 'args' form.

A future patch may be used to convert us back to the standard argv, but
that requires coordination with all developers to minimize disruptions.

script_debug(): improve types

Use unsigned type for number of arguments.

command.c: make private routines static

This patch also improves the signature of run_command function.

log: improve log_callback_fn signature

Use unsigned type for line number in log_callback_fn signature.

time_support: improve use of types

Update timeval_add_time to use long int; implement timeval_add with it.
Update timeval_ms to check gettimeofday return value, return int64_t.

makefiles: improve build order

Separates various groups of files to be built in logical succession.
In each layer, the core module (target.c, nand.c, etc.) is built _after_
their helper modules (e.g. image.c, nand_ecc.c) but _before_ any of
their drivers (e.g. arm966e.c, mx3_nand.c).

This allows problems introduced at the bottom of the stack to result
in build failures as soon as possible, as the helpers and core should
wrap portions of them.

ETM cleanup

Various cleanups of ETM related code.

 - Saner error return paths
 - Simplify arm7_9 init ... no need for extra zeroing!
 - Shrink some lines
 - Tweak some diagnostics
 - Use shorter name for ETM struct type.
 - Don't exit()

and similar.  The diagnostics look forward to having
this ETM code work with more than just ARM7/ARM9.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

fix bug in ARM720: bugfix

ARM720: bugfix

The "ARM720 uses the new inheritance/nesting scheme" patch
wrongly scrubbed a calloc() from arm720t_target_create().

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

target: MMU-aware init for memory read/write

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>

target.cfg: (re)move some bogus reset_config lines

General rule, this is all board-specific and doesn't belong
in target config files.  Some of these were just cosmetic.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

stm32.cfg: remove reset_config

Here's a patch for the double-reset problem on STM32.  I've tested
downloading and debugging with GDB and Eclipse, and everything seems
to work fine.

This effectively sets reset_config to none. trst_only would also
be ok, but that's better left to a board configuration file since
not all boards wire it up.

The NVIC is used to trigger reset, which at least on this chip also
pulses nSRST so the whole system does get rest -- exactly once.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

arm11: add etmr/etmw registers to access ETM via DBGTAP scan chain

First cut of these commands. Øyvind tinkered a bit with
the number parsing to bring it up to speed + rebased it.
Ready for testing.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>

ARM11: remove old mrc/mcr commands

Switch to new commands in config scripts

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>