Result Codes

General Description

HAL specific return codes definitions for all drivers.

HAL drivers are generally built on top of a lower level driver. In this case the errors returned from the HAL could be one of the values below or a value from that lower level driver. See the device specific documentation for details about the other error codes. The HAL uses the same CY_RSLT_CREATE macro to define result codes using the standard cy_rslt_t format. All HAL results use the module ID CY_RSLT_MODULE_ABSTRACTION_HAL. Driver distinction is done as part of the 16-bit code field. The HAL splits this into individual bytes. The upper byte signifies the HAL driver using values from the mtb_hal_rslt_module_chip enum. The lower byte is defined by each HAL driver.

API Reference
	Clock HAL Results
	Clock specific return codes.
	GPIO HAL Results
	GPIO specific return codes.
	LPTimer HAL Results
	LPTimer specific return codes.
	MemorySPI HAL Results
	MemorySPI specific return codes.
	NVM HAL Results
	NVM specific return codes.
	SPI HAL Results
	SPI specific return codes.
	SYSPM HAL Results
	SYSPM specific return codes.
	SYSTEM HAL Results
	SYSTEM specific return codes.
	UART HAL Results
	UART specific return codes.

Enumerations
enum	mtb_hal_rslt_module_chip {   MTB_HAL_RSLT_MODULE_ADC = (0x01) ,   MTB_HAL_RSLT_MODULE_CLOCK = (0x02) ,   MTB_HAL_RSLT_MODULE_COMP = (0x03) ,   MTB_HAL_RSLT_MODULE_CORDIC = (0x04) ,   MTB_HAL_RSLT_MODULE_DMA = (0x05) ,   MTB_HAL_RSLT_MODULE_GPIO = (0x06) ,   MTB_HAL_RSLT_MODULE_I2C = (0x07) ,   MTB_HAL_RSLT_MODULE_IPC = (0x08) ,   MTB_HAL_RSLT_MODULE_LPTIMER = (0x09) ,   MTB_HAL_RSLT_MODULE_MEMORYSPI = (0x0A) ,   MTB_HAL_RSLT_MODULE_NPNZ = (0x0B) ,   MTB_HAL_RSLT_MODULE_NVM = (0x0C) ,   MTB_HAL_RSLT_MODULE_PWM = (0x0D) ,   MTB_HAL_RSLT_MODULE_RTC = (0x0E) ,   MTB_HAL_RSLT_MODULE_SDHC = (0x0F) ,   MTB_HAL_RSLT_MODULE_SDIO = (0x10) ,   MTB_HAL_RSLT_MODULE_SPI = (0x11) ,   MTB_HAL_RSLT_MODULE_SYSPM = (0x12) ,   MTB_HAL_RSLT_MODULE_SYSTEM = (0x13) ,   MTB_HAL_RSLT_MODULE_TIMER = (0x14) ,   MTB_HAL_RSLT_MODULE_TRNG = (0x15) ,   MTB_HAL_RSLT_MODULE_UART = (0x16) }
	Enum to specify module IDs for cy_rslt_t values returned from the HAL. More...

Enumeration Type Documentation

mtb_hal_rslt_module_chip

enum mtb_hal_rslt_module_chip

Enum to specify module IDs for cy_rslt_t values returned from the HAL.

Enumerator
MTB_HAL_RSLT_MODULE_ADC	An error occurred in ADC module.
MTB_HAL_RSLT_MODULE_CLOCK	An error occurred in Clock module.
MTB_HAL_RSLT_MODULE_COMP	An error occurred in comparator module.
MTB_HAL_RSLT_MODULE_CORDIC	An error occurred in CORDIC module.
MTB_HAL_RSLT_MODULE_DMA	An error occurred in DMA module.
MTB_HAL_RSLT_MODULE_GPIO	An error occurred in GPIO module.
MTB_HAL_RSLT_MODULE_I2C	An error occurred in I2C module.
MTB_HAL_RSLT_MODULE_IPC	An error occurred in IPC module module.
MTB_HAL_RSLT_MODULE_LPTIMER	An error occurred in LPTimer module.
MTB_HAL_RSLT_MODULE_MEMORYSPI	An error occurred in MEMORYSPI module.
MTB_HAL_RSLT_MODULE_NPNZ	An error occurred in Filter module.
MTB_HAL_RSLT_MODULE_NVM	An error occurred in NVM module.
MTB_HAL_RSLT_MODULE_PWM	An error occurred in PWM module.
MTB_HAL_RSLT_MODULE_RTC	An error occurred in RTC module.
MTB_HAL_RSLT_MODULE_SDHC	An error occurred in SDHC module.
MTB_HAL_RSLT_MODULE_SDIO	An error occurred in SDIO module.
MTB_HAL_RSLT_MODULE_SPI	An error occurred in SPI module.
MTB_HAL_RSLT_MODULE_SYSPM	An error occurred in SysPM module.
MTB_HAL_RSLT_MODULE_SYSTEM	An error occurred in System module.
MTB_HAL_RSLT_MODULE_TIMER	An error occurred in Timer module.
MTB_HAL_RSLT_MODULE_TRNG	An error occurred in TRNG module.
MTB_HAL_RSLT_MODULE_UART	An error occurred in UART module.