interesting
/
riscv-openocd
mirror of https://github.com/riscv/riscv-openocd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

David Brownell <david-b@pacbell.net>: 

Start updating the NOR flash coverage to use @deffn syntax, so the
commands have more consistent presentation and formatting.  This
reorganizes information and updates its presentation, except where
the information didn't really match the code.

This patch updates most of the driver specific support, creating one
new (and alphabetized!) section just for driver-specific data, where
previously that data was split over up to three sections.  Of note:

 - The at91sam7 docs were a bit out of date with respect to the code.

 - The "str9xpec" stuff still deserves some work.  For now, it sits
   in its own subsection; pretty messy.

 - Likewise the "mflash" stuff.  That's a parallel infrastructure,
   and is now in a section of its own.

 - The "mass_erase" commands for the Cortex M3 chips got turned into
   footnotes.  IMO, they should vanish sometime; they're superfluous.

 - There are still a bunch of undocumented NOR drivers.  Examples:
   avr(8), tms470, pic32mx, more.

Plus there are a handful of minor tweaks to the NAND docs (to help make
the NOR and NAND presentations be parallel); the "Command Index" has
been renamed as the "Command and Driver Index"; reference TI instead
of Luminary Micro in several places.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1937 b42882b7-edfa-0310-969c-e2dbd0fdcd60
This commit is contained in:
zwelch 2009-05-28 01:11:10 +00:00
parent d9284c0611
commit f37a8136fe
1 changed files with 334 additions and 229 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

563
doc/openocd.texi
View File

