General Functions

ADC APIs
adc_status_en	adc_init (adc_instance_en id)
	Initialize ADC instance and driver context.
adc_status_en	adc_deinit (adc_instance_en id)
	Deinitialize ADC instance and release resources.
adc_status_en	adc_config (adc_instance_en id, const adc_config_t *cfg)
	Apply ADC runtime configuration.
adc_status_en	adc_select_channel (adc_instance_en id, adc_channel_en channel)
	Select ADC input channel.
adc_status_en	adc_enable_interrupt (adc_instance_en id, uint32_t int_flags, bool enable)
	Enable or disable ADC interrupts.
adc_status_en	adc_get_interrupt_status (adc_instance_en id, uint32_t *status)
	Read ADC interrupt/status flags.
adc_status_en	adc_enable (adc_instance_en id)
	Enable ADC hardware block.
adc_status_en	adc_disable (adc_instance_en id)
	Disable ADC hardware block.
adc_status_en	adc_start_conversion (adc_instance_en id)
	Trigger ADC conversion sequence.
adc_status_en	adc_read (adc_instance_en id, uint16_t *result)
	Read latest ADC conversion result.
adc_status_en	adc_register_callback (adc_instance_en id, adc_event_cb_t cb, void *user_data)
	Register ADC ISR callback.
adc_status_en	adc_bist_configure (adc_instance_en id, const adc_bist_config_t *cfg)
	Configure ADC BIST parameters.
adc_status_en	adc_bist_start (adc_instance_en id)
	Start ADC BIST sequence.
adc_status_en	adc_bist_get_status (adc_instance_en id, bool *done, bool *fail)
	Poll ADC BIST completion and fail status.

adc_init()

Initializes ADC hardware for the selected instance.

Parameters:

• id: adc_instance_en instance identifier.

Return: adc_status_en status code.

Return values:

• ADC_OK: Initialization successful.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_BUSY: Instance already initialized.

adc_deinit()

Deinitializes ADC hardware and clears driver state.

Parameters:

• id: adc_instance_en instance identifier.

Return: adc_status_en status code.

Return values:

• ADC_OK: Deinitialization successful.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_config()

Programs conversion mode/type, clock divider, latency, and thresholds.

Parameters:

• id: adc_instance_en instance identifier.
• cfg: Pointer to ADC runtime configuration.

Return: adc_status_en status code.

Return values:

• ADC_OK: Configuration applied successfully.
• ADC_ERROR_PARAMETER: Invalid instance or NULL cfg pointer.
• ADC_ERROR_BUSY: ADC block is enabled; disable it first.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_select_channel()

Selects channel CH0..CH7 for subsequent conversions.

Parameters:

• id: adc_instance_en instance identifier.
• channel: ADC input channel to select.

Return: adc_status_en status code.

Return values:

• ADC_OK: Channel selected successfully.
• ADC_ERROR_PARAMETER: Invalid instance or channel identifier.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_enable_interrupt()

Configures interrupt enable state for ADC_INT_* flags.

Parameters:

• id: adc_instance_en instance identifier.
• int_flags: Bitmask of interrupt flags to update.
• enable: true to enable, false to disable selected interrupt flags.

Return: adc_status_en status code.

Return values:

• ADC_OK: Interrupt enable state updated.
• ADC_ERROR_PARAMETER: Invalid instance or unsupported interrupt flag combination.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_get_interrupt_status()

Returns ADC status register bits to the caller.

Parameters:

• id: adc_instance_en instance identifier.
• status: Pointer to receive ADC status bitmask.

Return: adc_status_en status code.

Return values:

• ADC_OK: Status read successfully.
• ADC_ERROR_PARAMETER: Invalid instance or NULL status pointer.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_enable()

Enables the ADC analog/digital control path.

Parameters:

• id: adc_instance_en instance identifier.

Return: adc_status_en status code.

Return values:

• ADC_OK: ADC block enabled successfully.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_disable()

Disables ADC and places block in low-power state.

Parameters:

• id: adc_instance_en instance identifier.

Return: adc_status_en status code.

Return values:

• ADC_OK: ADC block disabled successfully.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_start_conversion()

Starts single/continuous/window conversion flow.

Parameters:

• id: adc_instance_en instance identifier.

Return: adc_status_en status code.

Return values:

• ADC_OK: Conversion start triggered.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_NOT_READY: Instance not initialized or not enabled.

adc_read()

Reads 12-bit conversion value from ADC data register.

Parameters:

• id: adc_instance_en instance identifier.
• result: Pointer to receive 12-bit conversion result.

Return: adc_status_en status code.

Return values:

• ADC_OK: Result read successfully.
• ADC_ERROR_TIMEOUT: Polling mode timed out waiting for conversion completion.
• ADC_ERROR_PARAMETER: Invalid instance or NULL result pointer.
• ADC_ERROR_NOT_READY: Instance not initialized, not enabled, or no conversion completed yet.

adc_register_callback()

Registers user callback invoked from ADC ISR context.

Parameters:

• id: adc_instance_en instance identifier.
• cb: Callback function, or NULL to unregister.
• user_data: User context pointer passed to callback.

Return: adc_status_en status code.

Return values:

• ADC_OK: Callback registered or unregistered successfully.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_bist_configure()

Configures BIST min/max reference values.

Parameters:

• id: adc_instance_en instance identifier.
• cfg: Pointer to BIST configuration structure.

Return: adc_status_en status code.

Return values:

• ADC_OK: BIST parameters configured successfully.
• ADC_ERROR_PARAMETER: Invalid instance, NULL cfg pointer, or invalid bounds.
• ADC_ERROR_NOT_READY: Instance not initialized.

adc_bist_start()

Triggers ADC built-in self-test execution.

Parameters:

• id: adc_instance_en instance identifier.

Return: adc_status_en status code.

Return values:

• ADC_OK: BIST sequence started successfully.
• ADC_ERROR_BUSY: A BIST is already in progress.
• ADC_ERROR_PARAMETER: Invalid ADC instance identifier.
• ADC_ERROR_NOT_READY: Instance not initialized, BIST not configured, or ADC not enabled.

adc_bist_get_status()

Reads BIST done/fail indicators.

Parameters:

• id: adc_instance_en instance identifier.
• done: Pointer to receive completion flag.
• fail: Pointer to receive failure flag.

Return: adc_status_en status code.

Return values:

• ADC_OK: Status fields populated successfully.
• ADC_ERROR_PARAMETER: Invalid instance or NULL done/fail pointers.
• ADC_ERROR_NOT_READY: Instance not initialized.