ISC Root Device

Detailed Description

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...

Functions
NvMediaISCRootDevice *	NvMediaISCRootDeviceCreate (uint32_t portCfg)
	Creates an NvMediaISCRootDevice object. More...
void	NvMediaISCRootDeviceDestroy (NvMediaISCRootDevice *device)
	Destroys an NvMediaISCRootDevice object. More...
NvMediaStatus	NvMediaISCRootDeviceWaitForError (NvMediaISCRootDevice *device)
	Waits until an error condition is reported or NvMediaISCRootDeviceAbortWaitForError() is called. More...
NvMediaStatus	NvMediaISCRootDeviceAbortWaitForError (NvMediaISCRootDevice *device)
	Aborts a call to NvMediaISCRootDeviceWaitForError(). More...
NvMediaStatus	NvMediaISCRootDevicePowerControl (NvMediaISCRootDevice *device, NvMediaISCPowerItems powerItem, NvMediaBool powerOn)
	Sets a power item's power status (on or off). More...
NvMediaStatus	NvMediaISCRootDeviceGetPowerStatus (NvMediaISCRootDevice *device, NvMediaISCPowerItems powerItem, NvMediaBool *powerStatus)
	Gets a power item's power status (on or off). More...
NvMediaStatus	NvMediaISCRootDeviceEnableSync (NvMediaISCRootDevice *device, NvMediaBool enable)
	Enables or disables pulse width modulation (PWM) for external synchronization. More...
NvMediaStatus	NvMediaISCRootDeviceSetSyncConfig (NvMediaISCRootDevice *device, float_t freq, float_t dutyRatio)
	Sets the pulse width modulation (PWM) frequency and duty cycle. More...
NvMediaStatus	NvMediaISCRootDeviceGetSyncConfig (NvMediaISCRootDevice *device, float_t *freq, float_t *dutyRatio)
	Gets the pulse width modulation (PWM) frequency and duty cycle. More...

Typedef Documentation

typedef void NvMediaISCRootDevice

An opaque handle for an NvMediaISCRootDevice object.

Definition at line 236 of file nvmedia_isc.h.

Enumeration Type Documentation

enum NvMediaISC_I2CPort

Defines the I2C buses on the host hardware device.

Enumerator
NVMEDIA_ISC_I2C_BUS_0	Specifies i2c-0.
NVMEDIA_ISC_I2C_BUS_1	Specifies i2c-1.
NVMEDIA_ISC_I2C_BUS_2	Specifies i2c-2.
NVMEDIA_ISC_I2C_BUS_3	Specifies i2c-3.
NVMEDIA_ISC_I2C_BUS_4	Specifies i2c-4.
NVMEDIA_ISC_I2C_BUS_5	Specifies i2c-5.
NVMEDIA_ISC_I2C_BUS_6	Specifies i2c-6.
NVMEDIA_ISC_I2C_BUS_7	Specifies i2c-7.
NVMEDIA_ISC_I2C_BUS_8	Specifies i2c-8.
NVMEDIA_ISC_I2C_BUS_9	Specifies i2c-9.
NVMEDIA_ISC_I2C_BUS_10	Specifies i2c-10.
NVMEDIA_ISC_I2C_BUS_11	Specifies i2c-11.
NVMEDIA_ISC_I2C_SIMULATOR	Port SIMPULATOR (20)

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().

Enumerator
NVMEDIA_ISC_PWR_AGGREGATOR	Specifies aggregator power.
NVMEDIA_ISC_PWR_LINK_0	Specifies LINK 0 power.
NVMEDIA_ISC_PWR_LINK_1	Specifies LINK 1 power.
NVMEDIA_ISC_PWR_LINK_2	Specifies LINK 2 power.
NVMEDIA_ISC_PWR_LINK_3	Specifies LINK 3 power.

Definition at line 321 of file nvmedia_isc.h.

Function Documentation

NvMediaStatus NvMediaISCRootDeviceAbortWaitForError

(

NvMediaISCRootDevice *

device

)

Aborts a call to NvMediaISCRootDeviceWaitForError().

Parameters

[in]

device

The root device to use.

Return values

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.

Parameters

[in]

portCfg

The CSI/I2C ports that this root device use. It is strongly recommended that you use the macro ISC_RDEV_CFG(csi, i2c) or ISC_RDEV_CFG_EX(csi, i2c, disPwrCtrl) to generate this value. If the application runs on a slave SoC while a master SoC controls ISC devices, use ISC_SLV_RDEV_CFG(csi, i2c). Supported I2C are: NVMEDIA_ISC_I2C_BUS_0 NVMEDIA_ISC_I2C_BUS_1 NVMEDIA_ISC_I2C_BUS_2 NVMEDIA_ISC_I2C_BUS_3 NVMEDIA_ISC_I2C_BUS_4 NVMEDIA_ISC_I2C_BUS_5 NVMEDIA_ISC_I2C_BUS_6 NVMEDIA_ISC_I2C_BUS_7 NVMEDIA_ISC_I2C_BUS_8 NVMEDIA_ISC_I2C_BUS_9 NVMEDIA_ISC_I2C_BUS_10 NVMEDIA_ISC_I2C_BUS_11 NVMEDIA_ISC_I2C_SIMULATOR Supported CSI ports are: NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_A NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_B NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_AB NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_C NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_D NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_CD NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_E NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_F NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_EF NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_G NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_H NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_GH

Returns

The new device's handle if successful, or NULL otherwise.

void NvMediaISCRootDeviceDestroy

(

NvMediaISCRootDevice *

device

)

Destroys an NvMediaISCRootDevice object.

Parameters

[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.

Parameters

[in]	device	The root device to use.
[in]	enable	The PWM state. Use NVMEDIA_TRUE to enable PWM and NVMEDIA_FALSE to disable it.

Return values

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).

Parameters

[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.

Return values

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.

Parameters

[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).

Return values

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).

Parameters

[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.

Return values

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.

Parameters

[in]	device	The root device to use.
[in]	freq	PWM frequency, in hertz.
[in]	dutyRatio	PWM duty cycle (fraction of time spent high).

Return values

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.

Parameters

[in]

device

The root device to use.

Return values

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.