From 7ef3e2494b9f8a6269d6e3a5a5af70ed2ce4e13d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?King=20K=C3=A9vin?= <kingkevin@cuvoodoo.info>
Date: Mon, 22 Mar 2021 11:52:58 +0100
Subject: [PATCH] swd: improve documentation

---
 lib/swd.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/swd.h b/lib/swd.h
index a14d9ad..4476753 100644
--- 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