Functions

FC APIs
fc_status_en	fc_init (fc_instance_en id)
fc_status_en	fc_deinit (fc_instance_en id)
fc_status_en	fc_config_fault (fc_instance_en id, const fc_fault_config_t *cfg)
fc_status_en	fc_config_interrupt (fc_instance_en id, const fc_intr_config_t *cfg)
fc_status_en	fc_clear_interrupt (fc_instance_en id, uint32_t mask)
fc_status_en	fc_get_interrupt_status (fc_instance_en id, uint32_t *status)
fc_status_en	fc_set_interrupt_timeout (fc_instance_en id, uint16_t timeout)
fc_status_en	fc_set_trigger_pulse_width (fc_instance_en id, uint16_t width)
fc_status_en	fc_set_reset_pulse_width (fc_instance_en id, uint16_t width)
fc_status_en	fc_config_timing (fc_instance_en id, const fc_timing_config_t *cfg)
fc_status_en	fc_set_fault_association (fc_instance_en id, fc_assoc_type_en type, uint8_t assoc_id, const fc_fault_assoc_t *assoc)
fc_status_en	fc_get_fault_association (fc_instance_en id, fc_assoc_type_en type, uint8_t assoc_id, fc_fault_assoc_t *assoc)
fc_status_en	fc_erase_log (fc_instance_en id)
fc_status_en	fc_write_sw_log (fc_instance_en id, uint32_t value)
fc_status_en	fc_get_log_count (fc_instance_en id, uint16_t *count)
fc_status_en	fc_read_log (fc_instance_en id, uint16_t index, fc_log_entry_t *entry)
fc_status_en	fc_read_logs (fc_instance_en id, fc_log_entry_t *entries, uint16_t max_entries, uint16_t *read_count)
fc_status_en	fc_register_callback (fc_instance_en id, fc_event_cb_t cb, void *user_data)
fc_status_en	fc_isr (fc_instance_en id)

fc_init()

Initialize FC driver instance and SoC-level FC hardware.

Parameters:

• id: fc_instance_en instance identifier.

Return: fc_status_en status code.

Return values:

• FC_OK: Initialization successful.
• FC_ERROR_PARAMETER: Invalid FC instance identifier.
• FC_ERROR_BUSY: Instance already initialized.
• FC_ERROR: SoC-level initialization failed.

fc_deinit()

Deinitialize FC driver instance and disable FC resources.

Parameters:

• id: fc_instance_en instance identifier.

Return: fc_status_en status code.

Return values:

• FC_OK: Deinitialization successful, or instance already deinitialized.
• FC_ERROR_PARAMETER: Invalid FC instance identifier.

fc_config_fault()

Configure one FC fault input source type and logging mask.

Parameters:

• id: fc_instance_en instance identifier.
• cfg: Pointer to fc_fault_config_t.

Return: fc_status_en status code.

Return values:

• FC_OK: Fault configuration applied successfully.
• FC_ERROR_PARAMETER: Invalid instance, NULL cfg, invalid fault ID, or invalid fault type.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_config_interrupt()

Configure one FC interrupt output.

Parameters:

• id: fc_instance_en instance identifier.
• cfg: Pointer to fc_intr_config_t.

Return: fc_status_en status code.

Return values:

• FC_OK: Interrupt configuration applied successfully.
• FC_ERROR_PARAMETER: Invalid instance, NULL cfg, invalid interrupt ID, or invalid interrupt type.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_clear_interrupt()

Clear selected FC interrupt status bits.

Parameters:

• id: fc_instance_en instance identifier.
• mask: Interrupt status bitmask to clear.

Return: fc_status_en status code.

Return values:

• FC_OK: Interrupt status cleared successfully.
• FC_ERROR_PARAMETER: Invalid instance or invalid bits in mask.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_get_interrupt_status()

Read FC interrupt status register value.

Parameters:

• id: fc_instance_en instance identifier.
• status: Pointer to receive interrupt status value.

Return: fc_status_en status code.

Return values:

• FC_OK: Interrupt status read successfully.
• FC_ERROR_PARAMETER: Invalid instance or NULL status pointer.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_set_interrupt_timeout()

Set FC interrupt timeout clear counter value.

Parameters:

• id: fc_instance_en instance identifier.
• timeout: 12-bit timeout value.

Return: fc_status_en status code.

Return values:

• FC_OK: Timeout configured successfully.
• FC_ERROR_PARAMETER: Invalid instance or timeout out of 12-bit range.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_set_trigger_pulse_width()

Set FC trigger output pulse width value.

Parameters:

