GFA Data

Functions
peak_status	peak_GFA_Data_Write (peak_camera_handle hCam, peak_gfa_module module, uint64_t address, const uint8_t *data, size_t dataSize)
	Write data to the specified register address.
peak_status	peak_GFA_Data_Read (peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t *data, size_t dataSize)
	Read data from the specified register address.

Detailed Description

Generic data access related functions and types.

Function Documentation

peak_GFA_Data_Read()

peak_status peak_GFA_Data_Read	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		uint64_t	address,
		uint8_t *	data,
		size_t	dataSize
	)

Read data from the specified register address.

Reads the data from the specified register address.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	address	The address to read the data from.
[out]	data	The read data.
[in]	dataSize	The size of *data in bytes.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The read access to the specified address range was denied by the camera.

PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or data is an invalid pointer or dataSize is 0. Check peak_gfa_module.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).

peak_GFA_Data_Write()

peak_status peak_GFA_Data_Write	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		uint64_t	address,
		const uint8_t *	data,
		size_t	dataSize
	)

Write data to the specified register address.

Writes the specified data to the specified register address.

Note

The write access is only available in the GFA write access mode. See peak_GFA_EnableWriteAccess.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	address	The address to write the data to.
[in]	data	The data to write.
[in]	dataSize	The size of *data in bytes.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The write access to the specified address range was denied by the camera of the GFA write access mode is not enabled. Check for the GFA write access mode to be enabled via peak_GFA_IsWriteAccessEnabled.

PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or data is an invalid pointer or dataSize is 0. Check peak_gfa_module.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).