split flash.h into into flash/nor/*.h

Move the bulk of the flash.h file into flash/nor/core.h, leaving an
empty husk that will be removed in the next patch.

The NOR driver structure is an implementation detail, so move it into
its own private header file <flash/nor/driver.h> along with helper
declaration for finding them by name.

remove target.h from flash.h

The flash.h header does not require the target.h header file, but
its implementation source files do.  Move it to flash/nor/imp.h.

split NOR and NAND flash headers

Moves common flash errors to <flash/common.h> to decouple these two
mostly unrelated trees of code.

eliminate src/flash/flash.c

Move remaining NOR flash implemenation into flash/nor/core.c
Removes flash.c from the build, leaving only its header to split.

add flash/nor/drivers.c

Encapsulates access to the flash_drivers array, providing a base
of operations for future dynamic driver module loading features.

move more nor flash implementation details

Splits the exec mode commands out of flash.c into the flash/nor/ files.
The routines used by these high-level commands are moved into nor/core.c,
with their internal declarations placed in nor/imp.h.

Fixes distribution of <flash/nor/core.h> header.

ARM: semihosting entry cleanup

Clean up arm_semihosting() entry a bit, comment some issues and just
which SVC opcodes are getting intercepted.  Microcontroller profile
cores will need a new entry, since they use BKPT instead (and don't
have either SVC mode or an SPSR register).

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

ARM: remove semihosting globals

Store a flag and errno in in "struct arm".
Have "poll" output report when semihosting is active.
Shrink some of the affected lines.

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

User's Guide: more semihosting info

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>

bootstrap: stop execution upon error

When tools are not installed, exit immediately. This makes
the error messages clearer.

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

add flash/nor/core.[ch]

The newly moved flash TCL routines access the internals of the module
too much.  Fix the layering issues by adding new core NOR flash APIs:

<flash/nor/core.h>:
  - flash_driver_find_by_name() - self-descriptive

<flash/nor/imp.h>:
  - flash_bank_add()            - encapsulates adding banks to bank list
  - flash_bank_list()           - encapsulates retreiving bank list

This allows the externs in flash/nor/imp.h to be removed, and
these mechanisms may now be re-used by other flash module code.

add flash/nor/{tcl.c,imp.h} from flash/flash.c

Moves the top-level 'flash' command handlers into flash/nor/tcl.c,
with flash/nor/imp.h providing an internal implementation header
to share non-public API components.

separate Jim from jtag/core.c

After previous efforts, only one Jim routine remained in jtag/core.c,
and moving it to jtag/tcl.c painlessly finishes separating these layers.
The headers need separating, but the implementation is clean.

switch 'rm' command away from using Jim

Commands that do not need to use Jim should be registered as
high-level command handlers.

check top-level command registrations

When calling module_register_commands, the return value needs to be
checked for failures.  Instead of duplicating code, use an array of
function pointers to the identical registration functions to iterate
over during startup.

allow 'jtag init' to be run in any mode

Help alleviate further potential problems with interactive startup.

target: cygwin build fixes

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

zy1000: FPGA revC wip

The bug in revC register memory access is pretty much
cornered now.

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

basic ARM semihosting support

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>

doxygen: remove some warnings

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

Make ARM NAND I/O operations aware of last op

Updates the ARM NAND I/O code to look at and update the op
field of arm_nand_data to reflect the last operation performed.
It uses this field to copy the correct code to the target in the
case where the struct is used for reads and writes.

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

ARM NAND I/O interface update

Modify the arm_nand_data struct to better support both read and
write operations while using the same struct.  An additional
field was added, and initialized, to record the last operation
so that the correct code can be loaded to the working area.

[dbrownell@users.sourceforge.net: merge init patch, tweak GPL note]

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

NAND page command refactoring.

Created a new function that handles sending a command and the address
information for pages to a NAND device.

[dbrownell@users.sourceforge.net: tweaked line lengths, name 'oob_only']

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

ARMv7-A: tweak arch_state()

Punt to the armv4_5_arch_state() for all the common stuff, to
shrink code and so we will get any improvements it provides.

Don't hide watchpoint status if we happen to be in "abort" mode.

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

ARM DPM: share debug reason logic

No point in both ARM11 and Cortex-A8 having private copies
of the logic sorting out e.g. DBG_REASON_WATCHPOINT.

Add and use a shared routine for this ... there's actually
a bunch more debug entry logic that could be shared, this
is just a start on that.  Note that this routine fixes a
bug observed in the ARM11 code, where some abort mode quirks
were displayed as being an unknown debug reason; and also
silences needless ARM11 chatter.

Likewise with private copies of DSCR ... add one to the DPM
struct.  Save it as part of setting DBG_REASON_* so later
patches can switch over to using that copy.

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

ARM11: use shared DSCR bit names

For the bits now defined in "arm_dpm.h", switch to the
shared DSCR_* symbol and remove the ARM11_DSCR_* version.

Define DSCR_INT_DIS and use it instead of the ARM11_DSCR_*
sibling symbol.  (Note:  for both ARM11 and Cortex-A8, this
should arguably be enabled by default when single stepping.)

Remove some other unused declarations in "arm11.h".

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

ARM DPM: make DSCR bit defs sharable

Move the symbols for these bits from "armv7a.h" to "arm_dpm.h",
where they can be seen and used not just by Cortex-A but also
by the ARM11 (armv6) code.

Change them from bit numbers to bit masks ... this matches the
usage in ARM11 code, and also makes it easier to read.

Rename DSCR_EXT_INT_EN as DSCR_ITR_EN to match the docs; it's
enabling ITR functionality, not external interrupts, so this
changes the name to be less misleading.  (There *IS* a bit
affecting interrupts, and this isn't it.)

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

fix another init regression

This makes Beagle work again, instead of losing horribly because
the JTAG event handlers are no longer able to e.g. "runtest".  I
get the previous quirky behavior ... comes up OK but "reset halt"
somewhat mysteriously makes it all better.  (Instead of nothing
being able to work at all...)  However, I'm still seeing:

 The 'init' command must be used before 'init'.

That seems to come from invoking "jtag init", sometime after it
gets mapped to "ocd_jtag init", according to debug message traces.

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

fix double 'init' regression

To prevent regression in the behavior of 'init', we allow it to run in
any mode.  If provided with -c init and with -c noinit, then the second
init at startup caused a spurious mode failure.  Let 'init' handle it.

fix regressions with GDB port numbers

Use a separate variable for iterating GDB service port numbers than
the one set by the user.  Restores the behavior of returning the
original port number and only incrementing the port used on success.

zy1000: include files have moved about

now compiles again after include files were moved about
to reduce -I usage and stop using quotes but rather
angle brackets for include files.

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

remove tertiary include paths

With all #include directives converted, we only need to have the
top-level src/ directory in the search path.

change #include "../hello.h" to "hello.h"

Before we can -I the top-level src/ directory alone, references to
"hello.h" must be updated.  This is an internal header, so it does
not need angle brackets.

change #include "xsvf.h" to <xsvf/xsvf.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "xsvf.h"

the following form should be used.

#include <xsvf/xsvf.h>

The exception is from .c files in the same directory.

change #include "svf.h" to <svf/svf.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "svf.h"

the following form should be used.

#include <svf/svf.h>

The exception is from .c files in the same directory.

change #include "pld.h" to <pld/pld.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "pld.h"

the following form should be used.

#include <pld/pld.h>

The exception is from .c files in the same directory.

change #include "telnet_server.h" to <server/telnet_server.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "telnet_server.h"

the following form should be used.

#include <server/telnet_server.h>

The exception is from .c files in the same directory.

change #include "server.h" to <server/server.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "server.h"

the following form should be used.

#include <server/server.h>

The exception is from .c files in the same directory.

change #include "httpd.h" to <server/httpd.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "httpd.h"

the following form should be used.

#include <server/httpd.h>

The exception is from .c files in the same directory.

change #include "gdb_server.h" to <server/gdb_server.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "gdb_server.h"

the following form should be used.

#include <server/gdb_server.h>

The exception is from .c files in the same directory.

change #include "s3c24xx_regs.h" to <flash/nand/s3c24xx_regs.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "s3c24xx_regs.h"

the following form should be used.

#include <flash/nand/s3c24xx_regs.h>

The exception is from .c files in the same directory.

change #include "ocl.h" to <flash/nor/ocl.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "ocl.h"

the following form should be used.

#include <flash/nor/ocl.h>

The exception is from .c files in the same directory.

change #include "nand.h" to <flash/nand.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "nand.h"

the following form should be used.

#include <flash/nand.h>

The exception is from .c files in the same directory.

change #include "mflash.h" to <flash/mflash.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "mflash.h"

the following form should be used.

#include <flash/mflash.h>

The exception is from .c files in the same directory.

change #include "flash.h" to <flash/flash.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "flash.h"

the following form should be used.

#include <flash/flash.h>

The exception is from .c files in the same directory.

change #include "arm_nandio.h" to <flash/arm_nandio.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm_nandio.h"

the following form should be used.

#include <flash/arm_nandio.h>

The exception is from .c files in the same directory.

change #include "trace.h" to <target/trace.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "trace.h"

the following form should be used.

#include <target/trace.h>

The exception is from .c files in the same directory.

change #include "target_request.h" to <target/target_request.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "target_request.h"

the following form should be used.

#include <target/target_request.h>

The exception is from .c files in the same directory.

change #include "target.h" to <target/target.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "target.h"

the following form should be used.

#include <target/target.h>

The exception is from .c files in the same directory.

change #include "register.h" to <target/register.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "register.h"

the following form should be used.

#include <target/register.h>

The exception is from .c files in the same directory.

change #include "mips_ejtag.h" to <target/mips_ejtag.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "mips_ejtag.h"

the following form should be used.

#include <target/mips_ejtag.h>

The exception is from .c files in the same directory.

change #include "mips32_pracc.h" to <target/mips32_pracc.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "mips32_pracc.h"

the following form should be used.

#include <target/mips32_pracc.h>

The exception is from .c files in the same directory.

change #include "mips32.h" to <target/mips32.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "mips32.h"

the following form should be used.

#include <target/mips32.h>

The exception is from .c files in the same directory.

change #include "image.h" to <target/image.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "image.h"

the following form should be used.

#include <target/image.h>

The exception is from .c files in the same directory.

change #include "etm.h" to <target/etm.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "etm.h"

the following form should be used.

#include <target/etm.h>

The exception is from .c files in the same directory.

change #include "embeddedice.h" to <target/embeddedice.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "embeddedice.h"

the following form should be used.

#include <target/embeddedice.h>

The exception is from .c files in the same directory.

change #include "breakpoints.h" to <target/breakpoints.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "breakpoints.h"

the following form should be used.

#include <target/breakpoints.h>

The exception is from .c files in the same directory.

change #include "avrt.h" to <target/avrt.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "avrt.h"

the following form should be used.

#include <target/avrt.h>

The exception is from .c files in the same directory.

change #include "armv7m.h" to <target/armv7m.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "armv7m.h"

the following form should be used.

#include <target/armv7m.h>

The exception is from .c files in the same directory.

change #include "armv7a.h" to <target/armv7a.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "armv7a.h"

the following form should be used.

#include <target/armv7a.h>

The exception is from .c files in the same directory.

change #include "armv4_5_mmu.h" to <target/armv4_5_mmu.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "armv4_5_mmu.h"

the following form should be used.

#include <target/armv4_5_mmu.h>

The exception is from .c files in the same directory.

change #include "armv4_5_cache.h" to <target/armv4_5_cache.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "armv4_5_cache.h"

the following form should be used.

#include <target/armv4_5_cache.h>

The exception is from .c files in the same directory.

change #include "armv4_5.h" to <target/armv4_5.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "armv4_5.h"

the following form should be used.

#include <target/armv4_5.h>

The exception is from .c files in the same directory.

change #include "arm_jtag.h" to <target/arm_jtag.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm_jtag.h"

the following form should be used.

#include <target/arm_jtag.h>

The exception is from .c files in the same directory.

change #include "arm_dpm.h" to <target/arm_dpm.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm_dpm.h"

the following form should be used.

#include <target/arm_dpm.h>

The exception is from .c files in the same directory.

change #include "arm_adi_v5.h" to <target/arm_adi_v5.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm_adi_v5.h"

the following form should be used.

#include <target/arm_adi_v5.h>

The exception is from .c files in the same directory.

change #include "arm9tdmi.h" to <target/arm9tdmi.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm9tdmi.h"

the following form should be used.

#include <target/arm9tdmi.h>

The exception is from .c files in the same directory.

change #include "arm966e.h" to <target/arm966e.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm966e.h"

the following form should be used.

#include <target/arm966e.h>

The exception is from .c files in the same directory.

change #include "arm7tdmi.h" to <target/arm7tdmi.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm7tdmi.h"

the following form should be used.

#include <target/arm7tdmi.h>

The exception is from .c files in the same directory.

change #include "arm7_9_common.h" to <target/arm7_9_common.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm7_9_common.h"

the following form should be used.

#include <target/arm7_9_common.h>

The exception is from .c files in the same directory.

change #include "arm11.h" to <target/arm11.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "arm11.h"

the following form should be used.

#include <target/arm11.h>

The exception is from .c files in the same directory.

change #include "algorithm.h" to <target/algorithm.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "algorithm.h"

the following form should be used.

#include <target/algorithm.h>

The exception is from .c files in the same directory.

change #include "minidriver.h" to <jtag/minidriver.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "minidriver.h"

the following form should be used.

#include <jtag/minidriver.h>

The exception is from .c files in the same directory.

change #include "jtag.h" to <jtag/jtag.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "jtag.h"

the following form should be used.

#include <jtag/jtag.h>

The exception is from .c files in the same directory.

change #include "interface.h" to <jtag/interface.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "interface.h"

the following form should be used.

#include <jtag/interface.h>

The exception is from .c files in the same directory.

change #include "commands.h" to <jtag/commands.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "commands.h"

the following form should be used.

#include <jtag/commands.h>

The exception is from .c files in the same directory.

change #include "types.h" to <helper/types.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "types.h"

the following form should be used.

#include <helper/types.h>

The exception is from .c files in the same directory.

change #include "time_support.h" to <helper/time_support.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "time_support.h"

the following form should be used.

#include <helper/time_support.h>

The exception is from .c files in the same directory.

change #include "replacements.h" to <helper/replacements.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "replacements.h"

the following form should be used.

#include <helper/replacements.h>

The exception is from .c files in the same directory.

change #include "membuf.h" to <helper/membuf.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "membuf.h"

the following form should be used.

#include <helper/membuf.h>

The exception is from .c files in the same directory.

change #include "log.h" to <helper/log.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "log.h"

the following form should be used.

#include <helper/log.h>

The exception is from .c files in the same directory.

change #include "jim.h" to <helper/jim.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "jim.h"

the following form should be used.

#include <helper/jim.h>

The exception is from .c files in the same directory.

change #include "ioutil.h" to <helper/ioutil.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "ioutil.h"

the following form should be used.

#include <helper/ioutil.h>

The exception is from .c files in the same directory.

change #include "fileio.h" to <helper/fileio.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "fileio.h"

the following form should be used.

#include <helper/fileio.h>

The exception is from .c files in the same directory.

change #include "configuration.h" to <helper/configuration.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "configuration.h"

the following form should be used.

#include <helper/configuration.h>

The exception is from .c files in the same directory.

change #include "command.h" to <helper/command.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "command.h"

the following form should be used.

#include <helper/command.h>

The exception is from .c files in the same directory.

change #include "binarybuffer.h" to <helper/binarybuffer.h>

Changes from the flat namespace to heirarchical one.  Instead of writing:

#include "binarybuffer.h"

the following form should be used.

#include <helper/binarybuffer.h>

The exception is from .c files in the same directory.

normalize headers to make changing easier

These headers need minor tweaks to paves the way for wholesale
scripted coversion of the header files.

change autoconf #include in configure.in

Updates "system.h" and "replacements.h" with <helpers/system.h> and
<helpers/replacements.h> respectively.

allow #include directives to use module name

Includes the src directory in the search path, so header files may be
migrated from:

  #include "foo.h"

to
  #include <module/foo.h>

which is more conducive for installation.

feroceon.c should be part of ARM7_9_SRC

The Feroceon and Dragonite cores are similar to the ARM926 and ARM966
cores respectively.

Signed-off-by: Nicolas Pitre <nico@marvell.com>

remove #if HAVE_JTAG_INTERFACE_H from minidriver.h

Adds two "minidriver_imp.h" files, so the right one is allowed to be
"#included" by the Makefile logic.

move jtag drivers to src/jtag/drivers

Moves JTAG interface drivers to src/jtag/drivers/,
Adds src/jtag/drivers/Makefile.am.
Builds libocdjtagdrivers.la.

Flattens the rlink driver files into the drivers/ directory, adding
the 'rlink_' prefix or '.rlink' suffix as appropriate.

move nor drivers to src/flash/nor

Moves NOR flash drivers to 'src/flash/nor/'.
Adds 'src/flash/nor/Makefile.am'.
Builds 'libocdflashnor.la'.

move nand drivers to src/flash/nand/

Moves NAND drivers to src/flash/nand/.
Adds src/flash/nand/Makefile.am.
Builds libocdflashnand.la.

ARM11: don't expose DSCR

Remove the remaining extra copy of DSCR, and the register cache
of which it was a part.  That cache wasn't a very safe, or even
necessary, idea; it was essentialy letting debugger-private state
be manipulated by Tcl code that couldn't know how to do it right.

This makes the "reg" output of an ARM11 resemble what most other
ARM cores produce ... forward motion in the "make ARM11 work like
the rest of the ARM cores" Jihad!

ARM11: store a clean copy of DSCR

Just store a clean copy of DSCR in the per-CPU struct, so we
trivially pass a pointer to a recent copy.  This replaces the
previous "last_dscr" and cleans up most of the related calling
conventions ... but it doesn't remove the other DSCR copy.

ARM11: don't expose WDTR

Don't expose the WDTR register through the register cache any
more.  If anyone wants Tcl scripts to be able to use DCC based
communication with app code in the target, this wouldn't do it.

Bugfix:  don't trust the Tcl-accessible version of DSCR to
flag whether WDTR needs to be restored when resuming.

ARM11: don't expose RDTR

Don't expose the RDTR register through the register cache any
more.  If anyone wants Tcl scripts to be able to use DCC based
communication with app code in the target, this wouldn't do it.

Bugfix:  don't trust the Tcl-accessible version of DSCR to
flag whether RDTR needs to be restored when resuming.

ARM11: streamline debug entry

Streamline arm11_on_enter_debug_state() entry:

 - It should handle the standard updates:
    * target->debug_reason
    * target->state

 - Don't waste time re-reading DSCR; just pass it in

Also rename the routine to "arm11_debug_entry()", matching the
convention used elsewhere in OpenOCD.