Contains Talise ADI HAL function prototypes type definitions for adi_hal.c. More...

#include <stdint.h>
#include <stddef.h>
#include "no_os_util.h"

Include dependency graph for adi_hal.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	adi_hal

Macros
#define	u16 uint16_t

#define	DIV_U64(x, y) no_os_div_u64(x, y)

#define	DIV_S64(x, y) no_os_div_s64(x, y)

#define	DIV_ROUND_CLOSEST NO_OS_DIV_ROUND_CLOSEST

#define	DIV_ROUND_CLOSEST_ULL NO_OS_DIV_ROUND_CLOSEST_ULL

#define	HAL_SPIWRITEARRAY_BUFFERSIZE 341

Enumerations
enum	adiHalErr_t { ADIHAL_OK = 0, ADIHAL_SPI_FAIL, ADIHAL_GPIO_FAIL, ADIHAL_TIMER_FAIL, ADIHAL_WAIT_TIMEOUT, ADIHAL_GEN_SW, ADIHAL_WARNING, ADIHAL_ERR }
	Enum of possible Errors Detected by HAL layer to be communicated to ADI APIs. More...

enum	adiLogLevel_t { ADIHAL_LOG_NONE = 0x0, ADIHAL_LOG_MSG = 0x1, ADIHAL_LOG_WARN = 0x2, ADIHAL_LOG_ERR = 0x4, ADIHAL_LOG_SPI = 0x8, ADIHAL_LOG_ALL = 0xF }
	An enumerated type in bit mask format to list the log message categories or groups. More...

enum	sysrefReqMode_t { SYSREF_CONT_ON, SYSREF_CONT_OFF, SYSREF_PULSE }

Functions
adiHalErr_t	ADIHAL_openHw (void *devHalInfo, uint32_t halTimeout_ms)
	Performs a platform hardware initialization for the ADI Device. More...

adiHalErr_t	ADIHAL_closeHw (void *devHalInfo)
	Closes any platform hardware drivers, handles, etc that were necessary for the ADI Device. More...

adiHalErr_t	ADIHAL_setTimeout (void *devHalInfo, uint32_t halTimeout_ms)
	Sets the a timeout duration for the HAL functions. More...

adiHalErr_t	ADIHAL_resetHw (void *devHalInfo)
	Performs a hardware reset on the ADI Device. More...

adiHalErr_t	ADIHAL_sysrefReq (void *devHalInfo, sysrefReqMode_t mode)
	Performs a SYSREF request to the clock generation device. More...

adiHalErr_t	ADIHAL_spiWriteByte (void *devHalInfo, uint16_t addr, uint8_t data)
	Performs a Single SPI write to an ADI Device. More...

adiHalErr_t	ADIHAL_spiWriteBytes (void devHalInfo, uint16_t addr, uint8_t *data, uint32_t count)
	Writes an array of SPI writes to an ADI Device. More...

adiHalErr_t	ADIHAL_spiReadByte (void devHalInfo, uint16_t addr, uint8_t readdata)
	Performs a Single SPI Read from an ADI Device. More...

adiHalErr_t	ADIHAL_spiReadBytes (void devHalInfo, uint16_t addr, uint8_t *readdata, uint32_t count)
	Performs a Multi SPI Read from an ADI Device. More...

adiHalErr_t	ADIHAL_spiWriteField (void *devHalInfo, uint16_t addr, uint8_t fieldVal, uint8_t mask, uint8_t startBit)
	Performs a write to the specified field in a SPI register. More...

adiHalErr_t	ADIHAL_spiReadField (void devHalInfo, uint16_t addr, uint8_t fieldVal, uint8_t mask, uint8_t startBit)
	Performs a read from a particular bit field in a SPI register. More...

adiHalErr_t	ADIHAL_wait_us (void *devHalInfo, uint32_t time_us)
	Delay or sleep for the specified number of microseconds. More...

adiHalErr_t	ADIHAL_setLogLevel (void *devHalInfo, uint16_t halLogLevel)
	Writes a character array to a log file to facilitate debugging. More...

adiHalErr_t	ADIHAL_writeToLog (void devHalInfo, adiLogLevel_t logLevel, uint32_t errorCode, const char comment)
	Writes a character array to a log file to facilitate debugging. More...

