zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various doc/comment updates 

Doxygen: don't be needlessly verbose; alphabetically sort members
TODO: add random bits; clarify which manuals are referenced
ARM disassembler: mention a few opcodes that still aren't handled

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
__archive__
David Brownell 2010-01-21 16:45:00 -08:00
parent 08b0be94b5
commit 4960c9018f
3 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doxyfile.in
View File

@ -384,7 +384,7 @@ HIDE_SCOPE_NAMES = NO
# will put a list of the files that are included by a file in the documentation # will put a list of the files that are included by a file in the documentation
# of that file. # of that file.
SHOW_INCLUDE_FILES = YES SHOW_INCLUDE_FILES = NO
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members. # is inserted in the documentation for inline members.
@ -403,7 +403,7 @@ SORT_MEMBER_DOCS = YES
# by member name. If set to NO (the default) the members will appear in # by member name. If set to NO (the default) the members will appear in
# declaration order. # declaration order.
SORT_BRIEF_DOCS = NO SORT_BRIEF_DOCS = YES
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default) # hierarchy of group names into alphabetical order. If set to NO (the default)
@ -692,13 +692,13 @@ SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body # Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation. # of functions and classes directly in the documentation.
INLINE_SOURCES = YES INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code # doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible. # fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = NO STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES # If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented # then for each documented function all documented

18
TODO
View File

@ -142,6 +142,8 @@ Once the above are completed:
https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
- regression: "reset halt" between 729(works) and 788(fails): @par - regression: "reset halt" between 729(works) and 788(fails): @par
https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
- registers
- add flush-value operation, call them all on resume/reset
- mcr/mrc target->type support - mcr/mrc target->type support
- missing from ARM920t, ARM966e, XScale. - missing from ARM920t, ARM966e, XScale.
It's possible that the current syntax is unable to support read-modify-write It's possible that the current syntax is unable to support read-modify-write
@ -170,10 +172,18 @@ https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
- Thumb2 single stepping: ARM1156T2 needs simulator support - Thumb2 single stepping: ARM1156T2 needs simulator support
- Cortex A8 support (ML) - Cortex A8 support (ML)
- add target implementation (ML) - add target implementation (ML)
- Cortex M3 support
- when stepping, only write dirtied registers (be faster)
- when connecting to halted core, fetch registers (startup is quirky)
- Generic ARM run_algorithm() interface - Generic ARM run_algorithm() interface
- tagged struct wrapping ARM instructions and metadata - tagged struct wrapping ARM instructions and metadata
- not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7) - not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7)
- usable with at least arm_nandwrite() and generic CFI drivers - usable with at least arm_nandwrite() and generic CFI drivers
- ETM
- don't show FIFOFULL registers if they're not supported
- use comparators to get more breakpoints and watchpoints
- add "etm drivers" command
- trace driver init() via examine() paths only, not setup()/reset
- MC1322x support (JW/DE?) - MC1322x support (JW/DE?)
- integrate and test support from JW (and DE?) - integrate and test support from JW (and DE?)
- get working with a known good interface (i.e. not today's jlink) - get working with a known good interface (i.e. not today's jlink)
@ -356,9 +366,11 @@ to complete:
- Develop milestone and release guidelines, processes, and scripts. - Develop milestone and release guidelines, processes, and scripts.
- Develop "style" guidelines (and scripts) for maintainers: - Develop "style" guidelines (and scripts) for maintainers:
- reviewing patches - reviewing patches
- committing to Subversion - committing to git
- Review The Guide for OpenOCD Users for documentation errors or omissions - Review Users' Guide for documentation errors or omissions
- Update The Manual for OpenOCD Developers: - "capture" and "ocd_find" commands
- "ocd_" prefix on various stuff
- Update Developer's Manual (doxygen output)
- Add documentation describing the architecture of each module - Add documentation describing the architecture of each module
- Provide more Technical Primers to bootstrap contributor knowledge - Provide more Technical Primers to bootstrap contributor knowledge

1
src/target/arm_disassembler.c
View File

@ -50,6 +50,7 @@
* except as coprocessor 10/11 operations * except as coprocessor 10/11 operations
* * Most ARM instructions through ARMv6 are decoded, but some * * Most ARM instructions through ARMv6 are decoded, but some
* of the post-ARMv4 opcodes may not be handled yet * of the post-ARMv4 opcodes may not be handled yet
* CPS, SDIV, UDIV, LDREX*, STREX*, QASX, ...
* * NEON instructions are not understood (ARMv7-A) * * NEON instructions are not understood (ARMv7-A)
* *
* - Thumb/Thumb2 decoding * - Thumb/Thumb2 decoding