[sw] Update source documentation
Fixes mostly spelling errors and outdated parameters.
Based on the warnings generated by Doxygen.
Signed-off-by: Tobias Wölfel <tobias.woelfel@mailbox.org>
diff --git a/sw/device/lib/dif/dif_aes.h b/sw/device/lib/dif/dif_aes.h
index 27516e8..968d3f1 100644
--- a/sw/device/lib/dif/dif_aes.h
+++ b/sw/device/lib/dif/dif_aes.h
@@ -330,7 +330,7 @@
*
* @param aes AES state data.
* @param transaction Configuration data.
- * @param key_share Masked AES key.
+ * @param key Masked AES key.
* @param iv AES Initialisation Vector.
* @return The result of the operation.
*/
@@ -355,7 +355,7 @@
*
* @param aes AES state data.
* @param transaction Configuration data.
- * @paran key Masked AES key.
+ * @param key Masked AES key.
* @param iv AES Initial Counter Value.
* @return The result of the operation.
*/
diff --git a/sw/device/lib/dif/dif_clkmgr.h b/sw/device/lib/dif/dif_clkmgr.h
index 8f51929..bc02b03 100644
--- a/sw/device/lib/dif/dif_clkmgr.h
+++ b/sw/device/lib/dif/dif_clkmgr.h
@@ -198,7 +198,8 @@
*
* @param handle Clock Manager Handle.
* @param clock Hintable Clock ID.
- * @param[out] is_enabled the current software request (hint) for this clock.
+ * @param[out] hinted_is_enabled the current software request (hint) for this
+ * clock.
* @returns The result of the operation.
*/
DIF_WARN_UNUSED_RESULT
diff --git a/sw/device/lib/dif/dif_gpio.h b/sw/device/lib/dif/dif_gpio.h
index 4f8b035..8d10638 100644
--- a/sw/device/lib/dif/dif_gpio.h
+++ b/sw/device/lib/dif/dif_gpio.h
@@ -241,7 +241,8 @@
* Sets whether a particular pin's interrupt is currently enabled or disabled.
*
* @param gpio A GPIO handle.
- * @param pin A GPIO pin.
+ * @param mask Mask that identifies the pins whose interrupt triggers will be
+ * configured.
* @param state The new toggle state for the interrupt.
* @return The result of the operation.
*/
@@ -357,7 +358,7 @@
* The actual values on the pins depend on the output enable setting.
*
* @param gpio A GPIO handle.
- * @param val Value to write.
+ * @param state Value to write.
* @return The result of the operation.
*/
DIF_WARN_UNUSED_RESULT
diff --git a/sw/device/lib/dif/dif_i2c.h b/sw/device/lib/dif/dif_i2c.h
index 1b6f8e6..f85371c 100644
--- a/sw/device/lib/dif/dif_i2c.h
+++ b/sw/device/lib/dif/dif_i2c.h
@@ -356,8 +356,9 @@
* some of the calculations, such as how the allocation of a lengthened SCL
* period.
*
- * @param config Configuration values for producing timing parameters.
- * @param[out] out I2C configuration to which to apply the computed parameters.
+ * @param timing_config Configuration values for producing timing parameters.
+ * @param[out] config I2C configuration to which to apply the computed
+ * parameters.
* @return The result of the operation.
*/
DIF_WARN_UNUSED_RESULT
@@ -616,7 +617,7 @@
* @param i2c An I2C handle.
* @param byte The value to push onto the FIFO.
* @param code The code to use for this write.
- * @param supress_nak_irq Whether to supress the NAK IRQ for this one byte.
+ * @param suppress_nak_irq Whether to supress the NAK IRQ for this one byte.
* May not be used in combination with `Rx` codes.
* @return The result of the operation.
*/
diff --git a/sw/device/lib/dif/dif_keymgr.h b/sw/device/lib/dif/dif_keymgr.h
index 64610ce..75fc1f6 100644
--- a/sw/device/lib/dif/dif_keymgr.h
+++ b/sw/device/lib/dif/dif_keymgr.h
@@ -554,7 +554,7 @@
* Forces a particular alert as if hardware had asserted it.
*
* @param keymgr A key manager handle.
- * @param irq An alert type.
+ * @param alert An alert type.
* @return The result of the operation.
*/
DIF_WARN_UNUSED_RESULT
diff --git a/sw/device/lib/dif/dif_lc_ctrl.h b/sw/device/lib/dif/dif_lc_ctrl.h
index 6d9b89a..9156677 100644
--- a/sw/device/lib/dif/dif_lc_ctrl.h
+++ b/sw/device/lib/dif/dif_lc_ctrl.h
@@ -341,7 +341,7 @@
* up to 16.
*
* @param lc A lifecycle handle.
- * @param[out] state Out-param for the controller's state.
+ * @param[out] count Out-param for the number of attempts.
* @return The result of the operation.
*/
DIF_WARN_UNUSED_RESULT
diff --git a/sw/device/lib/dif/dif_otp_ctrl.h b/sw/device/lib/dif/dif_otp_ctrl.h
index d59d48d..890b5fa 100644
--- a/sw/device/lib/dif/dif_otp_ctrl.h
+++ b/sw/device/lib/dif/dif_otp_ctrl.h
@@ -656,7 +656,7 @@
* Gets the current status of the OTP controller.
*
* @param otp An OTP handle.
- * @param[out] stauts Out-param for the controller's status.
+ * @param[out] status Out-param for the controller's status.
* @return The result of the operation.
*/
DIF_WARN_UNUSED_RESULT
@@ -835,7 +835,7 @@
* addition, `address + len` must also be in-range and must not overflow.
*
* @param otp An OTP handle.
- * @param partition The partition to read from.
+ * @param address The address to read from.
* @param[out] buf A buffer of words to write read values to.
* @param len The number of words to read.
* @return The result of the operation.
diff --git a/sw/device/lib/dif/dif_plic.h b/sw/device/lib/dif/dif_plic.h
index 58dceb3..67b42db 100644
--- a/sw/device/lib/dif/dif_plic.h
+++ b/sw/device/lib/dif/dif_plic.h
@@ -337,7 +337,7 @@
*
* @param plic PLIC state data.
* @param target Target HART.
- * @param is_pending[out] Flag indicating whether the interrupt is pending.
+ * @param[out] is_pending Flag indicating whether the interrupt is pending.
* @return `dif_plic_result_t`.
*/
DIF_WARN_UNUSED_RESULT
diff --git a/sw/device/lib/dif/dif_usbdev.h b/sw/device/lib/dif/dif_usbdev.h
index 288e9e1..894ed71 100644
--- a/sw/device/lib/dif/dif_usbdev.h
+++ b/sw/device/lib/dif/dif_usbdev.h
@@ -414,7 +414,7 @@
*/
DIF_WARN_UNUSED_RESULT
dif_usbdev_buffer_read_result_t dif_usbdev_buffer_read(
- dif_usbdev_t *usbev, dif_usbdev_buffer_t *buffer, uint8_t *dst,
+ dif_usbdev_t *usbdev, dif_usbdev_buffer_t *buffer, uint8_t *dst,
size_t dst_len, size_t *bytes_written);
/**
