Deprecated

group group_hal_impl_deprecated

The following CAT1 specific items have been deprecated and replaced by more generic items.

Each item will continue to work for now, but will be removed in a future release. All deprecated items reference the item that replaces it.

Defines

CYHAL_SYSTEM_RSLT_ERROR

An error occurred in System module.

CYHAL_SYSTEM_RSLT_INVALID_CLK_DIVIDER

An error occurred in System module.

CYHAL_SYSTEM_RSLT_UNABLE_TO_SET_CLK_FREQ

An error occurred in System module.

CYHAL_SYSTEM_RSLT_SRC_CLK_DISABLED

An error occurred in System module.

CYHAL_SYSTEM_RSLT_NO_VALID_DIVIDER

An error occurred in System module.

cyhal_system_sleep()

Attempts to put the device to sleep until an interrupt wakes it up.

warning

This function is deprecated. Use cyhal_syspm_sleep instead.

cyhal_system_deepsleep()

Attempts to put the device into deep sleep until an interrupt wakes it up.

warning

This function is deprecated. Use cyhal_syspm_deepsleep instead.

CYHAL_SDIO_RET_NO_ERRORS

No error.

CYHAL_SDIO_RET_NO_SP_ERRORS

Non-specific error code.

CYHAL_SDIO_RET_CMD_CRC_ERROR

There was a CRC error on the Command/Response.

CYHAL_SDIO_RET_CMD_IDX_ERROR

The index for the command didn’t match.

CYHAL_SDIO_RET_CMD_EB_ERROR

There was an end bit error on the command.

CYHAL_SDIO_RET_DAT_CRC_ERROR

There was a data CRC Error.

CYHAL_SDIO_RET_CMD_TIMEOUT

The command didn’t finish before the timeout period was over.

CYHAL_SDIO_RET_DAT_TIMEOUT

The data didn’t finish before the timeout period was over.

CYHAL_SDIO_RET_RESP_FLAG_ERROR

There was an error in the resposne flag for command 53.

CYHAL_SDIO_CLOCK_ERROR

Failed to initial clock for SDIO.

CYHAL_SDIO_BAD_ARGUMENT

Bad argument passed for SDIO.

CYHAL_SDIO_SEMA_NOT_INITED

Semaphore is not initiated.

CYHAL_SDIO_FUNC_NOT_SUPPORTED

Function is not supported.

CYHAL_SDIO_CANCELED

Operation canceled.

CYHAL_SDIO_PM_PENDING_ERROR

Transfer cannot be initiated after power mode transition allowed.

CYHAL_SDIO_RSLT_ERR_SEMA_NOT_INITED

Semaphore not initiated error define.

CYHAL_SDIO_RSLT_ERR_FUNC_RET(retVal)

Error define based on SDIO lower function return value.

CYHAL_SDIO_RSLT_ERR_CLOCK

Clock initialization error define.

CYHAL_SDHC_CARD_INTERRUPT

SDHC CARD INTERRUPT event (The synchronized value of the DAT[1] interrupt input for SD mode)

CYHAL_SDHC_ASYNC_READ_COMPLETE

SDHC Asynchronous read operation is complete event (CYHAL_SDHC_XFER_COMPLETE is used instead)

CYHAL_SDHC_ASYNC_WRITE_COMPLETE

SDHC Asynchronous write operation is complete event (CYHAL_SDHC_XFER_COMPLETE is used instead)

Typedefs

typedef cy_en_divider_types_t cyhal_clock_divider_types_t

Available clock divider types.

warning

This type is deprecated. Use cyhal_clock_block_t instead.

typedef uint16_t cyhal_system_divider_t

Divider for CM4, CM0 and Peri clock.

Supports values between [1, 256]

warning

This type is deprecated. Use cyhal_clock_t instead.

typedef cyhal_clock_t cyhal_clock_divider_t

Peripheral clock divider type.

warning

