diff options
author | Karl Palsson <karlp@etactica.com> | 2019-06-25 16:21:38 +0300 |
---|---|---|
committer | Karl Palsson <karlp@etactica.com> | 2019-06-26 00:15:24 +0300 |
commit | e5b5ba0f9ce15da40d9de188cd80eeb0a4553dbe (patch) | |
tree | 2aad66bf6185a156ef54826aeecb92aeaa20d876 | |
parent | 1b10a0871cb202d069f5ae15786f9fec98c9f2c7 (diff) |
doc: cm3: dwt: include existing documentation
-rw-r--r-- | lib/cm3/dwt.c | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/lib/cm3/dwt.c b/lib/cm3/dwt.c index b4408b0c..91a67029 100644 --- a/lib/cm3/dwt.c +++ b/lib/cm3/dwt.c @@ -1,3 +1,29 @@ +/** @defgroup CM3_dwt_file DWT + * + * @ingroup CM3_files + * + * @brief <b>libopencm3 Cortex-M Data Watchpoint and Trace unit</b> + * + * The DWT provides + * * Comparators, that support + * * watch points + * * data tracing + * * signalling to ETM + * * PC value tracing + * * cycle count matching + * * extra PC sampling + * * Sampling as a result of a clock count + * * external access for sampling + * * exception trace + * * performance profiling counters. + * + * Which of these features are available is unfortunately implementation defined. + * + * @see ARMv7m Architecture Reference Manual (Chapter ARMv7-M Debug) + * + * LGPL License Terms @ref lgpl_license + * @{ + */ /* * This file is part of the libopencm3 project. * @@ -75,3 +101,5 @@ uint32_t dwt_read_cycle_counter(void) } #endif /* defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__) */ } + +/**@}*/
\ No newline at end of file |