can_corex_bus.h

Go to the documentation of this file.

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Author: Adrian Pietrzak
 * GitHub: https://github.com/AdrianPietrzak1998
 * Created: Apr 24, 2026
 */
 
#ifndef CAN_COREX_CAN_COREX_BUS_H_
#define CAN_COREX_CAN_COREX_BUS_H_
 
#if !defined(CAN_COREX_CAN_COREX_H_) && !defined(DOXYGEN)
#error "Include can_corex.h instead of can_corex_bus.h directly."
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif

 
    typedef struct
    {
        CCX_HR_TIME_t HighResDelay;
        CCX_TIME_t BaseDelay;
        uint8_t UsesHighRes;
    } CCX_BusRecoveryDelay_t;
 
#ifdef CCX_DISABLE_HIGH_RES_TIMEBASE
#define CCX_BUS_RECOVERY_MS(ms)                                                                                        \
    ((CCX_BusRecoveryDelay_t){.HighResDelay = 0U, .BaseDelay = (CCX_TIME_t)(ms), .UsesHighRes = 0U})
#define CCX_BUS_RECOVERY_US(us)                                                                                        \
    ((CCX_BusRecoveryDelay_t){                                                                                         \
        .HighResDelay = 0U, .BaseDelay = (CCX_TIME_t)CCX_INTERNAL_MS_FROM_US_CEIL(us), .UsesHighRes = 0U})
#else
#define CCX_BUS_RECOVERY_MS(ms)                                                                                        \
    ((CCX_BusRecoveryDelay_t){.HighResDelay = 0U, .BaseDelay = (CCX_TIME_t)(ms), .UsesHighRes = 0U})
#define CCX_BUS_RECOVERY_US(us)                                                                                        \
    ((CCX_BusRecoveryDelay_t){.HighResDelay = ((us) <= 3000U) ? CCX_HR_TIME(us) : 0U,                                  \
                              .BaseDelay = (CCX_TIME_t)CCX_INTERNAL_MS_FROM_US_CEIL(us),                               \
                              .UsesHighRes = (uint8_t)((us) <= 3000U)})
#endif
 
    /* ============================================================
     * ISO 11898-1 BUS-OFF recovery timing
     *
     * Condition:
     *   128 x 11 recessive bits = 1408 bits
     *
     * Classic CAN constants are expressed directly in milliseconds because they
     * do not benefit from the HR domain. Short recovery delays can still be
     * expressed through CCX_BUS_RECOVERY_US(us). Values up to 3 ms use the HR
     * timebase when available; longer values are tracked in the base time domain.
     * The _MS suffix is kept for API stability.
     * ============================================================ */
 
#define CAN_COREX_BUS_OFF_RECOVERY_10KBPS_MS CCX_BUS_RECOVERY_MS(141U)
#define CAN_COREX_BUS_OFF_RECOVERY_20KBPS_MS CCX_BUS_RECOVERY_MS(71U)
#define CAN_COREX_BUS_OFF_RECOVERY_50KBPS_MS CCX_BUS_RECOVERY_MS(29U)
#define CAN_COREX_BUS_OFF_RECOVERY_83K3BPS_MS CCX_BUS_RECOVERY_MS(17U)
#define CAN_COREX_BUS_OFF_RECOVERY_100KBPS_MS CCX_BUS_RECOVERY_MS(15U)
#define CAN_COREX_BUS_OFF_RECOVERY_125KBPS_MS CCX_BUS_RECOVERY_MS(12U)
#define CAN_COREX_BUS_OFF_RECOVERY_250KBPS_MS CCX_BUS_RECOVERY_MS(6U)
#define CAN_COREX_BUS_OFF_RECOVERY_500KBPS_MS CCX_BUS_RECOVERY_US(2816U)
#define CAN_COREX_BUS_OFF_RECOVERY_800KBPS_MS CCX_BUS_RECOVERY_US(1760U)
#define CAN_COREX_BUS_OFF_RECOVERY_1000KBPS_MS CCX_BUS_RECOVERY_US(1408U)
 
