[nrf fromtree] soc: nordic: ironside: Clean up error code docs

Clean up error code docs.

Signed-off-by: Sebastian Bøe <[email protected]>
(cherry picked from commit 363bad0)

Author: SebastianBoe

soc/nordic/ironside/include/nrf_ironside/cpuconf.h

@@ -63,10 +63,10 @@ BUILD_ASSERT(IRONSIDE_CPUCONF_NUM_ARGS <= NRF_IRONSIDE_CALL_NUM_ARGS);
  * If the given msg_size is less than that, the remaining bytes are set to zero.
  *
  * @retval 0 on success or if the CPU has already booted.
- * @retval Positive non-0 error status if reported by IronSide call.
- * @retval -IRONSIDE_CPUCONF_ERROR_WRONG_CPU if cpu is unrecognized
+ * @retval -IRONSIDE_CPUCONF_ERROR_WRONG_CPU if cpu is unrecognized.
  * @retval -IRONSIDE_CPUCONF_ERROR_MESSAGE_TOO_LARGE if msg_size is greater than
  * IRONSIDE_CPUCONF_SERVICE_MSG_MAX_SIZE.
+ * @retval Positive error status if reported by IronSide call (see error codes in @ref call.h).
  */
 int ironside_cpuconf(NRF_PROCESSORID_Type cpu, const void *vector_table, bool cpu_wait,
 		     const uint8_t *msg, size_t msg_size);

soc/nordic/ironside/include/nrf_ironside/dvfs.h

@@ -68,7 +68,19 @@ enum ironside_dvfs_oppoint {
  * specified value. It will block until the change is applied.
  *
  * @param dvfs_oppoint The new DVFS oppoint to set.
- * @return int 0 on success, negative error code on failure.
+ *
+ * @retval 0 on success.
+ * @retval -IRONSIDE_DVFS_ERROR_WRONG_OPPOINT if the requested DVFS oppoint is not allowed.
+ * @retval -IRONSIDE_DVFS_ERROR_BUSY if waiting for mutex lock timed out, or hardware is busy.
+ * @retval -IRONSIDE_DVFS_ERROR_OPPOINT_DATA if there is configuration error in the DVFS service.
+ * @retval -IRONSIDE_DVFS_ERROR_PERMISSION if the caller does not have permission to change the DVFS
+ * oppoint.
+ * @retval -IRONSIDE_DVFS_ERROR_NO_CHANGE_NEEDED if the requested DVFS oppoint is already set.
+ * @retval -IRONSIDE_DVFS_ERROR_TIMEOUT if the operation timed out, possibly due to a hardware
+ * issue.
+ * @retval -IRONSIDE_DVFS_ERROR_ISR_NOT_ALLOWED if the DVFS oppoint change operation is not allowed
+ * in the ISR context.
+ * @retval Positive error status if reported by IronSide call (see error codes in @ref call.h).
  */
 int ironside_dvfs_change_oppoint(enum ironside_dvfs_oppoint dvfs_oppoint);
 

soc/nordic/ironside/include/nrf_ironside/tdd.h

@@ -31,7 +31,8 @@ enum ironside_se_tdd_config {
  * @param config The configuration to be applied.
  *
  * @retval 0 on success.
- * @retval -IRONSIDE_SE_TDD_ERROR_EINVAL on invalid argument.
+ * @retval -IRONSIDE_SE_TDD_SERVICE_ERROR_INVALID_CONFIG if the configuration is invalid.
+ * @retval Positive error status if reported by IronSide call (see error codes in @ref call.h).
  */
 int ironside_se_tdd_configure(const enum ironside_se_tdd_config config);
 

soc/nordic/ironside/include/nrf_ironside/update.h

@@ -61,10 +61,10 @@ struct ironside_update_blob {
  *
  * @param update Pointer to update blob
  *
+ * @retval 0 on a successful request (although the update itself may still fail).
  * @retval -IRONSIDE_UPDATE_ERROR_NOT_PERMITTED if missing access to the update candidate.
  * @retval -IRONSIDE_UPDATE_ERROR_SICR_WRITE_FAILED if writing update parameters to SICR failed.
- * @returns Positive non-0 error status if reported by IronSide call.
- * @returns 0 on a successful request (although the update itself may still fail).
+ * @retval Positive error status if reported by IronSide call (see error codes in @ref call.h).
  *
  */
 int ironside_update(const struct ironside_update_blob *update);