diff options
Diffstat (limited to 'src/include/usr/sbeio/sbeioif.H')
| -rw-r--r-- | src/include/usr/sbeio/sbeioif.H | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/src/include/usr/sbeio/sbeioif.H b/src/include/usr/sbeio/sbeioif.H index 1da44c646..65fa474f1 100644 --- a/src/include/usr/sbeio/sbeioif.H +++ b/src/include/usr/sbeio/sbeioif.H @@ -101,12 +101,17 @@ namespace SBEIO /** * @brief Sends a PSU chipOp to quiesce the SBE * - * @param[in] i_target Target with SBE to quiesce + * @param[in] i_pProc Processor target with SBE to quiesce. + * Throws error if requested target is nullptr or does not + * refer to a processor. + * + * @note Sets the requested processor's ASSUME_SBE_QUIESCED attribute + * to true to inhibit future quiesce sensitive operations. * * @return errlHndl_t Error log handle on failure. * */ - errlHndl_t sendPsuQuiesceSbe(TARGETING::Target * i_target); + errlHndl_t sendPsuQuiesceSbe(TARGETING::Target* i_pProc); /** * @brief Get the capabilities of the SBE via PSU |
