zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
tinyriscv-openocd/doc/manual/helper.txt

101 lines
3.3 KiB
Plaintext
Raw Normal View History

Commit skeleton files for high-level developer manual using doxygen. git-svn-id: svn://svn.berlios.de/openocd/trunk@1771 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13 08:58:08 +00:00
/** @page helperdocs OpenOCD Helper APIs
OpenOCD uses several low-level APIs as the foundation for high-level APIs:
- @subpage helperporting
- @subpage helperjim
- @subpage helpercommand
- @subpage helperlogging
- @subpage helperbuffers
This section needs to be expanded.
*/
/** @page helperporting OpenOCD Types/Portability APIs
This section needs to be expanded to describe OpenOCD's type and
portability API.
*/
/** @page helperjim OpenOCD Jim API
The Jim API provides access to a small-footprint TCL implementation.
Visit http://jim.berlios.de/ for more information on Jim.
This section needs to be expanded to describe OpenOCD's Jim API.
*/
/** @page helpercommand OpenOCD Command API
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.
2009-11-11 09:31:34 +00:00
OpenOCD's command API allows modules to register callbacks that are then
available to the scripting services. It provides the mechanism for
these commands to be dispatched to the modlue using a standard
interfaces. It provides macros for defining functions that use and
extend this interface.
@section helpercmdhandler Command Handlers
Command handlers are functions with a particular signature, which can
be extended by modules for passing additional parameters to helpers or
another layer of handlers.
@subsection helpercmdhandlerdef Defining and Calling Command Handlers
update command_handler documentation Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 13:38:17 +00:00
These functions should be defined using the @c COMMAND_HANDLER macro.
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.
2009-11-11 09:31:34 +00:00
These methods must be defined as static, as their principle entry point
should be the run_command dispatch mechanism.
Command helper functions that require access to the full set of
update command_handler documentation Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 13:38:17 +00:00
parameters should be defined using the @c COMMAND_HELPER. These must be
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.
2009-11-11 09:31:34 +00:00
declared static by you, as sometimes you might want to share a helper
update command_handler documentation Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 13:38:17 +00:00
among several files (e.g. @c s3c24xx_nand.h).
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.
2009-11-11 09:31:34 +00:00
update command_handler documentation Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 13:38:17 +00:00
Both types of routines must be called using the @c CALL_COMMAND_HANDLER macro.
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.
2009-11-11 09:31:34 +00:00
Calls using this macro to normal handlers require the name of the command
handler (which can a name or function pointer). Calls to helpers and
derived handlers must pass those extra parameters specified by their
definitions; however, lexical capture is used for the core parameters.
This dirty trick is being used as a stop-gap measure while the API is
migrated to one that passes a pointer to a structure containing the
same ingredients. At that point, this macro will be removed and callers
will be able to use direct invocations.
Thus, the following macros can be used to define and call command
handlers or helpers:
update command_handler documentation Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 13:38:17 +00:00
- @c COMMAND_HANDLER - declare or define a command handler.
- @c COMMAND_HELPER - declare or define a derived command handler or helper.
- @c CALL_COMMAND_COMMAND - call a command handler/helper.
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.
2009-11-11 09:31:34 +00:00
@subsection helpercmdhandlermacros Command Handler Macros
update command_handler documentation Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 13:38:17 +00:00
In addition, the following macros may be used in the context of
command handlers and helpers:
- @c CMD_CTX - the current @c command_context
- @c CMD_NAME - invoked command name
- @c CMD_ARGC - the number of command arguments
- @c CMD_ARGV - array of command argument strings
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.
2009-11-11 09:31:34 +00:00
@section helpercmdprimer Command Development Primer
This @ref primercommand provides details about the @c hello module,
showing how the pieces desrcribed on this page fit together.
Commit skeleton files for high-level developer manual using doxygen. git-svn-id: svn://svn.berlios.de/openocd/trunk@1771 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13 08:58:08 +00:00
*/
/** @page helperlogging OpenOCD Logging API
This section needs to be expanded to describe OpenOCD's Logging API.
*/
/** @page helperbuffers OpenOCD Byte Buffer API
This section needs to be expanded to describe OpenOCD's Byte Buffer API.
*/