can_interface.h

 
/*
� [2024] Microchip Technology Inc. and its subsidiaries.
 
    Subject to your compliance with these terms, you may use Microchip 
    software and any derivatives exclusively with Microchip products. 
    You are responsible for complying with 3rd party license terms  
    applicable to your use of 3rd party software (including open source  
    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
    THIS SOFTWARE.
*/
 
#ifndef CAN_INTERFACE_H
#define CAN_INTERFACE_H
 
// Section: Included Files
 
#include <stdbool.h>
#include <stdint.h>
#include "can_types.h"
 
// Section: Data Type Definitions     
 
struct CAN_INTERFACE
{   
    void (*Initialize)(void);                                                                               
    
    void (*Deinitialize)(void);                                                                             
    
    enum CAN_OP_MODE_STATUS (*OperationModeSet)(const enum CAN_OP_MODES requestMode);                       
    
    enum CAN_OP_MODES (*OperationModeGet)(void);                                                            
    
    void (*SleepMode)(void);                                                                                
    
    bool (*IsBusOff)(void);                                                                                 
                             
    enum CAN_TX_MSG_REQUEST_STATUS (*Transmit)(const unsigned fifoChannel, struct CAN_MSG_OBJ *txCanMsg);   
    
    enum CAN_TX_FIFO_STATUS (*TransmitFIFOStatusGet)(const unsigned fifoChannel);                           
    
    bool (*IsTxErrorPassive)(void);                                                                         
    
    bool (*IsTxErrorWarning)(void);                                                                         
    
    bool (*IsTxErrorActive)(void);                                                                          
                                                                                                                                      
    bool (*Receive)(struct CAN_MSG_OBJ *rxCanMsg);                                                          
    
    bool (*ReceiveMessageGet)(const unsigned fifoChannel, struct CAN_MSG_OBJ *rxCanMsg);                    
    
    bool (*IsRxErrorPassive)(void);                                                                         
    
    bool (*IsRxErrorWarning)(void);                                                                         
    
    bool (*IsRxErrorActive)(void);                                                                          
    
    uint8_t (*ReceivedMessageCountGet)(void);                                                               
    
    uint8_t (*RX_FIFO_StatusGet)(const unsigned fifoNum);                                                               
 
    void (*InvalidMessageCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*BusWakeUpActivityCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*BusErrorCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*ModeChangeCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*SystemErrorCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*TxAttemptCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*RxBufferOverFlowCallbackRegister)(void (*CallbackHandler)(void));                               
 
    void (*Tasks)(void);                                                                                    
};
 
#endif