Synchronization Control Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetModuleSyncMode (int32_t cardIndex, int32_t module, naibrd_module_sync_config_type_t syncConfigType, naibrd_module_sync_mode_type_t syncMode, int32_t syncConfigModule)
	Sets the Synchronization mode for the module specified. Sample clocks and FIFO triggers can be synchronized between modules via a shared internal GPIO (shared between modules on the same board). Boards can share (synchronize) clocks and FIFO triggers between each other via an external I/O connection (front or rear I/O). This API sets the board mapping of a clock/trigger source (module or external) to all/any slave modules that sync off that signal.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetModuleSyncMode (int32_t cardIndex, int32_t module, naibrd_module_sync_config_type_t syncConfigType, naibrd_module_sync_mode_type_t *outsyncMode, int32_t *outsyncConfigModule)
	Retrieves the Synchronization mode for the module specified. Sample clocks and FIFO triggers can be synchronized between modules via a shared internal GPIO (shared between modules on the same board). Boards can share (synchronize) clocks and FIFO triggers between each other via an external I/O connection (front or rear I/O). This API sets the board mapping of a clock/trigger source (module or external) to all/any slave modules that sync off that signal.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetModuleSyncDecimation (int32_t cardIndex, int32_t module, uint32_t decimation)
	Sets decimation (oversampling) rate of the User Supplied Signal for the Master Module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetModuleSyncDecimation (int32_t cardIndex, int32_t module, uint32_t *outdecimation)
	Retrieves decimation (oversampling) rate of the User Supplied Signal for the Master Module.

Detailed Description

Function Documentation

naibrd_AD_GetModuleSyncDecimation()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetModuleSyncDecimation	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t *	outdecimation )

Retrieves decimation (oversampling) rate of the User Supplied Signal for the Master Module.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
outdecimation	: (Output) decimation rate.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.

naibrd_AD_GetModuleSyncMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetModuleSyncMode	(	int32_t	cardIndex,
		int32_t	module,
		naibrd_module_sync_config_type_t	syncConfigType,
		naibrd_module_sync_mode_type_t *	outsyncMode,
		int32_t *	outsyncConfigModule )

Retrieves the Synchronization mode for the module specified. Sample clocks and FIFO triggers can be synchronized between modules via a shared internal GPIO (shared between modules on the same board). Boards can share (synchronize) clocks and FIFO triggers between each other via an external I/O connection (front or rear I/O). This API sets the board mapping of a clock/trigger source (module or external) to all/any slave modules that sync off that signal.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
syncConfigType	: (Input) Either NAIBRD_SYNC_CONFIG_CLOCK to configure the clock sync or NAIBRD_SYNC_CONFIG_TRIGGER to configure the FIFO trigger sync.
outsyncMode	: (Output) Sets the syn mode of the type specified by syncConfigType. See naibrd_module_sync_mode_type_t for a list and description of values.
outsyncConfigModule	: (Output) Synchronization source module. The module that sources the signal that this module will sync to.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.

naibrd_AD_SetModuleSyncDecimation()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetModuleSyncDecimation	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	decimation )

Sets decimation (oversampling) rate of the User Supplied Signal for the Master Module.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
decimation	: (Input) decimation rate.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.

naibrd_AD_SetModuleSyncMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetModuleSyncMode	(	int32_t	cardIndex,
		int32_t	module,
		naibrd_module_sync_config_type_t	syncConfigType,
		naibrd_module_sync_mode_type_t	syncMode,
		int32_t	syncConfigModule )

Sets the Synchronization mode for the module specified. Sample clocks and FIFO triggers can be synchronized between modules via a shared internal GPIO (shared between modules on the same board). Boards can share (synchronize) clocks and FIFO triggers between each other via an external I/O connection (front or rear I/O). This API sets the board mapping of a clock/trigger source (module or external) to all/any slave modules that sync off that signal.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
syncConfigType	: (Input) Either NAIBRD_SYNC_CONFIG_CLOCK to configure the clock sync or NAIBRD_SYNC_CONFIG_TRIGGER to configure the FIFO trigger sync.
syncMode	: (Input) Sets the syn mode of the type specified by syncConfigType. See naibrd_module_sync_mode_type_t for a list and description of values.
syncConfigModule	: (Input) Synchronization source module. The module that sources the signal that this module will sync to.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.