Detailed Description

Contains Talise ADI HAL function prototypes type definitions for adi_hal.c.

Macro Definition Documentation

◆ DIV_ROUND_CLOSEST

#define DIV_ROUND_CLOSEST NO_OS_DIV_ROUND_CLOSEST

◆ DIV_ROUND_CLOSEST_ULL

#define DIV_ROUND_CLOSEST_ULL NO_OS_DIV_ROUND_CLOSEST_ULL

◆ DIV_S64

#define DIV_S64	(	x,
		y
	)	no_os_div_s64(x, y)

◆ DIV_U64

#define DIV_U64	(	x,
		y
	)	no_os_div_u64(x, y)

◆ HAL_SPIWRITEARRAY_BUFFERSIZE

#define HAL_SPIWRITEARRAY_BUFFERSIZE 341

◆ u16

#define u16 uint16_t

Enumeration Type Documentation

◆ adiHalErr_t

enum adiHalErr_t

Enum of possible Errors Detected by HAL layer to be communicated to ADI APIs.

Enumerator
ADIHAL_OK	HAL function successful. No error Detected
ADIHAL_SPI_FAIL	HAL SPI operation failure. SPI controller Down
ADIHAL_GPIO_FAIL	HAL GPIO function Failure
ADIHAL_TIMER_FAIL	HAL Timer function Failure
ADIHAL_WAIT_TIMEOUT	HAL function Timeout
ADIHAL_GEN_SW	HAL function failed due to general invalid HAL data
ADIHAL_WARNING	HAL function warning that non critical error was detected
ADIHAL_ERR

◆ adiLogLevel_t

enum adiLogLevel_t

An enumerated type in bit mask format to list the log message categories or groups.

Enumerator
ADIHAL_LOG_NONE	HAL Log enum to represent all types of log messages not selected
ADIHAL_LOG_MSG	HAL Log enum to represent a log message type
ADIHAL_LOG_WARN	HAL Log enum to represent a warning message type
ADIHAL_LOG_ERR	HAL Log enum to represent a error message type
ADIHAL_LOG_SPI	HAL Log enum to represent a spi transaction type
ADIHAL_LOG_ALL	HAL Log enum to represent all types of log messages selected

◆ sysrefReqMode_t

enum sysrefReqMode_t

Enumerator
SYSREF_CONT_ON	Turn on continuous SYSREF request
SYSREF_CONT_OFF	Turn off continuous SYSREF request
SYSREF_PULSE	SYSREF request in N-shot mode

Function Documentation

◆ ADIHAL_closeHw()

adiHalErr_t ADIHAL_closeHw ( void * devHalInfo )

Closes any platform hardware drivers, handles, etc that were necessary for the ADI Device.

This function shall shutdown all external hardware resources required by ADI Device for correct functionality such as SPI drivers, GPIOs, clocks as as per the targeted platform and target ADI Device. It should close and free any resources assigned in ADIHAL_openHw(void *devHalInfo)

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function is called last to terminate the use of device instance and its hardware resources. ADIHAL_openHw for the same device instance prior to calling ADIHAL_closeHw

Dependencies –Application and Platform Specific modules defined by devHalInfo

Parameters

devHalInfo Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_SPI_FAIL	if function failed to close SPI driver for the device
ADIHAL_GPIO_FAIL,if	function failed to release GPIO resources
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_openHw()

adiHalErr_t ADIHAL_openHw	(	void *	devHalInfo,
		uint32_t	halTimeout_ms
	)

Performs a platform hardware initialization for the ADI Device.

This function shall initialize all external hardware resources required by ADI Device for correct functionality such as SPI drivers, GPIOs, clocks (if necessary), as per the target platform and target ADI Device. At minimum any SPI driver for the ADI Device must be initialized here in order for the SPI writes within the API to function.

The API based on the required operation shall set the value timeout parameter. Once this value is set it shall be the timeout requirement for all HAL operations. It is the responsibility of the HAL implementation to maintain this timeout value as a reference. The HAL implementation must use this value to ensure the HAL function do not block longer than this time interval.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This API should be called before calling any other ADIHAL functions.

Dependencies –Application and Platform Specific modules defined by devHalInfo

Parameters

