git.sur5r.net Git - openocd/blob - doc/manual/main.txt

   1 /** @mainpage OpenOCD Reference Manual
   2
   3 The @ref primer page provides introductory materials for new developers.
   4
   5 The @ref oocd page explains how the code has been organized into layers
   6 of APIs and gives an overview of how they fit together.
   7
   8  */
   9
  10 /** @page oocd OpenOCD Architecture
  11
  12 The OpenOCD library consists of several APIs that build together to
  13 provide the support functionality.  The following list shows how these
  14 modules are stacked in the current implementation (from bottom to top):
  15
  16 - @subpage helperdocs
  17   - @ref helperporting
  18   - @ref helperjim
  19   - @ref helpercommand
  20   - @ref helperlogging
  21 - @subpage jtagdocs
  22   - @ref jtagcable
  23   - @ref jtagtap
  24   - @ref jtagmdriver
  25   - @ref jtagdriver
  26 - @subpage targetdocs
  27   - @ref targetarm
  28   - @ref targetnotarm
  29   - @ref targetregister
  30   - @ref targetimage
  31   - @ref targettrace
  32 - @subpage flashdocs
  33   - @ref flashcfi
  34   - @ref flashnand
  35   - @ref flashtarget
  36 - @subpage serverdocs
  37   - @ref servergdb
  38   - @ref servertelnet
  39   - @ref serverhttp
  40 - @subpage appdocs
  41
  42 Obviously, there are some nuances to the stack that are not shown by
  43 this linear list of layers.
  44
  45  */