Hardware Abstraction Layer (HAL)
Implementation Specific Types

General Description

The following types are used by the HAL, but are defined by the implementation.

As a result, the types can, and need to, be used in the application but the contents can not. It is not safe to rely on how the type is defined. In addition to changing between implementations of the HAL, they may also change between versions of a single implementation.

Typedefs

typedef void * cyhal_adc_t
 ADC instance object for use with the ADC driver. More...
 
typedef void * cyhal_adc_channel_t
 ADC channel instance object for use with the ADC driver. More...
 
typedef void * cyhal_comp_t
 Comparator instance object for use with the Comparator driver. More...
 
typedef void * cyhal_crc_t
 CRC instance object for use with the CRC driver. More...
 
typedef void * cyhal_dac_t
 DAC instance object for use with the DAC driver. More...
 
typedef void * cyhal_dma_t
 DMA instance object for use with the DMA driver. More...
 
typedef void * cyhal_nvm_t
 Flash instance object for use with the NVM memory driver. More...
 
typedef void * cyhal_gpio_t
 GPIO instance object for use with all peripheral drivers using pins. More...
 
typedef void * cyhal_i2c_t
 I2C instance object for use with the I2C driver. More...
 
typedef void * cyhal_i2s_t
 I2S instance object for use with the I2S driver. More...
 
typedef void * cyhal_lptimer_t
 LPTIMER instance object for use with the Low Power Timer driver. More...
 
typedef void * cyhal_opamp_t
 OpAmp instance object for use with the OpAmp driver. More...
 
typedef void * cyhal_pwm_t
 PWM instance object for use with the PWM driver. More...
 
typedef void * cyhal_qspi_t
 QSPI instance object for use with the Quad SPI driver. More...
 
typedef void * cyhal_trng_t
 TRNG instance object for use with the True Random Number Generator driver. More...
 
typedef void * cyhal_rtc_t
 RTC instance object for use with the Real Time Clock driver. More...
 
typedef void * cyhal_sdhc_t
 SDHC instance object for use with the SDHC driver. More...
 
typedef void * cyhal_sdio_t
 SDIO instance object for use with the SDIO driver. More...
 
typedef void * cyhal_spi_t
 SPI instance object for use with the SPI driver. More...
 
typedef void * cyhal_timer_t
 Timer instance object for use with the Timer driver. More...
 
typedef void * cyhal_uart_t
 UART instance object for use with the UART driver. More...
 
typedef void * cyhal_usb_dev_t
 USB Device instance object for use with the USB driver. More...
 
typedef void * cy_stc_syspm_callback_t
 Callback data for use with the System Sleep and Deepsleep APIs. More...
 
typedef void * cyhal_clock_t
 Clock type for use with the peripheral drivers. More...
 
typedef uint32_t cyhal_source_t
 Routable signal source. More...
 
typedef uint32_t cyhal_dest_t
 Routable signal destination. More...
 

Typedef Documentation

◆ cyhal_adc_t

typedef void* cyhal_adc_t

ADC instance object for use with the ADC driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_adc_channel_t

typedef void* cyhal_adc_channel_t

ADC channel instance object for use with the ADC driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_comp_t

typedef void* cyhal_comp_t

Comparator instance object for use with the Comparator driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_crc_t

typedef void* cyhal_crc_t

CRC instance object for use with the CRC driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_dac_t

typedef void* cyhal_dac_t

DAC instance object for use with the DAC driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_dma_t

typedef void* cyhal_dma_t

DMA instance object for use with the DMA driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_nvm_t

typedef void* cyhal_nvm_t

Flash instance object for use with the NVM memory driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_gpio_t

typedef void* cyhal_gpio_t

GPIO instance object for use with all peripheral drivers using pins.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_i2c_t

typedef void* cyhal_i2c_t

I2C instance object for use with the I2C driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_i2s_t

typedef void* cyhal_i2s_t

I2S instance object for use with the I2S driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_lptimer_t

typedef void* cyhal_lptimer_t

LPTIMER instance object for use with the Low Power Timer driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_opamp_t

typedef void* cyhal_opamp_t

OpAmp instance object for use with the OpAmp driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_pwm_t

typedef void* cyhal_pwm_t

PWM instance object for use with the PWM driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_qspi_t

typedef void* cyhal_qspi_t

QSPI instance object for use with the Quad SPI driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_trng_t

typedef void* cyhal_trng_t

TRNG instance object for use with the True Random Number Generator driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_rtc_t

typedef void* cyhal_rtc_t

RTC instance object for use with the Real Time Clock driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_sdhc_t

typedef void* cyhal_sdhc_t

SDHC instance object for use with the SDHC driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_sdio_t

typedef void* cyhal_sdio_t

SDIO instance object for use with the SDIO driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_spi_t

typedef void* cyhal_spi_t

SPI instance object for use with the SPI driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_timer_t

typedef void* cyhal_timer_t

Timer instance object for use with the Timer driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_uart_t

typedef void* cyhal_uart_t

UART instance object for use with the UART driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_usb_dev_t

typedef void* cyhal_usb_dev_t

USB Device instance object for use with the USB driver.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cy_stc_syspm_callback_t

typedef void* cy_stc_syspm_callback_t

Callback data for use with the System Sleep and Deepsleep APIs.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_clock_t

typedef void* cyhal_clock_t

Clock type for use with the peripheral drivers.

Application code should not rely on the specific contents of this struct. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_source_t

typedef uint32_t cyhal_source_t

Routable signal source.

Application code should not rely on the specific contents of this enum. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.

◆ cyhal_dest_t

typedef uint32_t cyhal_dest_t

Routable signal destination.

Application code should not rely on the specific contents of this enum. They are considered an implementation detail which is subject to change between platforms and/or HAL releases.