aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/hal_pal.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/include/hal_pal.h')
-rw-r--r--os/hal/include/hal_pal.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/os/hal/include/hal_pal.h b/os/hal/include/hal_pal.h
index abd2d0fd7..a3c9818ce 100644
--- a/os/hal/include/hal_pal.h
+++ b/os/hal/include/hal_pal.h
@@ -920,8 +920,7 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
- * @param[in] mode pad event mode
- * @param[in] callback event callback function
+ * @param[in] cb event callback function
* @param[in] arg callback argument
*
* @api
@@ -937,7 +936,7 @@ typedef struct {
* @brief Associates a callback to a line.
*
* @param[in] line line identifier
- * @param[in] callback event callback function
+ * @param[in] cb event callback function
* @param[in] arg callback argument
*
* @iclass
@@ -956,6 +955,11 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ * @param[in] timeout the number of ticks before the operation timeouts,
+ * the following special values are allowed:
+ * - @a TIME_IMMEDIATE immediate timeout.
+ * - @a TIME_INFINITE no timeout.
+ * .
* @returns The operation state.
* @retval MSG_OK if an edge has been detected.
* @retval MSG_TIMEOUT if a timeout occurred before an edge cound be detected.