@ -82,7 +82,7 @@ This manual documents edition @value{EDITION} of the Open On-Chip Debugger
@comment Occurs when creating ``--html --no-split'' output @comment Occurs when creating ``--html --no-split'' output
@comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html
* OpenOCD Concept Index:: Concept Index * OpenOCD Concept Index:: Concept Index
* OpenOCD Command Index:: Command Index * Command and Driver Index:: Command and Driver Index
@end menu @end menu
@node About @node About
@ -110,7 +110,7 @@ OpenOCD internally. @xref{JTAG Hardware Dongles}.
@b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T, @b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
Cortex-M3 (Luminary Stellaris LM3 and ST STM32) based cores to be Cortex-M3 (Stellaris LM3 and ST STM32) based cores to be
debugged via the GDB protocol. debugged via the GDB protocol.
@b{Flash Programing:} Flash writing is supported for external CFI @b{Flash Programing:} Flash writing is supported for external CFI
@ -497,7 +497,7 @@ As of 28/Nov/2008, the following are supported:
@item @b{signalyzer} @item @b{signalyzer}
@* See: @url{http://www.signalyzer.com} @* See: @url{http://www.signalyzer.com}
@item @b{evb_lm3s811} @item @b{evb_lm3s811}
@* See: @url{http://www.luminarymicro.com} - The Luminary Micro Stellaris LM3S811 eval board has an FTD2232C chip built in. @* See: @url{http://www.luminarymicro.com} - The Stellaris LM3S811 eval board has an FTD2232C chip built in.
@item @b{olimex-jtag} @item @b{olimex-jtag}
@* See: @url{http://www.olimex.com} @* See: @url{http://www.olimex.com}
@item @b{flyswatter} @item @b{flyswatter}
@ -2398,204 +2398,265 @@ if the @option{erase} parameter is given.
@*Enable (@var{on}) or disable (@var{off}) protection of flash sectors <@var{first}> to @*Enable (@var{on}) or disable (@var{off}) protection of flash sectors <@var{first}> to
<@var{last}> of @option{flash bank} <@var{num}>. <@var{last}> of @option{flash bank} <@var{num}>.
@subsection mFlash commands
@cindex mFlash commands
@itemize @bullet
@item @b{mflash probe}
@cindex mflash probe
@*Probe mflash.
@item @b{mflash write} <@var{num}> <@var{file}> <@var{offset}>
@cindex mflash write
@*Write the binary <@var{file}> to mflash bank <@var{num}>, starting at
<@var{offset}> bytes from the beginning of the bank.
@item @b{mflash dump} <@var{num}> <@var{file}> <@var{offset}> <@var{size}>
@cindex mflash dump
@*Dump <size> bytes, starting at <@var{offset}> bytes from the beginning of the <@var{num}> bank
to a <@var{file}>.
@item @b{mflash config pll} <@var{frequency}>
@cindex mflash config pll
@*Configure mflash pll. <@var{frequency}> is input frequency of mflash. The order is Hz.
Issuing this command will erase mflash's whole internal nand and write new pll.
After this command, mflash needs power-on-reset for normal operation.
If pll was newly configured, storage and boot(optional) info also need to be update.
@item @b{mflash config boot}
@cindex mflash config boot
@*Configure bootable option. If bootable option is set, mflash offer the first 8 sectors
(4kB) for boot.
@item @b{mflash config storage}
@cindex mflash config storage
@*Configure storage information. For the normal storage operation, this information must be
written.
@end itemize
@section flash bank command @section flash bank command
The @b{flash bank} command is used to configure one or more flash chips (or banks in OpenOCD terms) The @command{flash bank} command is used to configure one or more flash
chips (or @emph{banks} in OpenOCD terms).
Most CPUs have the ablity to ``boot'' from the first flash bank.
@example @quotation Note
@b{flash bank} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> This command is not available after OpenOCD initialization has completed.
<@var{bus_width}> <@var{target}> [@var{driver_options ...}] Use it in board specific configuration files, not interactively.
@end example @end quotation
@cindex flash bank
@*Configures a flash bank at <@var{base}> of <@var{size}> bytes and <@var{chip_width}>
and <@var{bus_width}> bytes using the selected flash <driver>.
@subsection External Flash - cfi options @deffn {Config Command} {flash bank} driver base size chip_width bus_width target [driver_options]
@cindex cfi options Configures a flash bank which provides persistent storage
CFI flashes are external flash chips - often they are connected to a for addresses from @math{base} to @math{base + size - 1}.
specific chip select on the CPU. By default, at hard reset, most These banks will often be visible to GDB through the target's memory map.
CPUs have the ablity to ``boot'' from some flash chip - typically In some cases, configuring a flash bank will activate extra commands;
attached to the CPU's CS0 pin. see the driver-specific documentation.
For other chip selects: OpenOCD does not know how to configure, or @itemize @bullet
access a specific chip select. Instead you, the human, might need to @item @var{driver} ... identifies the controller driver
configure additional chip selects via other commands (like: mww) , or associated with the flash bank being declared.
This is usually @code{cfi} for external flash, or else
the name of a microcontroller with embedded flash memory.
@xref{Flash Driver List}.
@item @var{base} ... Base address of the flash chip.
@item @var{size} ... Size of the chip, in bytes.
For some drivers, this value is detected from the hardware.
@item @var{chip_width} ... Width of the flash chip, in bytes;
ignored for most microcontroller drivers.
@item @var{bus_width} ... Width of the data bus used to access the
chip, in bytes; ignored for most microcontroller drivers.
@item @var{target} ... Names the target used to issue
commands to the flash controller.
@comment Actually, it's currently a controller-specific parameter...
@item @var{driver_options} ... drivers may support, or require,
additional parameters. See the driver-specific documentation
for more information.
@end itemize
@end deffn
@section Flash Drivers, Options, and Commands
@anchor{Flash Driver List}
As noted above, the @command{flash bank} command requires a driver name,
and allows driver-specific options and behaviors.
Some drivers also activate driver-specific commands.
@subsection External Flash
@deffn {Flash Driver} cfi
@cindex Common Flash Interface
@cindex CFI
The ``Common Flash Interface'' (CFI) is the main standard for
external NOR flash chips, each of which connects to a
specific external chip select on the CPU.
Frequently the first such chip is used to boot the system.
Your board's @code{reset-init} handler might need to
configure additional chip selects using other commands (like: @command{mww} to
configure a bus and its timings) , or
perhaps configure a GPIO pin that controls the ``write protect'' pin perhaps configure a GPIO pin that controls the ``write protect'' pin
on the flash chip. on the flash chip.
The CFI driver can use a target-specific working area to significantly
speed up operation.
@b{flash bank cfi} <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> The CFI driver can accept the following optional parameters, in any order:
<@var{target}> [@var{jedec_probe}|@var{x16_as_x8}]
@*CFI flashes require the name or number of the target they're connected to
as an additional
argument. The CFI driver makes use of a working area (specified for the target)
to significantly speed up operation.
@var{chip_width} and @var{bus_width} are specified in bytes. @itemize
@item @var{jedec_probe} ... is used to detect certain non-CFI flash ROMs,
like AM29LV010 and similar types.
@item @var{x16_as_x8} ...
@end itemize
The @var{jedec_probe} option is used to detect certain non-CFI flash ROMs, like AM29LV010 and similar types. To configure two adjacent banks of 16 MBytes each, both sixteen bits (two bytes)
wide on a sixteen bit bus:
@var{x16_as_x8} ??? @example
flash bank cfi 0x00000000 0x01000000 2 2 $_TARGETNAME
flash bank cfi 0x01000000 0x01000000 2 2 $_TARGETNAME
@end example
@end deffn
@subsection Internal Flash (Microcontrollers) @subsection Internal Flash (Microcontrollers)
@subsubsection lpc2000 options
@cindex lpc2000 options
@b{flash bank lpc2000} <@var{base}> <@var{size}> 0 0 <@var{target}> <@var{variant}> @deffn {Flash Driver} aduc702x
<@var{clock}> [@var{calc_checksum}] The ADUC702x analog microcontrollers from ST Micro
@*LPC flashes don't require the chip and bus width to be specified. Additional include internal flash and use ARM7TDMI cores.
parameters are the <@var{variant}>, which may be @var{lpc2000_v1} (older LPC21xx and LPC22xx) The aduc702x flash driver works with models ADUC7019 through ADUC7028.
or @var{lpc2000_v2} (LPC213x, LPC214x, LPC210[123], LPC23xx and LPC24xx), The setup command only requires the @var{target} argument
the name or number of the target this flash belongs to (first is 0), since all devices in this family have the same memory layout.
the frequency at which the core
is currently running (in kHz - must be an integral number), and the optional keyword
@var{calc_checksum}, telling the driver to calculate a valid checksum for the exception
vector table.
@subsubsection at91sam7 options
@cindex at91sam7 options
@b{flash bank at91sam7} 0 0 0 0 <@var{target}>
@*AT91SAM7 flashes only require the @var{target}, all other values are looked up after
reading the chip-id and type.
@subsubsection str7 options
@cindex str7 options
@b{flash bank str7x} <@var{base}> <@var{size}> 0 0 <@var{target}> <@var{variant}>
@*variant can be either STR71x, STR73x or STR75x.
@subsubsection str9 options
@cindex str9 options
@b{flash bank str9x} <@var{base}> <@var{size}> 0 0 <@var{target}>
@*The str9 needs the flash controller to be configured prior to Flash programming, e.g.
@example @example
flash bank aduc702x 0 0 0 0 $_TARGETNAME
@end example
@end deffn
@deffn {Flash Driver} at91sam7
All members of the AT91SAM7 microcontroller family from Atmel
include internal flash and use ARM7TDMI cores.
The driver automatically recognizes a number of these chips using
the chip identification register, and autoconfigures itself.
@example
flash bank at91sam7 0 0 0 0 $_TARGETNAME
@end example
For chips which are not recognized by the controller driver, you must
provide additional parameters in the following order:
@itemize
@item @var{chip_model} ... label used with @command{flash info}
@item @var{banks}
@item @var{sectors_per_bank}
@item @var{pages_per_sector}
@item @var{pages_size}
@item @var{num_nvm_bits}
@item @var{freq_khz} ... required if an external clock is provided,
optional (but recommended) when the oscillator frequency is known
@end itemize
It is recommended that you provide zeroes for all of those values
except the clock frequency, so that everything except that frequency
will be autoconfigured.
Knowing the frequency helps ensure correct timings for flash access.
The flash controller handles erases automatically on a page (128/256 byte)
basis, so explicit erase commands are not necessary for flash programming.
However, there is an ``EraseAll`` command that can erase an entire flash
plane (of up to 256KB), and it will be used automatically when you issue
@command{flash erase_sector} or @command{flash erase_address} commands.
@deffn Command {at91sam7 gpnvm} bitnum (set|clear)
Set or clear a ``General Purpose Non-Volatle Memory'' (GPNVM)
bit for the processor. Each processor has a number of such bits,
used for controlling features such as brownout detection (so they
are not truly general purpose).
@quotation Note
This assumes that the first flash bank (number 0) is associated with
the appropriate at91sam7 target.
@end quotation
@end deffn
@end deffn
@deffn {Flash Driver} lpc2000
Most members of the LPC2000 microcontroller family from NXP
include internal flash and use ARM7TDMI cores.
The @var{lpc2000} driver defines two mandatory and one optional parameters,
which must appear in the following order:
@itemize
@item @var{variant} ... required, may be
@var{lpc2000_v1} (older LPC21xx and LPC22xx)
or @var{lpc2000_v2} (LPC213x, LPC214x, LPC210[123], LPC23xx and LPC24xx)
@item @var{clock_kHz} ... the frequency, in kiloHertz,
at which the core is running
@item @var{calc_checksum} ... optional (but you probably want to provide this!),
telling the driver to calculate a valid checksum for the exception vector table.
@end itemize
LPC flashes don't require the chip and bus width to be specified.
@example
flash bank lpc2000 0x0 0x7d000 0 0 $_TARGETNAME \
lpc2000_v2 14765 calc_checksum
@end example
@end deffn
@deffn {Flash Driver} stellaris
All members of the Stellaris LM3Sxxx microcontroller family from
Texas Instruments
include internal flash and use ARM Cortex M3 cores.
The driver automatically recognizes a number of these chips using
the chip identification register, and autoconfigures itself.
@footnote{Currently there is a @command{stellaris mass_erase} command.
That seems pointless since the same effect can be had using the
standard @command{flash erase_address} command.}
@example
flash bank stellaris 0 0 0 0 $_TARGETNAME
@end example
@end deffn
@deffn {Flash Driver} stm32x
All members of the STM32 microcontroller family from ST Microelectronics
include internal flash and use ARM Cortex M3 cores.
The driver automatically recognizes a number of these chips using
the chip identification register, and autoconfigures itself.
@example
flash bank stm32x 0 0 0 0 $_TARGETNAME
@end example
Some stm32x-specific commands
@footnote{Currently there is a @command{stm32x mass_erase} command.
That seems pointless since the same effect can be had using the
standard @command{flash erase_address} command.}
are defined:
@deffn Command {stm32x lock} num
Locks the entire stm32 device.
The @var{num} parameter is a value shown by @command{flash banks}.
@end deffn
@deffn Command {stm32x unlock} num
Unlocks the entire stm32 device.
The @var{num} parameter is a value shown by @command{flash banks}.
@end deffn
@deffn Command {stm32x options_read} num
Read and display the stm32 option bytes written by
the @command{stm32x options_write} command.
The @var{num} parameter is a value shown by @command{flash banks}.
@end deffn
@deffn Command {stm32x options_write} num (SWWDG|HWWDG) (RSTSTNDBY|NORSTSTNDBY) (RSTSTOP|NORSTSTOP)
Writes the stm32 option byte with the specified values.
The @var{num} parameter is a value shown by @command{flash banks}.
@end deffn
@end deffn
@deffn {Flash Driver} str7x
All members of the STR7 microcontroller family from ST Microelectronics
include internal flash and use ARM7TDMI cores.
The @var{str7x} driver defines one mandatory parameter, @var{variant},
which is either @code{STR71x}, @code{STR73x} or @code{STR75x}.
@example
flash bank str7x 0x40000000 0x00040000 0 0 $_TARGETNAME STR71x
@end example
@end deffn
@deffn {Flash Driver} str9x
Most members of the STR9 microcontroller family from ST Microelectronics
include internal flash and use ARM966E cores.
The str9 needs the flash controller to be configured using
the @command{str9x flash_config} command prior to Flash programming.
@example
flash bank str9x 0x40000000 0x00040000 0 0 $_TARGETNAME
str9x flash_config 0 4 2 0 0x80000 str9x flash_config 0 4 2 0 0x80000
@end example @end example
This will setup the BBSR, NBBSR, BBADR and NBBADR registers respectively.
@subsubsection str9 options (str9xpec driver) @deffn Command {str9x flash_config} num bbsr nbbsr bbadr nbbadr
Configures the str9 flash controller.
The @var{num} parameter is a value shown by @command{flash banks}.
@b{flash bank str9xpec} <@var{base}> <@var{size}> 0 0 <@var{target}>
@*Before using the flash commands the turbo mode must be enabled using str9xpec
@option{enable_turbo} <@var{num>.}
Only use this driver for locking/unlocking the device or configuring the option bytes.
Use the standard str9 driver for programming. @xref{STR9 specific commands}.
@subsubsection Stellaris (LM3Sxxx) options
@cindex Stellaris (LM3Sxxx) options
@b{flash bank stellaris} <@var{base}> <@var{size}> 0 0 <@var{target}>
@*Stellaris flash plugin only require the @var{target}.
@subsubsection stm32x options
@cindex stm32x options
@b{flash bank stm32x} <@var{base}> <@var{size}> 0 0 <@var{target}>
@*stm32x flash plugin only require the @var{target}.
@subsubsection aduc702x options
@cindex aduc702x options
@b{flash bank aduc702x} 0 0 0 0 <@var{target}>
@*The aduc702x flash plugin works with Analog Devices model numbers ADUC7019 through ADUC7028. The setup command only requires the @var{target} argument (all devices in this family have the same memory layout).
@subsection mFlash Configuration
@cindex mFlash Configuration
@b{mflash bank} <@var{soc}> <@var{base}> <@var{RST pin}> <@var{target}>
@cindex mflash bank
@*Configures a mflash for <@var{soc}> host bank at
<@var{base}>. Pin number format is dependent on host GPIO calling convention.
Currently, mflash bank support s3c2440 and pxa270.
(ex. of s3c2440) mflash <@var{RST pin}> is GPIO B1.
@example
mflash bank s3c2440 0x10000000 1b 0
@end example
(ex. of pxa270) mflash <@var{RST pin}> is GPIO 43.
@example
mflash bank pxa270 0x08000000 43 0
@end example
@section Microcontroller specific Flash Commands
@subsection AT91SAM7 specific commands
@cindex AT91SAM7 specific commands
The flash configuration is deduced from the chip identification register. The flash
controller handles erases automatically on a page (128/265 byte) basis, so erase is
not necessary for flash programming. AT91SAM7 processors with less than 512K flash
only have a single flash bank embedded on chip. AT91SAM7xx512 have two flash planes
that can be erased separatly. Only an EraseAll command is supported by the controller
for each flash plane and this is called with
@itemize @bullet @itemize @bullet
@item @b{flash erase} <@var{num}> @var{first_plane} @var{last_plane} @item @var{bbsr} - Boot Bank Size register
@*bulk erase flash planes first_plane to last_plane. @item @var{nbbsr} - Non Boot Bank Size register
@item @b{at91sam7 gpnvm} <@var{num}> <@var{bit}> <@option{set}|@option{clear}> @item @var{bbadr} - Boot Bank Start Address register
@cindex at91sam7 gpnvm @item @var{nbbadr} - Boot Bank Start Address register
@*set or clear a gpnvm bit for the processor
@end itemize @end itemize
@end deffn
@subsection STR9 specific commands @end deffn
@cindex STR9 specific commands
@anchor{STR9 specific commands}
These are flash specific commands when using the str9xpec driver.
@itemize @bullet
@item @b{str9xpec enable_turbo} <@var{num}>
@cindex str9xpec enable_turbo
@*enable turbo mode, will simply remove the str9 from the chain and talk
directly to the embedded flash controller.
@item @b{str9xpec disable_turbo} <@var{num}>
@cindex str9xpec disable_turbo
@*restore the str9 into JTAG chain.
@item @b{str9xpec lock} <@var{num}>
@cindex str9xpec lock
@*lock str9 device. The str9 will only respond to an unlock command that will
erase the device.
@item @b{str9xpec unlock} <@var{num}>
@cindex str9xpec unlock
@*unlock str9 device.
@item @b{str9xpec options_read} <@var{num}>
@cindex str9xpec options_read
@*read str9 option bytes.
@item @b{str9xpec options_write} <@var{num}>
@cindex str9xpec options_write
@*write str9 option bytes.
@end itemize
Note: Before using the str9xpec driver here is some background info to help @subsection str9xpec driver
you better understand how the drivers works. OpenOCD has two flash drivers for @cindex str9xpec
the str9.
Here is some background info to help
you better understand how this driver works. OpenOCD has two flash drivers for
the str9:
@enumerate @enumerate
@item @item
Standard driver @option{str9x} programmed via the str9 core. Normally used for Standard driver @option{str9x} programmed via the str9 core. Normally used for
@ -2630,25 +2691,45 @@ When performing a unlock remember that you will not be able to halt the str9 - i
has been locked. Halting the core is not required for the @option{str9xpec} driver has been locked. Halting the core is not required for the @option{str9xpec} driver
as mentioned above, just issue the commands above manually or from a telnet prompt. as mentioned above, just issue the commands above manually or from a telnet prompt.
@subsection STR9 configuration @subsubsection str9xpec driver options
@cindex STR9 configuration
@b{flash bank str9xpec} <@var{base}> <@var{size}> 0 0 <@var{target}>
@*Before using the flash commands the turbo mode must be enabled using str9xpec
@option{enable_turbo} <@var{num>.}
Only use this driver for locking/unlocking the device or configuring the option bytes.
Use the standard str9 driver for programming.
@subsubsection str9xpec specific commands
@cindex str9xpec specific commands
These are flash specific commands when using the str9xpec driver.
@itemize @bullet @itemize @bullet
@item @b{str9x flash_config} <@var{bank}> <@var{BBSR}> <@var{NBBSR}> @item @b{str9xpec enable_turbo} <@var{num}>
<@var{BBADR}> <@var{NBBADR}> @cindex str9xpec enable_turbo
@cindex str9x flash_config @*enable turbo mode, will simply remove the str9 from the chain and talk
@*Configure str9 flash controller. directly to the embedded flash controller.
@example @item @b{str9xpec disable_turbo} <@var{num}>
e.g. str9x flash_config 0 4 2 0 0x80000 @cindex str9xpec disable_turbo
This will setup @*restore the str9 into JTAG chain.
BBSR - Boot Bank Size register @item @b{str9xpec lock} <@var{num}>
NBBSR - Non Boot Bank Size register @cindex str9xpec lock
BBADR - Boot Bank Start Address register @*lock str9 device. The str9 will only respond to an unlock command that will
NBBADR - Boot Bank Start Address register erase the device.
@end example @item @b{str9xpec unlock} <@var{num}>
@cindex str9xpec unlock
@*unlock str9 device.
@item @b{str9xpec options_read} <@var{num}>
@cindex str9xpec options_read
@*read str9 option bytes.
@item @b{str9xpec options_write} <@var{num}>
@cindex str9xpec options_write
@*write str9 option bytes.
@end itemize @end itemize
@subsection STR9 option byte configuration @subsubsection STR9 option byte configuration
@cindex STR9 option byte configuration @cindex STR9 option byte configuration
@itemize @bullet @itemize @bullet
@item @b{str9xpec options_cmap} <@var{num}> <@option{bank0}|@option{bank1}> @item @b{str9xpec options_cmap} <@var{num}> <@option{bank0}|@option{bank1}>
@cindex str9xpec options_cmap @cindex str9xpec options_cmap
@ -2664,37 +2745,57 @@ NBBADR - Boot Bank Start Address register
@*configure str9 lvd reset warning source. @*configure str9 lvd reset warning source.
@end itemize @end itemize
@subsection STM32x specific commands @section mFlash
@cindex STM32x specific commands
@subsection mFlash Configuration
These are flash specific commands when using the stm32x driver. @cindex mFlash Configuration
@itemize @bullet @b{mflash bank} <@var{soc}> <@var{base}> <@var{RST pin}> <@var{target}>
@item @b{stm32x lock} <@var{num}> @cindex mflash bank
@cindex stm32x lock @*Configures a mflash for <@var{soc}> host bank at
@*lock stm32 device. <@var{base}>. Pin number format is dependent on host GPIO calling convention.
@item @b{stm32x unlock} <@var{num}> Currently, mflash bank support s3c2440 and pxa270.
@cindex stm32x unlock
@*unlock stm32 device. (ex. of s3c2440) mflash <@var{RST pin}> is GPIO B1.
@item @b{stm32x options_read} <@var{num}>
@cindex stm32x options_read @example
@*read stm32 option bytes. mflash bank s3c2440 0x10000000 1b 0
@item @b{stm32x options_write} <@var{num}> <@option{SWWDG}|@option{HWWDG}> @end example
<@option{RSTSTNDBY}|@option{NORSTSTNDBY}> <@option{RSTSTOP}|@option{NORSTSTOP}>
@cindex stm32x options_write (ex. of pxa270) mflash <@var{RST pin}> is GPIO 43.
@*write stm32 option bytes.
@item @b{stm32x mass_erase} <@var{num}> @example
@cindex stm32x mass_erase mflash bank pxa270 0x08000000 43 0
@*mass erase flash memory. @end example
@end itemize
@subsection mFlash commands
@cindex mFlash commands
@subsection Stellaris specific commands
@cindex Stellaris specific commands
These are flash specific commands when using the Stellaris driver.
@itemize @bullet @itemize @bullet
@item @b{stellaris mass_erase} <@var{num}> @item @b{mflash probe}
@cindex stellaris mass_erase @cindex mflash probe
@*mass erase flash memory. @*Probe mflash.
@item @b{mflash write} <@var{num}> <@var{file}> <@var{offset}>
@cindex mflash write
@*Write the binary <@var{file}> to mflash bank <@var{num}>, starting at
<@var{offset}> bytes from the beginning of the bank.
@item @b{mflash dump} <@var{num}> <@var{file}> <@var{offset}> <@var{size}>
@cindex mflash dump
@*Dump <size> bytes, starting at <@var{offset}> bytes from the beginning of the <@var{num}> bank
to a <@var{file}>.
@item @b{mflash config pll} <@var{frequency}>
@cindex mflash config pll
@*Configure mflash pll. <@var{frequency}> is input frequency of mflash. The order is Hz.
Issuing this command will erase mflash's whole internal nand and write new pll.
After this command, mflash needs power-on-reset for normal operation.
If pll was newly configured, storage and boot(optional) info also need to be update.
@item @b{mflash config boot}
@cindex mflash config boot
@*Configure bootable option. If bootable option is set, mflash offer the first 8 sectors
(4kB) for boot.
@item @b{mflash config storage}
@cindex mflash config storage
@*Configure storage information. For the normal storage operation, this information must be
written.
@end itemize @end itemize
@node NAND Flash Commands @node NAND Flash Commands
@ -2782,7 +2883,7 @@ initialization has completed. Use it in board specific
configuration files, not interactively. configuration files, not interactively.
@itemize @bullet @itemize @bullet
@item @var{controller} ... identifies a the controller driver @item @var{controller} ... identifies the controller driver
associated with the NAND device being declared. associated with the NAND device being declared.
@xref{NAND Driver List}. @xref{NAND Driver List}.
@item @var{target} ... names the target used when issuing @item @var{target} ... names the target used when issuing
@ -2849,6 +2950,7 @@ spare areas associated with each data page.
@deffn Command {nand erase} num offset length @deffn Command {nand erase} num offset length
@cindex NAND erasing @cindex NAND erasing
@cindex NAND programming
Erases blocks on the specified NAND device, starting at the Erases blocks on the specified NAND device, starting at the
specified @var{offset} and continuing for @var{length} bytes. specified @var{offset} and continuing for @var{length} bytes.
Both of those values must be exact multiples of the device's Both of those values must be exact multiples of the device's
@ -2864,6 +2966,7 @@ will still report that the block ``is'' bad.
@deffn Command {nand write} num filename offset [option...] @deffn Command {nand write} num filename offset [option...]
@cindex NAND writing @cindex NAND writing
@cindex NAND programming
Writes binary data from the file into the specified NAND device, Writes binary data from the file into the specified NAND device,
starting at the specified offset. Those pages should already starting at the specified offset. Those pages should already
have been erased; you can't change zero bits to one bits. have been erased; you can't change zero bits to one bits.
@ -2963,7 +3066,7 @@ bypassing hardware ECC logic.
with the wrong ECC data can cause them to be marked as bad. with the wrong ECC data can cause them to be marked as bad.
@end deffn @end deffn
@section NAND Drivers; Driver-specific Options and Commands @section NAND Drivers, Options, and Commands
@anchor{NAND Driver List} @anchor{NAND Driver List}
As noted above, the @command{nand device} command allows As noted above, the @command{nand device} command allows
driver-specific options and behaviors. driver-specific options and behaviors.
@ -2989,7 +3092,7 @@ the @command{nand raw_access} command.
@deffn {NAND Driver} lpc3180 @deffn {NAND Driver} lpc3180
These controllers require an extra @command{nand device} These controllers require an extra @command{nand device}
parameter: the clock rate used by the controller. parameter: the clock rate used by the controller.
@deffn Command {nand lpc3180 select} num [mlc|slc] @deffn Command {lpc3180 select} num [mlc|slc]
Configures use of the MLC or SLC controller mode. Configures use of the MLC or SLC controller mode.
MLC implies use of hardware ECC. MLC implies use of hardware ECC.
The @var{num} parameter is the value shown by @command{nand list}. The @var{num} parameter is the value shown by @command{nand list}.
@ -3014,7 +3117,10 @@ or @code{read_page} methods, so @command{nand raw_access} won't
change any behavior. change any behavior.
@end deffn @end deffn
@deffn {NAND Driver} {s3c2410, s3c2412, s3c2440, s3c2443} @deffn {NAND Driver} s3c2410
@deffnx {NAND Driver} s3c2412
@deffnx {NAND Driver} s3c2440
@deffnx {NAND Driver} s3c2443
These S3C24xx family controllers don't have any special These S3C24xx family controllers don't have any special
@command{nand device} options, and don't define any @command{nand device} options, and don't define any
specialized commands. specialized commands.
@ -3273,7 +3379,6 @@ Profiling samples the CPU's program counter as quickly as possible, which is use
@cindex Target Specific Commands @cindex Target Specific Commands
@page
@section Architecture Specific Commands @section Architecture Specific Commands
@cindex Architecture Specific Commands @cindex Architecture Specific Commands
@ -4503,8 +4608,8 @@ at91sam9260.cfg nslu2.cfg sam7x256.cfg wi-9c.cfg
@printindex cp @printindex cp
@node OpenOCD Command Index @node Command and Driver Index
@unnumbered OpenOCD Command Index @unnumbered Command and Driver Index
@printindex fn @printindex fn
@bye @bye