devHalInfo	A void pointer to the targeted device state container. The Platform HAL defined structure containing hardware settings describing the device of interest.
halTimeout_ms	A positive integer value to set the HAL function timeout interval.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_SPI_FAIL	if function failed to open SPI driver for the device
ADIHAL_GPIO_FAIL,if	function failed to access GPIO resources
ADIHAL_TIMER_FAIL,if	function failed to access timer resources
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_resetHw()

adiHalErr_t ADIHAL_resetHw ( void * devHalInfo )

Performs a hardware reset on the ADI Device.

ADI Devices have a RESETB pin. This function shall toggle the appropriate ADI Device RESETB pin according to the specifications outlined in the ADI Device Data Sheet for the targeted Device.

ADI does not define the structure members in devHalInfo. The user developing the platform layer of code is required to reset the correct device based on some identifying information within their devHalInfo structure such as a spi chip select or other device id in devHalInfo.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may be called at any time to reset the device after the required GPIO drivers and resources are opened by the ADIHAL_openHw function call. and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules defined by devHalInfo

Parameters

devHalInfo Pointer to Platform HAL defined structure containing hardware settings describing the device of interest and required hardware references to toggle RESETB pin of the ADI device.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_GPIO_FAIL	if GPIO hardware to toggle ADI reset pin unavailable
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before reset pin toggle could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_setLogLevel()

adiHalErr_t ADIHAL_setLogLevel	(	void *	devHalInfo,
		uint16_t	halLogLevel
	)

Writes a character array to a log file to facilitate debugging.

This function uses the logLevel parameter to specify what type of message / warning / error to write to the log file. This function uses enums in adiLogLevel_t to set the log level. ADIHAL_LOG_NONE = 0x0, ADIHAL_LOG_MSG = 0x1, ADIHAL_LOG_WARN = 0x2, ADIHAL_LOG_ERR = 0x4, ADIHAL_LOG_SPI = 0x8, ADIHAL_LOG_ALL = 0xF

The user implementation may choose to allow a feature to filter the level of message to log. This could allow only logging errors for instance.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function should be used when setting up and configuring the system

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
halLogLevel	The type of message to log.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.

◆ ADIHAL_setTimeout()

adiHalErr_t ADIHAL_setTimeout	(	void *	devHalInfo,
		uint32_t	halTimeout_ms
	)

Sets the a timeout duration for the HAL functions.

This function shall set the timeout duration for the HAL functions. If the HAL operation exceed this time the function shall return with the ADIHAL_WAIT_TIMEOUT error. This value shall be set by the API based on the desired required operation. Once this value is set it shall be the timeout requirement for all HAL operations.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function can be called at anytime to change the timeout duration for the HAL functions. However, it is typically used during initialization.

Dependencies –Application and Platform Specific modules defined by devHalInfo

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
halTimeout_ms	A positive integer value to set the HAL function timeout interval.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown. eg devHalInfo

◆ ADIHAL_spiReadByte()

adiHalErr_t ADIHAL_spiReadByte	(	void *	devHalInfo,
		uint16_t	addr,
		uint8_t *	readdata
	)

Performs a Single SPI Read from an ADI Device.

This function shall perform a single SPI read from an ADI Device. The SPI read implementation must support 16 bit addressing and 8-bit data bytes.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may only be used after the required SPI drivers and resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
addr	The 16-bit address to read from the SPI device. Actual address can not exceed 15-bits since MSB bit is used for Read/Write bit in platform layer.
readdata	The 8-bit data value returned from SPI register addr

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_SPI_FAIL	if function failed to complete SPI transaction
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before SPI transaction could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

Here is the caller graph for this function:

◆ ADIHAL_spiReadBytes()

adiHalErr_t ADIHAL_spiReadBytes	(	void *	devHalInfo,
		uint16_t *	addr,
		uint8_t *	readdata,
		uint32_t	count
	)

Performs a Multi SPI Read from an ADI Device.

This function shall perform multi SPI read from an ADI Device. The SPI read implementation must support 16 bit addressing and 8-bit data bytes.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may only be used after the required SPI drivers and resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
*addr	An array of 15-bit addresses of SPI registers to read from. 15-bit SPI register Addresses (MSB bit in lower layers sets read/write bit)
*readdata	The 8-bit data value returned from SPI register addr
count	The number of SPI Reads to transfer. Must be equal to the size of the addr and data arrays.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_SPI_FAIL	if function failed to complete SPI transaction
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before SPI transaction could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_spiReadField()

