swd: improve documentation

2021-03-22 11:52:58 +01:00 · 2021-03-22 11:52:58 +01:00 · 7ef3e2494b
parent 334d8564ff
commit 7ef3e2494b
1 changed files with 2 additions and 0 deletions
--- a/lib/swd.h
+++ b/lib/swd.h
@ -85,6 +85,8 @@ enum swd_activation_code_e {
 };

 /** setup SWD peripheral
+ *  @param[in] freq clock frequency, in Hz
+ *  @note above 50 kHz the communication still works, but the clock is not periodic anymore
 */
 void swd_setup(uint32_t freq);
 /** release peripherals used for SWD communication