![]() |
NVIDIA DRIVE OS Linux SDK API Reference5.1.6.0 Release |
Manage NvMediaISCRootDevice objects, which represent the root of the Nvmedia ISC object system.
The NvMediaISCRootDevice object manages an I2C port on the host hardware device.
Typedefs | |
typedef void | NvMediaISCRootDevice |
An opaque handle for an NvMediaISCRootDevice object. More... | |
Enumerations | |
enum | NvMediaISC_I2CPort { NVMEDIA_ISC_I2C_BUS_0 = 0, NVMEDIA_ISC_I2C_BUS_1 = 1, NVMEDIA_ISC_I2C_BUS_2 = 2, NVMEDIA_ISC_I2C_BUS_3 = 3, NVMEDIA_ISC_I2C_BUS_4 = 4, NVMEDIA_ISC_I2C_BUS_5 = 5, NVMEDIA_ISC_I2C_BUS_6 = 6, NVMEDIA_ISC_I2C_BUS_7 = 7, NVMEDIA_ISC_I2C_BUS_8 = 8, NVMEDIA_ISC_I2C_BUS_9 = 9, NVMEDIA_ISC_I2C_BUS_10 = 10, NVMEDIA_ISC_I2C_BUS_11 = 11, NVMEDIA_ISC_I2C_SIMULATOR = 255 } |
Defines the I2C buses on the host hardware device. More... | |
enum | NvMediaISCPowerItems { NVMEDIA_ISC_PWR_AGGREGATOR, NVMEDIA_ISC_PWR_LINK_0, NVMEDIA_ISC_PWR_LINK_1, NVMEDIA_ISC_PWR_LINK_2, NVMEDIA_ISC_PWR_LINK_3 } |
Defines ISC power items, objects whose power can be turned on or off and queried with NvMediaISCRootDevicePowerControl() and NvMediaISCRootDeviceGetPowerStatus(). More... | |
typedef void NvMediaISCRootDevice |
An opaque handle for an NvMediaISCRootDevice object.
Definition at line 236 of file nvmedia_isc.h.
enum NvMediaISC_I2CPort |
Defines the I2C buses on the host hardware device.
Definition at line 217 of file nvmedia_isc.h.
enum NvMediaISCPowerItems |
Defines ISC power items, objects whose power can be turned on or off and queried with NvMediaISCRootDevicePowerControl() and NvMediaISCRootDeviceGetPowerStatus().
Definition at line 321 of file nvmedia_isc.h.
NvMediaStatus NvMediaISCRootDeviceAbortWaitForError | ( | NvMediaISCRootDevice * | device | ) |
Aborts a call to NvMediaISCRootDeviceWaitForError().
[in] | device | The root device to use. |
NVMEDIA_STATUS_OK | to indicate that the operatrion was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | to indicate that device was NULL. |
NVMEDIA_STATUS_ERROR | to indicate that some other error occurred. |
NvMediaISCRootDevice* NvMediaISCRootDeviceCreate | ( | uint32_t | portCfg | ) |
Creates an NvMediaISCRootDevice object.
void NvMediaISCRootDeviceDestroy | ( | NvMediaISCRootDevice * | device | ) |
Destroys an NvMediaISCRootDevice object.
[in] | device | Handle of the device to be destroyed. |
NvMediaStatus NvMediaISCRootDeviceEnableSync | ( | NvMediaISCRootDevice * | device, |
NvMediaBool | enable | ||
) |
Enables or disables pulse width modulation (PWM) for external synchronization.
[in] | device | The root device to use. |
[in] | enable | The PWM state. Use NVMEDIA_TRUE to enable PWM and NVMEDIA_FALSE to disable it. |
NVMEDIA_STATUS_OK | indicates that the operation was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | indicates that device was NULL. |
NVMEDIA_STATUS_ERROR | indicates that some other error occurred. |
NvMediaStatus NvMediaISCRootDeviceGetPowerStatus | ( | NvMediaISCRootDevice * | device, |
NvMediaISCPowerItems | powerItem, | ||
NvMediaBool * | powerStatus | ||
) |
Gets a power item's power status (on or off).
[in] | device | The root device to use. |
[in] | powerItem | The power item of device for which to get the power status. |
[out] | powerStatus | A pointer to the power status. |
NVMEDIA_STATUS_OK | indicates that the operation was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | indicates that one or more pointer parameters were NULL. |
NVMEDIA_STATUS_NOT_SUPPORTED | indicates that the device driver does not support this functionality. |
NVMEDIA_STATUS_ERROR | indicates that some other error occurred. |
NvMediaStatus NvMediaISCRootDeviceGetSyncConfig | ( | NvMediaISCRootDevice * | device, |
float_t * | freq, | ||
float_t * | dutyRatio | ||
) |
Gets the pulse width modulation (PWM) frequency and duty cycle.
[in] | device | The root device to use. |
[out] | freq | A pointer to PWM frequency. |
[out] | dutyRatio | A pointer to PWM duty cycle (fraction of time spent high). |
NVMEDIA_STATUS_OK | indicates that the operation was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | indicates that one or more pointer parameters were NULL. |
NVMEDIA_STATUS_NOT_SUPPORTED | indicates that the device does not support this functionality. |
NVMEDIA_STATUS_ERROR | indicates that some other error occurred. |
NvMediaStatus NvMediaISCRootDevicePowerControl | ( | NvMediaISCRootDevice * | device, |
NvMediaISCPowerItems | powerItem, | ||
NvMediaBool | powerOn | ||
) |
Sets a power item's power status (on or off).
[in] | device | The root device to use. |
[in] | powerItem | The power item of device whose power status is to be set. |
[in] | powerOn | The power status to set. |
NVMEDIA_STATUS_OK | indicates that the operation was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | indicates that device was NULL. |
NVMEDIA_STATUS_NOT_SUPPORTED | indicates that the device driver does not support this functionality. |
NVMEDIA_STATUS_ERROR | indicates that some other error occurred. |
NvMediaStatus NvMediaISCRootDeviceSetSyncConfig | ( | NvMediaISCRootDevice * | device, |
float_t | freq, | ||
float_t | dutyRatio | ||
) |
Sets the pulse width modulation (PWM) frequency and duty cycle.
[in] | device | The root device to use. |
[in] | freq | PWM frequency, in hertz. |
[in] | dutyRatio | PWM duty cycle (fraction of time spent high). |
NVMEDIA_STATUS_OK | indicates that the operation was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | indicates that device was NULL. |
NVMEDIA_STATUS_ERROR | indicates that some other error occurred. |
NvMediaStatus NvMediaISCRootDeviceWaitForError | ( | NvMediaISCRootDevice * | device | ) |
Waits until an error condition is reported or NvMediaISCRootDeviceAbortWaitForError() is called.
[in] | device | The root device to use. |
NVMEDIA_STATUS_OK | indicates that the call was successful. |
NVMEDIA_STATUS_BAD_PARAMETER | indicates that device was NULL. |
NVMEDIA_STATUS_ERROR | indicate that some other error occurred. |