You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

67 lines
1.7 KiB

  1. /** @mainpage OpenOCD Reference Manual
  2. @ref oocd explains how the code has been organized into layers
  3. of APIs and gives an overview of how they fit together. These pages
  4. attempt to give developers a high-level perspective of the various
  5. code modules provided by OpenOCD.
  6. @ref primer provide introductory materials for new developers.
  7. The List of @ref thelist enumerates opportunities for improving or
  8. extending the OpenOCD platform.
  9. */
  10. /** @page primer OpenOCD Technical Primers
  11. This pages lists Technical Primers available for OpenOCD Developers.
  12. They seek to provide information to pull novices up the learning curves
  13. associated with the fundamental technologies used by OpenOCD.
  14. - @subpage primertcl
  15. - @subpage primerjtag
  16. Contributions or suggestions for new Technical Primers are welcome.
  17. */
  18. /** @page oocd OpenOCD Architecture
  19. The OpenOCD library consists of several APIs that build together to
  20. provide the support functionality. The following list shows how these
  21. modules are stacked in the current implementation (from bottom to top):
  22. - @subpage helperdocs
  23. - @ref helperporting
  24. - @ref helperjim
  25. - @ref helpercommand
  26. - @ref helperlogging
  27. - @subpage jtagdocs
  28. - @ref jtagcable
  29. - @ref jtagtap
  30. - @ref jtagmdriver
  31. - @ref jtagdriver
  32. - @subpage targetdocs
  33. - @ref targetarm
  34. - @ref targetnotarm
  35. - @ref targetregister
  36. - @ref targetimage
  37. - @ref targettrace
  38. - @subpage flashdocs
  39. - @ref flashcfi
  40. - @ref flashnand
  41. - @ref flashtarget
  42. - @subpage serverdocs
  43. - @ref servergdb
  44. - @ref servertelnet
  45. - @ref serverhttp
  46. - @subpage appdocs
  47. Obviously, there are some nuances to the stack that are not shown by
  48. this linear list of layers.
  49. The List of @ref thelist enumerates opportunities for improving or
  50. extending the OpenOCD platform.
  51. */