can1.h

Go to the documentation of this file.

 
/*
© [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 CAN1_H
#define CAN1_H
 
// Section: Included Files
 
#include <xc.h>
#include <stdbool.h>
#include <stdint.h>
#include "can_types.h"
#include "can_interface.h"
 
// Section: Data Type Definitions
 
extern const struct CAN_INTERFACE CAN_FD1;
#define CAN_FD1_Initialize CAN1_Initialize
#define CAN_FD1_Deinitialize CAN1_Deinitialize
#define CAN_FD1_OperationModeSet CAN1_OperationModeSet
#define CAN_FD1_OperationModeGet CAN1_OperationModeGet
#define CAN_FD1_Receive CAN1_Receive
#define CAN_FD1_ReceiveMessageGet CAN1_ReceiveMessageGet
#define CAN_FD1_RX_FIFO_StatusGet CAN1_RX_FIFO_StatusGet
#define CAN_FD1_Transmit CAN1_Transmit
#define CAN_FD1_TransmitFIFOStatusGet CAN1_TransmitFIFOStatusGet
#define CAN_FD1_IsBusOff CAN1_IsBusOff
#define CAN_FD1_IsTxErrorPassive CAN1_IsTxErrorPassive
#define CAN_FD1_IsTxErrorWarning CAN1_IsTxErrorWarning
#define CAN_FD1_IsTxErrorActive CAN1_IsTxErrorActive
#define CAN_FD1_IsRxErrorPassive CAN1_IsRxErrorPassive
#define CAN_FD1_IsRxErrorWarning CAN1_IsRxErrorWarning
#define CAN_FD1_IsRxErrorActive CAN1_IsRxErrorActive
#define CAN_FD1_Sleep CAN1_Sleep
#define CAN_FD1_ReceivedMessageCountGet CAN1_ReceivedMessageCountGet
#define CAN_FD1_Tasks CAN1_Tasks
#define CAN_FD1_InvalidMessageCallbackRegister CAN1_InvalidMessageCallbackRegister
#define CAN_FD1_BusWakeUpActivityCallbackRegister CAN1_BusWakeUpActivityCallbackRegister
#define CAN_FD1_BusErrorCallbackRegister CAN1_BusErrorCallbackRegister
#define CAN_FD1_ModeChangeCallbackRegister CAN1_ModeChangeCallbackRegister
#define CAN_FD1_SystemErrorCallbackRegister CAN1_SystemErrorCallbackRegister
#define CAN_FD1_TxAttemptCallbackRegister CAN1_TxAttemptCallbackRegister
#define CAN_FD1_RxBufferOverFlowCallbackRegister CAN1_RxBufferOverFlowCallbackRegister
 
 
#define CAN1_TX_TXQ   CAN1_TXQ   
#define CAN1_RX_FIFO1   CAN1_FIFO_1   
enum CAN1_TX_FIFO_CHANNELS
{
    CAN1_TXQ = 0,   
}; 
 
enum CAN1_RX_FIFO_CHANNELS
{
    CAN1_FIFO_1 = 1,  
};
 
// Section: CAN1 Module APIs
 
void CAN1_Initialize(void);
 
void CAN1_Deinitialize(void);
 
enum CAN_OP_MODE_STATUS CAN1_OperationModeSet(const enum CAN_OP_MODES requestMode);
 
enum CAN_OP_MODES CAN1_OperationModeGet(void);
 
bool CAN1_Receive(struct CAN_MSG_OBJ *rxCanMsg);
 
bool CAN1_ReceiveMessageGet(const enum CAN1_RX_FIFO_CHANNELS fifoChannel, struct CAN_MSG_OBJ *rxCanMsg);
 
enum CAN_TX_MSG_REQUEST_STATUS CAN1_Transmit(const enum CAN1_TX_FIFO_CHANNELS fifoChannel, struct CAN_MSG_OBJ *txCanMsg);
 
enum CAN_TX_FIFO_STATUS CAN1_TransmitFIFOStatusGet(const enum CAN1_TX_FIFO_CHANNELS fifoChannel);
 
bool CAN1_IsBusOff(void);
 
bool CAN1_IsTxErrorPassive(void);
 
bool CAN1_IsTxErrorWarning(void);
 
bool CAN1_IsTxErrorActive(void);
 
bool CAN1_IsRxErrorPassive(void);
 
bool CAN1_IsRxErrorWarning(void);
 
bool CAN1_IsRxErrorActive(void);
 
void CAN1_Sleep(void);
 
uint8_t CAN1_ReceivedMessageCountGet(void);
 
uint8_t CAN1_RX_FIFO_StatusGet(const enum CAN1_RX_FIFO_CHANNELS fifoNum);
 
void CAN1_Tasks(void);
 
void CAN1_InvalidMessageCallbackRegister(void (*handler)(void));
 
void CAN1_InvalidMessageCallback(void);
 
void CAN1_BusWakeUpActivityCallbackRegister(void (*handler)(void));
 
void CAN1_BusWakeUpActivityCallback(void);
 
void CAN1_BusErrorCallbackRegister(void (*handler)(void));
 
void CAN1_BusErrorCallback(void);
 
void CAN1_ModeChangeCallbackRegister(void (*handler)(void));
 
void CAN1_ModeChangeCallback(void);
 
void CAN1_SystemErrorCallbackRegister(void (*handler)(void));
 
void CAN1_SystemErrorCallback(void);
 
void CAN1_TxAttemptCallbackRegister(void (*handler)(void));
 
void CAN1_TxAttemptCallback(void);
 
void CAN1_RxBufferOverFlowCallbackRegister(void (*handler)(void));
 
void CAN1_RxBufferOverFlowCallback(void);
#endif  //_CAN1_H