IUNIVERSAL_Status Struct Reference

Defines instance status parameters (read-only). More...

#include <iuniversal.h>

Collaboration diagram for IUNIVERSAL_Status:

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
	Extended error information.
XDM1_BufDesc	data

---

Detailed Description

Defines instance status parameters (read-only).

@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters.  The presence of vendor specific extensions will be detected by the value of the @c size parameter.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IUNIVERSAL_Fxns::control()

---

Field Documentation

XDAS_Int32 IUNIVERSAL_Status::size

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int32 IUNIVERSAL_Status::extendedError

Extended error information.

Remarks:

When an internal error occurs, the algorithm will return an error return value (e.g. EFAIL, EUNSUPPORTED)

The value of each enum is the bit which is set.

Bits 31-16 are reserved. Bits 7-0 are codec and implementation specific.

The algorithm can set multiple bits to 1 based on conditions. e.g. it will set bits XDM_FATALERROR (fatal) and XDM_UNSUPPORTEDPARAM (unsupported params) in case of unsupported run time parameters.

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:

XDM_ErrorBit

XDM1_BufDesc IUNIVERSAL_Status::data

Buffer descriptor for data passing.

                                @remarks   These buffers can be used as
                                           either input, output, or
                                           input/output buffers,
                                           depending on the command.

                                @remarks   The buffers will be provided
                                           by the application, and
                                           returned to the application
                                           upon return of the control()
                                           call.  The algorithm must
                                           not retain a pointer to this
                                           data.

                                @sa    #XDM_GETVERSION

---

The documentation for this struct was generated from the following file:

• cetools/packages/ti/xdais/dm/iuniversal.h