embeddedsw/XilinxProcessorIPLib/drivers/canfd/src/xcanfd_intr.c
Nava kishore Manne 607a6324f3 Drivers: Retain @details only in the primary header file.
Removed all other instances.

Signed-off-by: Nava kishore Manne <navam@xilinx.com>
2015-07-13 18:30:19 +05:30

598 lines
19 KiB
C

/******************************************************************************
*
* Copyright (C) 2015 Xilinx, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* Use of the Software is limited solely to applications:
* (a) running on a Xilinx device, or
* (b) that interact with a Xilinx device through a bus or interconnect.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* XILINX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Except as contained in this notice, the name of the Xilinx shall not be used
* in advertising or otherwise to promote the sale, use or other dealings in
* this Software without prior written authorization from Xilinx.
*
******************************************************************************/
/*****************************************************************************/
/**
*
* @file xcanfd_intr.c
* @addtogroup canfd_v1_0
* @{
*
* This file contains functions related to CAN interrupt handling.
*
* <pre>
* MODIFICATION HISTORY:
*
* Ver Who Date Changes
* ----- ---- --------- -------------------------------------------------------
* 1.0 nsk 06/04/15 First release
* 1.0 nsk 16/06/15 Updated XCanFd_IntrHandler() since RTL has
* changed. RTL Changes,Added new bits to MSR,SR,ISR,
* IER,ICR Registers and modified TS2 bits in
* BTR and F_SJW bits in F_BTR Registers.
* </pre>
*
******************************************************************************/
/***************************** Include Files *********************************/
#include "xcanfd.h"
/************************** Constant Definitions *****************************/
/**************************** Type Definitions *******************************/
/***************** Macros (Inline Functions) Definitions *********************/
/************************** Variable Definitions *****************************/
/************************** Function Prototypes ******************************/
/****************************************************************************/
/**
*
* This routine enables interrupt(s). Use the XCANFD_IXR_* constants defined in
* xcanfd_hw.h to create the bit-mask to enable interrupts.
*
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to enable. Bit positions of 1 will be enabled.
* Bit positions of 0 will keep the previous setting. This mask is
* formed by OR'ing XCANFD_IXR_* bits defined in xcanfd_hw.h.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptEnable(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_InterruptGetEnabled(InstancePtr);
IntrValue |= Mask & XCANFD_IXR_ALL;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress, XCANFD_IER_OFFSET,
IntrValue);
}
/****************************************************************************/
/**
*
* This routine sets the Rx Full threshold in the Watermark Interrupt Register.
*
* @param InstancePtr is a pointer to the XCanFd instance.
* @param Threshold is the threshold to be set. The valid values are
* from 1 to 63.
*
* @return - XST_FAILURE - If the CAN device is not in Configuration Mode.
* - XST_SUCCESS - If the Rx Full threshold is set in Watermark
* Interrupt Register.
*
* @note The threshold can only be set when the CAN device is in the
* configuration mode.
*
*****************************************************************************/
u32 XCanFd_SetRxIntrWatermark(XCanFd *InstancePtr, u8 Threshold)
{
u32 ThrReg;
s32 Status;
Xil_AssertNonvoid(InstancePtr != NULL);
Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
Xil_AssertNonvoid((Threshold > 0) || (Threshold <= (u8)31));
if (XCanFd_GetMode(InstancePtr) != (u8)XCANFD_MODE_CONFIG) {
Status = XST_FAILURE;
}
else {
ThrReg = XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_WIR_OFFSET);
Threshold &= XCANFD_WIR_MASK;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_WIR_OFFSET,Threshold);
Status = XST_SUCCESS;
}
return Status;
}
/****************************************************************************/
/**
*
* This routine enables TxBuffer Ready Request interrupt(s).
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to enable. Bit positions of 1 will be enabled.
* Bit positions of 0 will keep the previous setting. This mask is
* formed by OR'ing XCANFD_IETRS_OFFSET* bits defined in xcanfd_hw.h.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptEnable_ReadyRqt(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETRS_OFFSET);
IntrValue |= Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETRS_OFFSET, IntrValue);
}
/****************************************************************************/
/**
*
* This routine enables TxBuffer Cancellation interrupt(s).
*
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to enable. Bit positions of 1 will be enabled.
* Bit positions of 0 will keep the previous setting. This mask is
* formed by OR'ing XCANFD_IETCS_OFFSET* bits defined in xcanfd_hw.h.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptEnable_CancelRqt(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETCS_OFFSET);
IntrValue |= Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETCS_OFFSET, IntrValue);
}
/****************************************************************************/
/**
*
* This routine disables TxBuffer Ready Request interrupt(s).
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to disable. Bit positions of 1 will be
* disabled. Bit positions of 0 will keep the previous setting.
* This mask is formed by AND'ing XCANFD_IETRS_OFFSET* bits
* defined in xcanfd_hw.h.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptDisable_ReadyRqt(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETRS_OFFSET);
IntrValue &= ~Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETRS_OFFSET, IntrValue);
}
/****************************************************************************/
/**
*
* This routine disables the TxBuffer Cancel Request interrupt(s).
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to disable. Bit positions of 1 will be
* disabled. Bit positions of 0 will keep the previous setting.
* This mask is formed by AND'ing XCANFD_IETCS_OFFSET* bits defined in
* xcanfd_hw.h.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptDisable_CancelRqt(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETCS_OFFSET);
IntrValue &= ~Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress, \
XCANFD_IETCS_OFFSET, IntrValue);
}
/****************************************************************************/
/**
*
* This routine Enables the RxBuffer Full interrupt(s) in MailBox Mode.
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to disable. Bit positions of 1 will be
* disabled. Bit positions of 0 will keep the previous setting.
* This mask is formed by AND'ing XCANFD_RXBFLL*_OFFSET bits
* defined in xcanfd_hw.h.
* @param RxBuffNumber has two values
* if 0 -> Access RxBufferFull0 Reg
* else -> Access RxBufferFull1 Reg
*
* @return None.
*
* @note None.
*
****************************************************************************/
void XCanFd_InterruptEnable_RxBuffFull(XCanFd *InstancePtr,
u32 Mask,u32 RxBuffNumber)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
if ((RxBuffNumber == 0)) {
IntrValue = XCanFd_ReadReg(
InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL1_OFFSET);
IntrValue |= Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL1_OFFSET, IntrValue);
}
else {
IntrValue = XCanFd_ReadReg(
InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL2_OFFSET);
IntrValue |= Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL2_OFFSET, IntrValue);
}
}
/****************************************************************************/
/**
*
* This routine disables the RxBuffer Full interrupt(s) in MailBox Mode.
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to disable. Bit positions of 1 will be
* disabled. Bit positions of 0 will keep the previous setting.
* This mask is formed by AND'ing XCANFD_RXBFLL*_OFFSET bits
* defined in xcanfd_hw.h.
*
*@param RxBuffNumber has two values
* if 0 -> Access RxBufferFull0 Reg.
* else -> Access RxBufferFull1 Reg.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptDisable_RxBuffFull(XCanFd *InstancePtr,
u32 Mask,u32 RxBuffNumber)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
if ((RxBuffNumber == 0)) {
IntrValue =
XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL1_OFFSET);
IntrValue &= ~Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL1_OFFSET, IntrValue);
}
else {
IntrValue =
XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL2_OFFSET);
IntrValue &= ~Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_RXBFLL2_OFFSET, IntrValue);
}
}
/****************************************************************************/
/**
*
* This routine disables interrupt(s). Use the XCANFD_IXR_* constants defined in
* xcanfd_hw.h to create the bit-mask to disable interrupt(s).
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to disable. Bit positions of 1 will be
* disabled. Bit positions of 0 will keep the previous setting.
* This mask is formed by OR'ing XCANFD_IXR_* bits defined in
* xcanfd_hw.h.
*
* @return None.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptDisable(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_InterruptGetEnabled(InstancePtr);
IntrValue &= ~Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_IER_OFFSET, IntrValue);
}
/****************************************************************************/
/**
*
* This function clears interrupt(s). Every bit set in Interrupt Status
* Register indicates that a specific type of interrupt is occurring, and this
* function clears one or more interrupts by writing a bit mask to Interrupt
* Clear Register.
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param Mask is the mask to clear. Bit positions of 1 will be cleared.
* Bit positions of 0 will not change the previous interrupt
* status. This mask is formed by OR'ing XCANFD_IXR_* bits defined
* in xcanfd_hw.h.
*
* @note None.
*
*****************************************************************************/
void XCanFd_InterruptClear(XCanFd *InstancePtr, u32 Mask)
{
u32 IntrValue;
Xil_AssertVoid(InstancePtr != NULL);
Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
IntrValue = XCanFd_InterruptGetStatus(InstancePtr);
IntrValue &= Mask;
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_ICR_OFFSET, IntrValue);
}
/*****************************************************************************/
/**
*
* This routine is the interrupt handler for the CAN driver.
*
* This handler reads the interrupt status from the ISR, determines the source of
* the interrupts, calls according callbacks, and finally clears the interrupts.
*
* Application beyond this driver is responsible for providing callbacks to
* handle interrupts and installing the callbacks using XCanFd_SetHandler() during
* initialization phase. An example delivered with this driver demonstrates how
* this could be done.
*
* @param InstancePtr is a pointer to the XCanFd instance that just
* interrupted.
*
* @return None.
*
* @note None.
*
******************************************************************************/
void XCanFd_IntrHandler(void *InstancePtr)
{
u32 PendingIntr, EventIntr, ErrorStatus;
XCanFd *CanPtr = (XCanFd *) InstancePtr;
Xil_AssertVoid(CanPtr != NULL);
Xil_AssertVoid(CanPtr->IsReady == XIL_COMPONENT_IS_READY);
/* Get pending interrupts */
PendingIntr = XCanFd_InterruptGetStatus(CanPtr);
PendingIntr &= XCanFd_InterruptGetEnabled(CanPtr);
/* An error interrupt is occurring */
if ((PendingIntr & XCANFD_IXR_ERROR_MASK)) {
ErrorStatus = XCanFd_GetBusErrorStatus(CanPtr);
CanPtr->ErrorHandler(CanPtr->ErrorRef, ErrorStatus);
/* Clear Error Status Register */
XCanFd_ClearBusErrorStatus(CanPtr, ErrorStatus);
}
/*
* Check if any following event interrupt is pending:
* - RX FIFO Overflow
* - RX FIFO Underflow
* - Rx Match Not Finished
* - Rx Buffer Overflow for Buffer Index(Mail Box)
* - Transmit Cancelation Request served
* - Transmit Ready Request Served
* - Wake up from sleep mode
* - Rx Buffer Full(Mail Box)
* - TX FIFO Full
* - Enter sleep mode
* - Enter Bus off status
* - Arbitration is lost
* - Protocol Exception Event
*
* If so, call event callback provided by upper level.
*/
EventIntr = PendingIntr & (XCANFD_IXR_RXBOFLW_BI_MASK |
XCANFD_IXR_RXMNF_MASK |
XCANFD_IXR_RXBOFLW_MASK |
XCANFD_IXR_TXCRS_MASK | XCANFD_IXR_TXRRS_MASK |
XCANFD_IXR_WKUP_MASK |
XCANFD_IXR_SLP_MASK | XCANFD_IXR_BSOFF_MASK |
XCANFD_IXR_RXFOFLW_MASK | XCANFD_IXR_ARBLST_MASK |
XCANFD_IXR_RXRBF_MASK |
XCANFD_IXR_PEE_MASK |
XCANFD_IXR_BSRD_MASK);
if (EventIntr) {
CanPtr->EventHandler(CanPtr->EventRef, EventIntr);
}
/*
* A frame was received and is sitting in RX FIFO.
*
* XCANFD_IXR_RXOK_MASK is used because the bit is set when a frame
* is sit in the buffer
*
* XCANFD_IXR_RXFWMFLL_MASK is used because the bit can be set
* when configured level of frames are set
*
* XCANFD_IXR_RXRBF_MASK is used because the bit is set in MAIL BOX Mode
* when a message is received and becomes FULL.
*/
if ((PendingIntr & (XCANFD_IXR_RXFWMFLL_MASK | XCANFD_IXR_RXOK_MASK \
| XCANFD_IXR_RXRBF_MASK ))) {
CanPtr->RecvHandler(CanPtr->RecvRef);
}
/* A frame was transmitted successfully */
if ((PendingIntr & XCANFD_IXR_TXOK_MASK)) {
CanPtr->SendHandler(CanPtr->SendRef);
}
/* Clear all pending interrupts */
XCanFd_InterruptClear(CanPtr, PendingIntr);
}
/*****************************************************************************/
/**
*
* This routine installs an asynchronous callback function for the given
* HandlerType:
*
* <pre>
* HandlerType Callback Function Type
* ----------------------- ---------------------------
* XCANFD_HANDLER_SEND XCanFd_SendRecvHandler
* XCANFD_HANDLER_RECV XCanFd_SendRecvHandler
* XCANFD_HANDLER_ERROR XCanFd_ErrorHandler
* XCANFD_HANDLER_EVENT XCanFd_EventHandler
*
* HandlerType Invoked by this driver when:
* ----------------------- --------------------------------------------------
* XCANFD_HANDLER_SEND A frame transmitted by a call to
* XCanFd_Send() has been sent successfully.
*
* XCANFD_HANDLER_RECV A frame has been received and is sitting in
* the RX FIFO.
*
* XCANFD_HANDLER_ERROR An error interrupt is occurring.
*
* XCANFD_HANDLER_EVENT Any other kind of interrupt is occurring.
* </pre>
*
* @param InstancePtr is a pointer to the XCanFd instance to be worked on.
* @param HandlerType specifies which handler is to be attached.
* @param CallBackFunc is the address of the callback function.
* @param CallBackRef is a user data item that will be passed to the
* callback function when it is invoked.
*
* @return - XST_SUCCESS when handler is installed.
* - XST_INVALID_PARAM when HandlerType is invalid.
*
* @note Invoking this function for a handler that already has been
* installed replaces it with the new handler.
*
******************************************************************************/
int XCanFd_SetHandler(XCanFd *InstancePtr, u32 HandlerType,
void *CallBackFunc, void *CallBackRef)
{
Xil_AssertNonvoid(InstancePtr != NULL);
Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
switch (HandlerType) {
case XCANFD_HANDLER_SEND:
InstancePtr->SendHandler = (XCanFd_SendRecvHandler) CallBackFunc;
InstancePtr->SendRef = CallBackRef;
break;
case XCANFD_HANDLER_RECV:
InstancePtr->RecvHandler = (XCanFd_SendRecvHandler) CallBackFunc;
InstancePtr->RecvRef = CallBackRef;
break;
case XCANFD_HANDLER_ERROR:
InstancePtr->ErrorHandler = (XCanFd_ErrorHandler) CallBackFunc;
InstancePtr->ErrorRef = CallBackRef;
break;
case XCANFD_HANDLER_EVENT:
InstancePtr->EventHandler = (XCanFd_EventHandler) CallBackFunc;
InstancePtr->EventRef = CallBackRef;
break;
default:
return (XST_INVALID_PARAM);
}
return (XST_SUCCESS);
}
/** @} */