• id: fc_instance_en instance identifier.
• width: 12-bit trigger pulse width value.

Return: fc_status_en status code.

Return values:

• FC_OK: Trigger pulse width configured successfully.
• FC_ERROR_PARAMETER: Invalid instance or width out of 12-bit range.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_set_reset_pulse_width()

Set FC reset output pulse width value.

Parameters:

• id: fc_instance_en instance identifier.
• width: 12-bit reset pulse width value.

Return: fc_status_en status code.

Return values:

• FC_OK: Reset pulse width configured successfully.
• FC_ERROR_PARAMETER: Invalid instance or width out of 12-bit range.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_config_timing()

Configure one FC timing control field.

Parameters:

• id: fc_instance_en instance identifier.
• cfg: Pointer to fc_timing_config_t.

Return: fc_status_en status code.

Return values:

• FC_OK: Timing control configured successfully.
• FC_ERROR_PARAMETER: Invalid instance, NULL cfg, invalid timing type, or value out of 12-bit range.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_set_fault_association()

Program fault routing table for interrupt, trigger, or reset output.

Parameters:

• id: fc_instance_en instance identifier.
• type: fc_assoc_type_en association table selector.
• assoc_id: Selected output index in the chosen association table type.
• assoc: Pointer to fc_fault_assoc_t bitmap content.

Return: fc_status_en status code.

Return values:

• FC_OK: Association table programmed successfully.
• FC_ERROR_PARAMETER: Invalid instance, invalid type/index combination, or NULL assoc.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_get_fault_association()

Read fault routing table for interrupt, trigger, or reset output.

Parameters:

• id: fc_instance_en instance identifier.
• type: fc_assoc_type_en association table selector.
• assoc_id: Selected output index in the chosen association table type.
• assoc: Pointer to fc_fault_assoc_t receiver buffer.

Return: fc_status_en status code.

Return values:

• FC_OK: Association table read successfully.
• FC_ERROR_PARAMETER: Invalid instance, invalid type/index combination, or NULL assoc.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_erase_log()

Erase FC hardware fault log array and reset write pointer.

Parameters:

• id: fc_instance_en instance identifier.

Return: fc_status_en status code.

Return values:

• FC_OK: Logs erased successfully.
• FC_ERROR_PARAMETER: Invalid FC instance identifier.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_write_sw_log()

Write one software log ID to FC software log register.

Parameters:

• id: fc_instance_en instance identifier.
• value: Software log value in accepted FC range.

Return: fc_status_en status code.

Return values:

• FC_OK: Software log value written successfully.
• FC_ERROR_PARAMETER: Invalid instance or value outside accepted software log range.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_get_log_count()

Get number of currently retained FC fault log entries.

Parameters:

• id: fc_instance_en instance identifier.
• count: Pointer to receive retained log count.

Return: fc_status_en status code.

Return values:

• FC_OK: Log count read successfully.
• FC_ERROR_PARAMETER: Invalid instance or NULL count pointer.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_read_log()

Read one FC log entry by index.

Parameters:

• id: fc_instance_en instance identifier.
• index: Log index in hardware fault log array.
• entry: Pointer to fc_log_entry_t receiver.

Return: fc_status_en status code.

Return values:

• FC_OK: Log entry read successfully.
• FC_ERROR_PARAMETER: Invalid instance, NULL entry, or out-of-range index.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_read_logs()

Read multiple FC log entries in chronological order from oldest retained log.

Parameters:

• id: fc_instance_en instance identifier.
• entries: Output array of fc_log_entry_t.
• max_entries: Maximum entries to read into entries.
• read_count: Pointer to receive number of entries actually read.

Return: fc_status_en status code.

Return values:

• FC_OK: Log entries read successfully.
• FC_ERROR_PARAMETER: Invalid instance, NULL read_count, or NULL entries when max_entries is nonzero.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_register_callback()

Register or clear FC interrupt callback handler.

Parameters:

• id: fc_instance_en instance identifier.
• cb: fc_event_cb_t callback, or NULL to disable callback notification.
• user_data: User context pointer passed to callback.

Return: fc_status_en status code.

Return values:

• FC_OK: Callback registration updated successfully.
• FC_ERROR_PARAMETER: Invalid FC instance identifier.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.

fc_isr()

FC interrupt service routine helper.

Parameters:

• id: fc_instance_en instance identifier.

Return: fc_status_en status code.

Return values:

• FC_OK: ISR handled successfully.
• FC_ERROR_PARAMETER: Invalid FC instance identifier.
• FC_ERROR_NOT_INITIALIZED: Instance not initialized.