CheckCommandStatus#

Fully qualified name: cupva::CheckCommandStatus

Defined in src/host/shared/include/install/cupva_host_common.hpp

Error cupva::CheckCommandStatus(CmdStatus const status)#

Check the completion status of a previously submitted command.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: Yes

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Parameters:

status – [in] Opaque handle to the status object associated with the command, as returned at submission. Must not be null and must refer to a still-valid command.

Throws:

cupva::Exception(DriverAPIError) – The PVA driver returned an unexpected error.

Returns:

The completion state of the command: cupva::Error::None if the command completed successfully, cupva::Error::OperationPending if it is still executing, or another cupva::Error value describing a reported failure.

Pre:

None