adiHalErr_t ADIHAL_spiReadField	(	void *	devHalInfo,
		uint16_t	addr,
		uint8_t *	fieldVal,
		uint8_t	mask,
		uint8_t	startBit
	)

Performs a read from a particular bit field in a SPI register.

This function shall perform a single SPI read from an ADI Device. Before the SPI read value is returned, it is masked and bit-shifted to return only a desired subset of bits - the desired bit field.

Any necessary SPI drivers or resources are expected to have already been opened by the ADIHAL_openHw() function call.

The mask parameter is applied to the entire 8-bit SPI read back value. The startBit parameter shifts the desired subset of bits down to the zero bit position.

Desired Operation: readVal = SPI read of a 8-bit SPI register return (readVal & mask) >> startBit

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may only be used after the required SPI drivers and resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
addr	The 16-bit address to read/modify/write from the SPI device. Actual address can not exceed 15-bits since MSB bit is used for Read/Write bit in platform layer.
fieldVal	8-bit value: Readback value of a bitfield (subset) of the SPI register masked and shifted down to the bit 0 position
mask	8-bit mask of bits to readback (if a bit = 1, that bit can be read)
startBit	starting LSB bit of the fieldVal in the SPI reg. Bit shifts the fieldVal down to that bit before returning in fieldVal

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_SPI_FAIL	if function failed to complete SPI transaction
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before SPI transaction could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_spiWriteByte()

adiHalErr_t ADIHAL_spiWriteByte	(	void *	devHalInfo,
		uint16_t	addr,
		uint8_t	data
	)

Performs a Single SPI write to an ADI Device.

This function shall perform a single SPI write to an ADI Device. The SPI write implementation must support 15 bit addressing and 8-bit data bytes.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may only be used after the required SPI drivers and resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
addr	15-bit SPI register Address (MSB bit in lower layers sets read/write bit)
data	8-bit data value to write to the SPI address specified.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_SPI_FAIL	if function failed to complete SPI transaction
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before SPI transaction could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

Here is the caller graph for this function:

◆ ADIHAL_spiWriteBytes()

adiHalErr_t ADIHAL_spiWriteBytes	(	void *	devHalInfo,
		uint16_t *	addr,
		uint8_t *	data,
		uint32_t	count
	)

Writes an array of SPI writes to an ADI Device.

This function allows improved performance to write large sets of SPI registers to a single device by passing the SPI Write address and data to the platform driver in an array instead of many individual calls.

If the platform layer SPI driver has no way to write an array to the SPI driver, have this function call ADIHAL_spiWriteByte in a for loop.

Each address element corresponds to the same index element in the data array. addr[0] is the SPI address for data[0], addr[1] is the SPI addr for data[1], etc.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may only be used after the required SPI drivers and resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
addr	An array of 15-bit addresses of SPI register to write. 15-bit SPI register Addresses (MSB bit in lower layers sets read/write bit)
data	An array of 8-bit data values to write to the SPI addresses in the addr array.
count	The number of SPI Writes to transfer. Must be smaller or equal to the size of the addr and data arrays.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_SPI_FAIL	if function failed to complete SPI transaction
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before SPI transaction could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_spiWriteField()

adiHalErr_t ADIHAL_spiWriteField	(	void *	devHalInfo,
		uint16_t	addr,
		uint8_t	fieldVal,
		uint8_t	mask,
		uint8_t	startBit
	)

Performs a write to the specified field in a SPI register.

This function shall perform a Read/Modify/Write of a single SPI read from an bits in the register, and writing the value back to the SPI register. ADI Device. The mask and startBit parameters allow modifying some or all

The mask is expected to be applied to the complete 8-bit read back SPI register value. The startBit parameter is used to shift the fieldVal parameter to the correct starting bit in the SPI register.

Desired Operation: readVal = Read 8-bit SPI register value

Modify Clear bits in readVal for enabled mask bits (readVal & ~mask) Set bits in field based on mask and startBit ((fieldVal << startBit) & mask)