#if CCX_ENABLE_CANFD
#define CAN_COREX_BUS_OFF_RECOVERY_FD_2M_MS CCX_BUS_RECOVERY_US(704U)
#define CAN_COREX_BUS_OFF_RECOVERY_FD_5M_MS CCX_BUS_RECOVERY_US(282U)
#define CAN_COREX_BUS_OFF_RECOVERY_FD_8M_MS CCX_BUS_RECOVERY_US(176U)
#endif

    typedef enum
    {
        CCX_BUS_STATE_ACTIVE = 0,
        CCX_BUS_STATE_WARNING,
        CCX_BUS_STATE_PASSIVE,
        CCX_BUS_STATE_OFF
    } CCX_BusState_t;

    typedef struct
    {
        uint8_t TEC; 
        uint8_t REC; 
    } CCX_ErrorCounters_t;

    typedef struct
    {
        uint32_t bus_off_count;                  
        uint32_t error_warning_count;            
        uint32_t error_passive_count;            
        CCX_TIME_t last_bus_off_time;            
        CCX_TIME_t total_bus_off_duration;       
        CCX_ErrorCounters_t error_counters;      
        CCX_ErrorCounters_t peak_error_counters; 
    } CCX_BusStats_t;

    typedef struct
    {
        CCX_BusState_t current_state; 
        CCX_BusStats_t stats;         
 
        /* Recovery parameters */
        CCX_BusRecoveryDelay_t
            recovery_delay; 
        CCX_TIME_t successful_run_time; 
        uint8_t auto_recovery_enabled;  
        uint8_t max_recovery_attempts;  
        uint8_t recovery_attempts;      
 
        /* Internal state */
        CCX_TIME_t recovery_start_time; 
        CCX_HR_TIME_t
            recovery_start_time_hr; 
        CCX_TIME_t last_successful_recovery; 
        CCX_TIME_t bus_off_entry_time;       
        uint8_t in_grace_period;             
        CCX_TIME_t grace_period_start;       
 
        /* Hardware interface - user implements these */
        CCX_BusState_t (*GetBusState)(const CCX_instance_t *Instance); 
        void (*GetErrorCounters)(const CCX_instance_t *Instance,
                                 CCX_ErrorCounters_t *Counters); 
        void (*RequestRecovery)(const CCX_instance_t *Instance); 
 
        /* User callbacks */
        void (*OnBusStateChange)(CCX_instance_t *Instance, CCX_BusState_t OldState, CCX_BusState_t NewState,
                                 void *UserData); 
        void (*OnRecoveryAttempt)(CCX_instance_t *Instance, uint8_t AttemptNumber,
                                  void *UserData);                          
        void (*OnRecoveryFailed)(CCX_instance_t *Instance, void *UserData); 
        void (*OnErrorCountersUpdate)(CCX_instance_t *Instance, const CCX_ErrorCounters_t *Counters,
                                      void *UserData); 
        void *UserData;                                
    } CCX_BusMonitor_t;
 
    /* ========================================================================
     * BUS MONITORING API (v1.3.0)
     * ======================================================================== */
 
    CCX_Status_t CCX_BusMonitor_Init(CCX_instance_t *Instance, CCX_BusMonitor_t *Monitor,
                                     CCX_BusState_t (*GetBusState)(const CCX_instance_t *),
                                     void (*GetErrorCounters)(const CCX_instance_t *, CCX_ErrorCounters_t *),
                                     void (*RequestRecovery)(const CCX_instance_t *),
                                     CCX_BusRecoveryDelay_t recovery_delay, CCX_TIME_t successful_run_time,
                                     uint8_t auto_recovery_enabled, uint8_t max_recovery_attempts);
 
    CCX_Status_t CCX_BusMonitor_TriggerRecovery(CCX_instance_t *Instance);
    CCX_BusState_t CCX_BusMonitor_GetState(const CCX_instance_t *Instance);
    void CCX_BusMonitor_ResetStats(CCX_instance_t *Instance);

 
#ifdef __cplusplus
}
#endif
 
#endif /* CAN_COREX_CAN_COREX_BUS_H_ */