diff options
Diffstat (limited to 'os')
| -rw-r--r-- | os/hal/include/hal_channels.h | 2 | ||||
| -rw-r--r-- | os/hal/include/hal_crypto.h | 2 | ||||
| -rw-r--r-- | os/hal/include/hal_pal.h | 10 | ||||
| -rw-r--r-- | os/hal/src/hal_crypto.c | 2 | ||||
| -rw-r--r-- | os/hal/src/hal_pal.c | 9 | ||||
| -rw-r--r-- | os/hal/templates/hal_crypto_lld.c | 4 | ||||
| -rw-r--r-- | os/rt/include/chtime.h | 2 |
7 files changed, 21 insertions, 10 deletions
diff --git a/os/hal/include/hal_channels.h b/os/hal/include/hal_channels.h index 688f7d4d9..e4ea25b29 100644 --- a/os/hal/include/hal_channels.h +++ b/os/hal/include/hal_channels.h @@ -220,7 +220,7 @@ typedef struct { *
* @api
*/
-#define chnControl(sdp, operation, arg) ((ip)->vmt->ctl(ip, operation, arg)
+#define chnControl(ip, operation, arg) ((ip)->vmt->ctl(ip, operation, arg)
/** @} */
/**
diff --git a/os/hal/include/hal_crypto.h b/os/hal/include/hal_crypto.h index 01ce3c33f..3edf23440 100644 --- a/os/hal/include/hal_crypto.h +++ b/os/hal/include/hal_crypto.h @@ -32,7 +32,7 @@ /*===========================================================================*/
/**
- * #brief Maximum size of a key for all supported algorithms.
+ * @brief Maximum size of a key for all supported algorithms.
*/
#define HAL_CRY_MAX_KEY_SIZE 32
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.
diff --git a/os/hal/src/hal_crypto.c b/os/hal/src/hal_crypto.c index 9f38d5369..5ab286ecd 100644 --- a/os/hal/src/hal_crypto.c +++ b/os/hal/src/hal_crypto.c @@ -1118,7 +1118,7 @@ cryerror_t cryDecryptDES_CBC(CRYDriver *cryp, /**
* @brief Hash using SHA1.
- * @NOTE Use of this algorithm is not recommended because proven weak.
+ * @note Use of this algorithm is not recommended because proven weak.
*
* @param[in] cryp pointer to the @p CRYDriver object
* @param[in] size size of input buffer
diff --git a/os/hal/src/hal_pal.c b/os/hal/src/hal_pal.c index 573ca2ff8..1f2ced277 100644 --- a/os/hal/src/hal_pal.c +++ b/os/hal/src/hal_pal.c @@ -123,7 +123,7 @@ void palSetBusMode(IOBus *bus, iomode_t mode) { *
* @param[in] port port identifier
* @param[in] pad pad number within the port
- * @param[in] callback event callback function
+ * @param[in] cb event callback function
* @param[in] arg callback argument
*
* @api
@@ -140,7 +140,7 @@ void palSetPadCallbackI(ioportid_t port, iopadid_t pad, * @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
*
* @api
@@ -159,6 +159,11 @@ void palSetLineCallbackI(ioline_t line, palcallback_t cb, void *arg) { *
* @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 could be detected.
diff --git a/os/hal/templates/hal_crypto_lld.c b/os/hal/templates/hal_crypto_lld.c index ec7fe3bcf..f80aece65 100644 --- a/os/hal/templates/hal_crypto_lld.c +++ b/os/hal/templates/hal_crypto_lld.c @@ -96,6 +96,8 @@ void cry_lld_stop(CRYDriver *cryp) { * @brief Initializes the transient key for a specific algorithm.
*
* @param[in] cryp pointer to the @p CRYDriver object
+ * @param[in] algorithm the algorithm identifier
+ * @param[in] size key size in bytes
* @param[in] keyp pointer to the key data
* @return The operation status.
* @retval CRY_NOERROR if the operation succeeded.
@@ -857,7 +859,7 @@ cryerror_t cry_lld_decrypt_DES_CBC(CRYDriver *cryp, /**
* @brief Hash using SHA1.
- * @NOTE Use of this algorithm is not recommended because proven weak.
+ * @note Use of this algorithm is not recommended because proven weak.
*
* @param[in] cryp pointer to the @p CRYDriver object
* @param[in] size size of input buffer
diff --git a/os/rt/include/chtime.h b/os/rt/include/chtime.h index b2fc9d5d0..c975d104b 100644 --- a/os/rt/include/chtime.h +++ b/os/rt/include/chtime.h @@ -331,7 +331,7 @@ extern "C" { * @details Converts from seconds to system ticks number.
* @note The result is rounded upward to the next tick boundary.
*
- * @param[in] sec number of seconds
+ * @param[in] secs number of seconds
* @return The number of ticks.
*
* @special
|