Write the modified value back to the SPI register

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function may only be used after the required SPI drivers and resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
addr	The 16-bit address to read/modify/write from the SPI device. Actual address can not exceed 15-bits since MSB bit is used for Read/Write bit in platform layer.
fieldVal	8-bit value to update in a bitfield (subset) of the SPI register
mask	8-bit mask of bits to modify (if a bit = 1, that bit can be modified)
startBit	starting bit of the fieldVal in the SPI reg. Bit shifts the fieldVal up to that bit before masking and modifying the SPI reg.

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_SPI_FAIL	if function failed to complete SPI transaction
ADIHAL_WAIT_TIMEOUT	if HAL timeout expired before SPI transaction could be completed.
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_sysrefReq()

adiHalErr_t ADIHAL_sysrefReq	(	void *	devHalInfo,
		sysrefReqMode_t	mode
	)

Performs a SYSREF request to the clock generation device.

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest and required hardware references to toggle SYSREF pin of the ADI device.
mode	SYSREF request mode.

Precondition: This function may be called at any time to issue a SYSREF request after the required GPIO drivers and resources are opened by the ADIHAL_openHw function call and not after ADIHAL_closeHW.

Dependencies –Application and Platform Specific modules defined by devHalInfo

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_ERROR	if wrong mode is provided.

Here is the caller graph for this function:

◆ ADIHAL_wait_us()

adiHalErr_t ADIHAL_wait_us	(	void *	devHalInfo,
		uint32_t	time_us
	)

Delay or sleep for the specified number of microseconds.

Performs a thread blocking/sleeping delay of the specified time in us. Function should wait at least for the specified amount of time.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function can be used at any time to create a delay

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
time_us	The amount of time in microseconds to block - thread sleep for

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_TIMER_FAIL	if function delay function failed to complete
ADIHAL_WARNING	if function failed to access non-critical resource eg logging

◆ ADIHAL_writeToLog()

adiHalErr_t ADIHAL_writeToLog	(	void *	devHalInfo,
		adiLogLevel_t	logLevel,
		uint32_t	errorCode,
		const char *	comment
	)

Writes a character array to a log file to facilitate debugging.

This function uses the logLevel parameter to specify what type of message / warning / error to write to the log file. This function uses enums in adiLogLevel_t to set the log level.

The user implementation may choose to allow a feature to filter the level of message to log. This could allow only logging errors for instance.

Returns an error of type adiHalErr_t. Error returned will depend on platform specific implementation. API expects ADIHAL_OK if function completed successfully. Any other value represents an error or warning to the API. Error return list below provides possible errors from customer implementation.

Precondition: This function can be used at anytime once the required logging resources are opened by the ADIHAL_openHw() function call and not after ADIHAL_closeHW. The log level should also be set prior to calling this function via ADIHAL_setLogLevel.

Dependencies –Application and Platform Specific modules

Parameters

devHalInfo	Pointer to Platform HAL defined structure containing hardware settings describing the device of interest.
logLevel	The type of message to log. ADIHAL_LOG_MSG, ADIHAL_LOG_WARN, ADIHAL_LOG_ERR, ADIHAL_LOG_SPI,
errorCode	An error code value to designate a particular error
comment	The character array describing the error

Return values

ADIHAL_OK	if function completed successfully.
ADIHAL_GEN_SW	if device references is unknown.
ADIHAL_WARNING	if log message cannot be completed

Classes

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ DIV_ROUND_CLOSEST

◆ DIV_ROUND_CLOSEST_ULL

◆ DIV_S64

◆ DIV_U64

◆ HAL_SPIWRITEARRAY_BUFFERSIZE

◆ u16

Enumeration Type Documentation

◆ adiHalErr_t

◆ adiLogLevel_t

◆ sysrefReqMode_t

Function Documentation

◆ ADIHAL_closeHw()

◆ ADIHAL_openHw()

◆ ADIHAL_resetHw()

◆ ADIHAL_setLogLevel()

◆ ADIHAL_setTimeout()

◆ ADIHAL_spiReadByte()

◆ ADIHAL_spiReadBytes()

◆ ADIHAL_spiReadField()

◆ ADIHAL_spiWriteByte()

◆ ADIHAL_spiWriteBytes()

◆ ADIHAL_spiWriteField()

◆ ADIHAL_sysrefReq()

◆ ADIHAL_wait_us()

◆ ADIHAL_writeToLog()