/* mcp_can.cpp 2012 Copyright (c) Seeed Technology Inc. All right reserved. 2017 Copyright (c) Cory J. Fowler All Rights Reserved. Author: Loovee Contributor: Cory J. Fowler 2017-09-25 This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110- 1301 USA */ #include "mcp_can.h" #define spi_readwrite SPI.transfer #define spi_read() spi_readwrite(0x00) /********************************************************************************************************* ** Function name: mcp2515_reset ** Descriptions: Performs a software reset *********************************************************************************************************/ void MCP_CAN::mcp2515_reset(void) { SPI.beginTransaction(SPISettings(10000000, MSBFIRST, SPI_MODE0)); MCP2515_SELECT(); spi_readwrite(MCP_RESET); MCP2515_UNSELECT(); SPI.endTransaction(); delayMicroseconds(10); } /********************************************************************************************************* ** Function name: mcp2515_readRegister ** Descriptions: Read data register *********************************************************************************************************/ INT8U MCP_CAN::mcp2515_readRegister(const INT8U address) { INT8U ret; SPI.beginTransaction(SPISettings(10000000, MSBFIRST, SPI_MODE0)); MCP2515_SELECT(); spi_readwrite(MCP_READ); spi_readwrite(address); ret = spi_read(); MCP2515_UNSELECT(); SPI.endTransaction(); return ret; } /********************************************************************************************************* ** Function name: mcp2515_readRegisterS ** Descriptions: Reads sucessive data registers *********************************************************************************************************/ void MCP_CAN::mcp2515_readRegisterS(const INT8U address, INT8U values[], const INT8U n) { INT8U i; SPI.beginTransaction(SPISettings(10000000, MSBFIRST, SPI_MODE0)); MCP2515_SELECT(); spi_readwrite(MCP_READ); spi_readwrite(address); // mcp2515 has auto-increment of address-pointer for (i=0; i TXBnD7 */ a1 = MCP_TXB0CTRL; a2 = MCP_TXB1CTRL; a3 = MCP_TXB2CTRL; for (i = 0; i < 14; i++) { /* in-buffer loop */ mcp2515_setRegister(a1, 0); mcp2515_setRegister(a2, 0); mcp2515_setRegister(a3, 0); a1++; a2++; a3++; } mcp2515_setRegister(MCP_RXB0CTRL, 0); mcp2515_setRegister(MCP_RXB1CTRL, 0); } /********************************************************************************************************* ** Function name: mcp2515_init ** Descriptions: Initialize the controller *********************************************************************************************************/ INT8U MCP_CAN::mcp2515_init(const INT8U canIDMode, const INT8U canSpeed, const INT8U canClock) { INT8U res; mcp2515_reset(); mcpMode = MCP_LOOPBACK; res = mcp2515_setCANCTRL_Mode(MODE_CONFIG); if(res > 0) { #if DEBUG_MODE Serial.print(F("Entering Configuration Mode Failure...\r\n")); #endif return res; } #if DEBUG_MODE Serial.print(F("Entering Configuration Mode Successful!\r\n")); #endif // Set Baudrate if(mcp2515_configRate(canSpeed, canClock)) { #if DEBUG_MODE Serial.print(F("Setting Baudrate Failure...\r\n")); #endif return res; } #if DEBUG_MODE Serial.print(F("Setting Baudrate Successful!\r\n")); #endif if ( res == MCP2515_OK ) { /* init canbuffers */ mcp2515_initCANBuffers(); /* interrupt mode */ mcp2515_setRegister(MCP_CANINTE, MCP_RX0IF | MCP_RX1IF); //Sets BF pins as GPO mcp2515_setRegister(MCP_BFPCTRL,MCP_BxBFS_MASK | MCP_BxBFE_MASK); //Sets RTS pins as GPI mcp2515_setRegister(MCP_TXRTSCTRL,0x00); switch(canIDMode) { case (MCP_ANY): mcp2515_modifyRegister(MCP_RXB0CTRL, MCP_RXB_RX_MASK | MCP_RXB_BUKT_MASK, MCP_RXB_RX_ANY | MCP_RXB_BUKT_MASK); mcp2515_modifyRegister(MCP_RXB1CTRL, MCP_RXB_RX_MASK, MCP_RXB_RX_ANY); break; /* The followingn two functions of the MCP2515 do not work, there is a bug in the silicon. case (MCP_STD): mcp2515_modifyRegister(MCP_RXB0CTRL, MCP_RXB_RX_MASK | MCP_RXB_BUKT_MASK, MCP_RXB_RX_STD | MCP_RXB_BUKT_MASK ); mcp2515_modifyRegister(MCP_RXB1CTRL, MCP_RXB_RX_MASK, MCP_RXB_RX_STD); break; case (MCP_EXT): mcp2515_modifyRegister(MCP_RXB0CTRL, MCP_RXB_RX_MASK | MCP_RXB_BUKT_MASK, MCP_RXB_RX_EXT | MCP_RXB_BUKT_MASK ); mcp2515_modifyRegister(MCP_RXB1CTRL, MCP_RXB_RX_MASK, MCP_RXB_RX_EXT); break; */ case (MCP_STDEXT): mcp2515_modifyRegister(MCP_RXB0CTRL, MCP_RXB_RX_MASK | MCP_RXB_BUKT_MASK, MCP_RXB_RX_STDEXT | MCP_RXB_BUKT_MASK ); mcp2515_modifyRegister(MCP_RXB1CTRL, MCP_RXB_RX_MASK, MCP_RXB_RX_STDEXT); break; default: #if DEBUG_MODE Serial.print(F("`Setting ID Mode Failure...\r\n")); #endif return MCP2515_FAIL; break; } res = mcp2515_setCANCTRL_Mode(mcpMode); if(res) { #if DEBUG_MODE Serial.print(F("Returning to Previous Mode Failure...\r\n")); #endif return res; } } return res; } /********************************************************************************************************* ** Function name: mcp2515_write_id ** Descriptions: Write CAN ID *********************************************************************************************************/ void MCP_CAN::mcp2515_write_id( const INT8U mcp_addr, const INT8U ext, const INT32U id ) { uint16_t canid; INT8U tbufdata[4]; canid = (uint16_t)(id & 0x0FFFF); if ( ext == 1) { tbufdata[MCP_EID0] = (INT8U) (canid & 0xFF); tbufdata[MCP_EID8] = (INT8U) (canid >> 8); canid = (uint16_t)(id >> 16); tbufdata[MCP_SIDL] = (INT8U) (canid & 0x03); tbufdata[MCP_SIDL] += (INT8U) ((canid & 0x1C) << 3); tbufdata[MCP_SIDL] |= MCP_TXB_EXIDE_M; tbufdata[MCP_SIDH] = (INT8U) (canid >> 5 ); } else { tbufdata[MCP_SIDH] = (INT8U) (canid >> 3 ); tbufdata[MCP_SIDL] = (INT8U) ((canid & 0x07 ) << 5); tbufdata[MCP_EID0] = 0; tbufdata[MCP_EID8] = 0; } mcp2515_setRegisterS( mcp_addr, tbufdata, 4 ); } /********************************************************************************************************* ** Function name: mcp2515_write_mf ** Descriptions: Write Masks and Filters *********************************************************************************************************/ void MCP_CAN::mcp2515_write_mf( const INT8U mcp_addr, const INT8U ext, const INT32U id ) { uint16_t canid; INT8U tbufdata[4]; canid = (uint16_t)(id & 0x0FFFF); if ( ext == 1) { tbufdata[MCP_EID0] = (INT8U) (canid & 0xFF); tbufdata[MCP_EID8] = (INT8U) (canid >> 8); canid = (uint16_t)(id >> 16); tbufdata[MCP_SIDL] = (INT8U) (canid & 0x03); tbufdata[MCP_SIDL] += (INT8U) ((canid & 0x1C) << 3); tbufdata[MCP_SIDL] |= MCP_TXB_EXIDE_M; tbufdata[MCP_SIDH] = (INT8U) (canid >> 5 ); } else { tbufdata[MCP_EID0] = (INT8U) (canid & 0xFF); tbufdata[MCP_EID8] = (INT8U) (canid >> 8); canid = (uint16_t)(id >> 16); tbufdata[MCP_SIDL] = (INT8U) ((canid & 0x07) << 5); tbufdata[MCP_SIDH] = (INT8U) (canid >> 3 ); } mcp2515_setRegisterS( mcp_addr, tbufdata, 4 ); } /********************************************************************************************************* ** Function name: mcp2515_read_id ** Descriptions: Read CAN ID *********************************************************************************************************/ void MCP_CAN::mcp2515_read_id( const INT8U mcp_addr, INT8U* ext, INT32U* id ) { INT8U tbufdata[4]; *ext = 0; *id = 0; mcp2515_readRegisterS( mcp_addr, tbufdata, 4 ); *id = (tbufdata[MCP_SIDH]<<3) + (tbufdata[MCP_SIDL]>>5); if ( (tbufdata[MCP_SIDL] & MCP_TXB_EXIDE_M) == MCP_TXB_EXIDE_M ) { /* extended id */ *id = (*id<<2) + (tbufdata[MCP_SIDL] & 0x03); *id = (*id<<8) + tbufdata[MCP_EID8]; *id = (*id<<8) + tbufdata[MCP_EID0]; *ext = 1; } } /********************************************************************************************************* ** Function name: mcp2515_write_canMsg ** Descriptions: Write message *********************************************************************************************************/ void MCP_CAN::mcp2515_write_canMsg( const INT8U buffer_sidh_addr) { INT8U mcp_addr; mcp_addr = buffer_sidh_addr; mcp2515_setRegisterS(mcp_addr+5, m_nDta, m_nDlc ); /* write data bytes */ if ( m_nRtr == 1) /* if RTR set bit in byte */ m_nDlc |= MCP_RTR_MASK; mcp2515_setRegister((mcp_addr+4), m_nDlc ); /* write the RTR and DLC */ mcp2515_write_id(mcp_addr, m_nExtFlg, m_nID ); /* write CAN id */ } /********************************************************************************************************* ** Function name: mcp2515_read_canMsg ** Descriptions: Read message *********************************************************************************************************/ void MCP_CAN::mcp2515_read_canMsg( const INT8U buffer_sidh_addr) /* read can msg */ { INT8U mcp_addr, ctrl; mcp_addr = buffer_sidh_addr; mcp2515_read_id( mcp_addr, &m_nExtFlg,&m_nID ); ctrl = mcp2515_readRegister( mcp_addr-1 ); m_nDlc = mcp2515_readRegister( mcp_addr+4 ); if (ctrl & 0x08) m_nRtr = 1; else m_nRtr = 0; m_nDlc &= MCP_DLC_MASK; mcp2515_readRegisterS( mcp_addr+5, &(m_nDta[0]), m_nDlc ); } /********************************************************************************************************* ** Function name: mcp2515_getNextFreeTXBuf ** Descriptions: Send message *********************************************************************************************************/ INT8U MCP_CAN::mcp2515_getNextFreeTXBuf(INT8U *txbuf_n) /* get Next free txbuf */ { INT8U res, i, ctrlval; INT8U ctrlregs[MCP_N_TXBUFFERS] = { MCP_TXB0CTRL, MCP_TXB1CTRL, MCP_TXB2CTRL }; res = MCP_ALLTXBUSY; *txbuf_n = 0x00; /* check all 3 TX-Buffers */ for (i=0; i 0){ #if DEBUG_MODE Serial.print(F("Entering Configuration Mode Failure...\r\n")); #endif return res; } if (num == 0){ mcp2515_write_mf(MCP_RXM0SIDH, ext, ulData); } else if(num == 1){ mcp2515_write_mf(MCP_RXM1SIDH, ext, ulData); } else res = MCP2515_FAIL; res = mcp2515_setCANCTRL_Mode(mcpMode); if(res > 0){ #if DEBUG_MODE Serial.print(F("Entering Previous Mode Failure...\r\nSetting Mask Failure...\r\n")); #endif return res; } #if DEBUG_MODE Serial.print(F("Setting Mask Successful!\r\n")); #endif return res; } /********************************************************************************************************* ** Function name: init_Mask ** Descriptions: Public function to set mask(s). *********************************************************************************************************/ INT8U MCP_CAN::init_Mask(INT8U num, INT32U ulData) { INT8U res = MCP2515_OK; INT8U ext = 0; #if DEBUG_MODE Serial.print(F("Starting to Set Mask!\r\n")); #endif res = mcp2515_setCANCTRL_Mode(MODE_CONFIG); if(res > 0){ #if DEBUG_MODE Serial.print(F("Entering Configuration Mode Failure...\r\n")); #endif return res; } if((num & 0x80000000) == 0x80000000) ext = 1; if (num == 0){ mcp2515_write_mf(MCP_RXM0SIDH, ext, ulData); } else if(num == 1){ mcp2515_write_mf(MCP_RXM1SIDH, ext, ulData); } else res = MCP2515_FAIL; res = mcp2515_setCANCTRL_Mode(mcpMode); if(res > 0){ #if DEBUG_MODE Serial.print(F("Entering Previous Mode Failure...\r\nSetting Mask Failure...\r\n")); #endif return res; } #if DEBUG_MODE Serial.print(F("Setting Mask Successful!\r\n")); #endif return res; } /********************************************************************************************************* ** Function name: init_Filt ** Descriptions: Public function to set filter(s). *********************************************************************************************************/ INT8U MCP_CAN::init_Filt(INT8U num, INT8U ext, INT32U ulData) { INT8U res = MCP2515_OK; #if DEBUG_MODE Serial.print(F("Starting to Set Filter!\r\n")); #endif res = mcp2515_setCANCTRL_Mode(MODE_CONFIG); if(res > 0) { #if DEBUG_MODE Serial.print(F("Enter Configuration Mode Failure...\r\n")); #endif return res; } switch( num ) { case 0: mcp2515_write_mf(MCP_RXF0SIDH, ext, ulData); break; case 1: mcp2515_write_mf(MCP_RXF1SIDH, ext, ulData); break; case 2: mcp2515_write_mf(MCP_RXF2SIDH, ext, ulData); break; case 3: mcp2515_write_mf(MCP_RXF3SIDH, ext, ulData); break; case 4: mcp2515_write_mf(MCP_RXF4SIDH, ext, ulData); break; case 5: mcp2515_write_mf(MCP_RXF5SIDH, ext, ulData); break; default: res = MCP2515_FAIL; } res = mcp2515_setCANCTRL_Mode(mcpMode); if(res > 0) { #if DEBUG_MODE Serial.print(F("Entering Previous Mode Failure...\r\nSetting Filter Failure...\r\n")); #endif return res; } #if DEBUG_MODE Serial.print(F("Setting Filter Successfull!\r\n")); #endif return res; } /********************************************************************************************************* ** Function name: init_Filt ** Descriptions: Public function to set filter(s). *********************************************************************************************************/ INT8U MCP_CAN::init_Filt(INT8U num, INT32U ulData) { INT8U res = MCP2515_OK; INT8U ext = 0; #if DEBUG_MODE Serial.print(F("Starting to Set Filter!\r\n")); #endif res = mcp2515_setCANCTRL_Mode(MODE_CONFIG); if(res > 0) { #if DEBUG_MODE Serial.print(F("Enter Configuration Mode Failure...\r\n")); #endif return res; } if((num & 0x80000000) == 0x80000000) ext = 1; switch( num ) { case 0: mcp2515_write_mf(MCP_RXF0SIDH, ext, ulData); break; case 1: mcp2515_write_mf(MCP_RXF1SIDH, ext, ulData); break; case 2: mcp2515_write_mf(MCP_RXF2SIDH, ext, ulData); break; case 3: mcp2515_write_mf(MCP_RXF3SIDH, ext, ulData); break; case 4: mcp2515_write_mf(MCP_RXF4SIDH, ext, ulData); break; case 5: mcp2515_write_mf(MCP_RXF5SIDH, ext, ulData); break; default: res = MCP2515_FAIL; } res = mcp2515_setCANCTRL_Mode(mcpMode); if(res > 0) { #if DEBUG_MODE Serial.print(F("Entering Previous Mode Failure...\r\nSetting Filter Failure...\r\n")); #endif return res; } #if DEBUG_MODE Serial.print(F("Setting Filter Successfull!\r\n")); #endif return res; } /********************************************************************************************************* ** Function name: setMsg ** Descriptions: Set can message, such as dlc, id, dta[] and so on *********************************************************************************************************/ INT8U MCP_CAN::setMsg(INT32U id, INT8U rtr, INT8U ext, INT8U len, const INT8U *pData) { int i = 0; m_nID = id; m_nRtr = rtr; m_nExtFlg = ext; m_nDlc = len; for(i = 0; i> 3); } /********************************************************************************************************* END FILE *********************************************************************************************************/