This type is deprecated. Use cyhal_clock_t instead.

Enums

enum cyhal_system_clock_t

cyhal_system_clock_t: Enum for clock type to configure.

HFCLKs are configured using different APIs and does not using this enum.

warning

This type is deprecated. Use cyhal_clock_block_t instead.

Values:

enumerator CYHAL_SYSTEM_CLOCK_CM4
enumerator CYHAL_SYSTEM_CLOCK_CM0
enumerator CYHAL_SYSTEM_CLOCK_PERI

Functions

cy_rslt_t cyhal_hwmgr_allocate_clock(cyhal_clock_divider_t *obj, cyhal_clock_divider_types_t div, bool accept_larger)

Allocate (pick and reserve) an Clock Divider resource and provide a reference to it.

warning

This function is deprecated. Use cyhal_clock_allocate() instead.

Return

The status of the reserve request

Parameters
  • [out] obj: The resource object that was allocated

  • [in] div: The type of divider to allocate

  • [in] accept_larger: Whether a larger type can be provided if there are none of the requested size available

void cyhal_hwmgr_free_clock(cyhal_clock_divider_t *obj)

Free the specified Clock Divider resource and allow it be used by something else.

warning

This function is deprecated. Use cyhal_clock_free() instead.

Parameters
  • [in] obj: The resource object that was allocated

cy_rslt_t cyhal_system_clock_get_frequency(uint8_t clock, uint32_t *frequency_hz)

Gets the specified clock’s current frequency.

warning

This function is deprecated. Use cyhal_clock_get_frequency() instead.

Return

The status of the get_frequency request

Parameters
  • [in] clock: ID of clock to configure

  • [out] frequency_hz: The frequency the clock is currently running at

cy_rslt_t cyhal_system_clock_set_frequency(uint8_t clock, uint32_t frequency_hz)

Sets the specified clock’s frequency and enables it.

This will turn on any additional clocks needed to drive this.

warning

This function is deprecated. Use cyhal_clock_set_frequency() instead.

Return

The status of the set_frequency request

Parameters
  • [in] clock: ID of clock to configure

  • [in] frequency_hz: The frequency to run the clock at

cy_rslt_t cyhal_system_clock_set_divider(cyhal_system_clock_t clock, cyhal_system_divider_t divider)

Divides the clock frequency by the divider.

warning

This function is deprecated. Use cyhal_clock_set_divider() instead.

Return

The status of the set_divider request

Parameters
  • [in] clock: The clock to configure divider value for

  • [in] divider: The divider value to divide the frequency by

cy_rslt_t cyhal_system_register_callback(cyhal_system_callback_t *callback)

Register the specified handler with the power manager to be notified of power state changes.

warning

This function is deprecated. Use cyhal_syspm_register_callback() instead.

Return

The status of the register_callback request

Parameters
  • [in] callback: The callback configuration data

cy_rslt_t cyhal_system_unregister_callback(cyhal_system_callback_t const *callback)

Removes the registered handler from the power manager so no future notifications are made.

warning

This function is deprecated. Use cyhal_syspm_unregister_callback() instead.

Return

The status of the unregister_callback request

Parameters
  • [in] callback: The callback configuration data

cy_rslt_t cyhal_adc_channel_init(cyhal_adc_channel_t *obj, cyhal_adc_t *adc, cyhal_gpio_t pin)

Initialize a single-ended ADC channel.

warning

This function is deprecated. Use cyhal_adc_channel_init_diff() instead with CYHAL_ADC_VNEG specified for the vminus argument.

Configures the pin used by ADC.

Return

The status of the init request. The status of the init request. On failure, a problem specific error code will be returned. This error could be from the HAL or lower level driver.

For all other return codes, please refer to device driver documentation available in the BSP landing page

Parameters
  • [out] obj: The adc channel object to initialize

  • [in] adc: The adc for which the channel should be initialized

  • [in] pin: The adc pin name