hangpersonal/TI_C2000_F28377S_FreeRTOS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update repo

Browse Source
This commit is contained in:
hangpersonal
2026-08-30 23:04:35 -07:00
parent 749dab5721
commit ce65a0f59a
14950 changed files with 4408250 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
C2000Ware/utilities/spifsi/c2000/spifsi_spi.c
+89
View File
@@ -0,0 +1,89 @@
//#############################################################################
//
// FILE: spifsi_spi.c
//
// TITLE: SPI to FSI communication user-specific file
//
//! \addtogroup spifsi_communication
//
//
//#############################################################################
//
//
//
// C2000Ware v5.04.00.00
//
// Copyright (C) 2024 Texas Instruments Incorporated - http://www.ti.com/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the
// distribution.
//
// Neither the name of Texas Instruments Incorporated nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// $
//#############################################################################
#include "spifsi_spi.h"
//*****************************************************************************
//
// SPIFSI_calcCrc8 - calculate CRC8 by either using VCU or not.
//
//*****************************************************************************
#ifdef VCU_CRC
uint16_t SPIFSI_calcCRC8(uint32_t input_crc8_accum, uint16_t *msg, uint16_t parity, uint16_t rxLen) {
return((uint16_t) getCRC8_vcu(input_crc8_accum, msg, (CRC_parity_e)parity, rxLen));
}
#else
uint16_t SPIFSI_calcCRC8(uint32_t input_crc8_accum, uint16_t *msg, uint16_t parity, uint16_t rxLen) {
//
// Build CRC struct.
//
CRC_Obj crcObj;
crcObj.seedValue = input_crc8_accum;
crcObj.numBytes = rxLen;
crcObj.parity = (CRC_Parity) parity;
crcObj.msgBuffer = msg;
//
// Point to CRC struct.
//
CRC_Handle hndCRC = &crcObj;
//
// Calculate.
//
CRC_calculate(hndCRC);
return(hndCRC->crcResult);
}
#endif
//
// End of File
//
C2000Ware/utilities/spifsi/c2000/spifsi_spi.h
+281
View File
@@ -0,0 +1,281 @@
//#############################################################################
//
// FILE: spifsi_spi.h
//
// TITLE: SPI to FSI communication user-specific header file
//
//! \addtogroup spifsi_communication
//
//
//#############################################################################
//
//
//
// C2000Ware v5.04.00.00
//
// Copyright (C) 2024 Texas Instruments Incorporated - http://www.ti.com/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the
// distribution.
//
// Neither the name of Texas Instruments Incorporated nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// $
//#############################################################################
#ifndef SPIFSI_SPI_H_
#define SPIFSI_SPI_H_
//
// Include vcu crc.
//
#ifdef VCU_CRC
#include "vcu0_crc.h"
#endif
#include <stdint.h>
#include <stdbool.h>
#include "driverlib.h"
//*****************************************************************************
//
//! \brief reads 16-bit word.
//!
//! \param base is base address of SPI.
//! \param data16 is a pointer to 16-bit word.
//!
//! This function reads 16-bit word from SPI and assigns the word to *data16.
//! If any error occurs during reading, this function returns one of
//! \b SPIFSI_error enum type, \b SPIFSI_NO_ERROR otherwise.
//!
//! \note The actual function call of reading does not need to be blockingFIFO
//! call, it can be switched out to any SPI 16-bit read.
//!
//! \return If there is an error while reading, it returns one of the listed
//! \b SPIFSI_error enum type, \b SPIFSI_READ_ERROR inexample. Otherwise, it
//! returns \b SPIFSI_NO_ERROR.
//
//*****************************************************************************
static inline uint16_t SPI_write16Bits(uint32_t base, uint16_t *data16)
{
SPI_writeDataBlockingFIFO(base, *data16);
//
//return SPIFSI_WRITE_ERROR;
//
return(0U);
}
//*****************************************************************************
//
//! \brief writes 16-bit word.
//!
//! \param base is base address of SPI.
//! \param data16 is a word to be written.
//!
//! This function writes 16-bit word, data16, to SPI. If any error occurs
//! during reading, this function returns one of \b SPIFSI_error enum type,
//! \b SPIFSI_NO_ERROR otherwise.
//!
//! \note The actual function call of writing does not need to be blockingFIFO
//! call, it can be switched out to any SPI 16-bit write.
//!
//! \return If there is an error while writing, it returns one of the listed
//! \b SPIFSI_error enum type, \b SPIFSI_WRITE_ERROR inexample. Otherwise, it
//! returns \b SPIFSI_NO_ERROR.
//
//*****************************************************************************
static inline uint16_t SPI_read16Bits(uint32_t base, uint16_t *data16)
{
*data16 = SPI_readDataBlockingFIFO(base);
//
//return SPIFSI_READ_ERROR;
//
return(0U);
}
//*****************************************************************************
//
//! \brief returns calculated 8-bit CRC
//!
//! \param input_crc8_accum The seed value for the CRC, in the event of a
//! multi-part message, the result of the previous crc8
//! can be used as the initial value for the current
//! segment crc8 calculation until the final crc is derived.
//! \param msg Address of the message buffer
//! \param parity Parity of the first message word. The parity determines whether
//! the CRC begins at the low byte (CRC_parity_even) or at the high
//! byte (CRC_parity_odd) of the first word determines whether the
//! CRC begins at the low byte (EVEN) or at the high byte (ODD).
//! \param rxLen Length of the message in bytes
//!
//! \return CRC result
//
//*****************************************************************************
extern uint16_t SPIFSI_calcCRC8(uint32_t input_crc8_accum, uint16_t *msg, uint16_t parity, uint16_t rxLen);
//
// Non-VCU CRC
//
#ifndef VCU_CRC
//
// Typedefs
//
//! \brief Parity enumeration
//!
//! The parity is used by the CRC algorithm to determine whether to begin
//! calculations from the low byte (EVEN) or from the high byte (ODD) of the
//! first word (16-bit) in the message. \n
//! For example, if your message had 10 bytes and started at the address 0x8000
//! but the first byte was at the high byte position of the first 16-bit word,
//! the user would call the CRC function with odd parity i.e.
//! STL_CRC_PARITY_ODD \n
//! Address: HI LO \n
//! 0x8000 : B0 XX \n
//! 0x8001 : B2 B1 \n
//! 0x8002 : B4 B3 \n
//! 0x8003 : B6 B5 \n
//! 0x8004 : B8 B7 \n
//! 0x8005 : XX B9 \n
//! However, if the first byte was at the low byte position of the first 16-bit
//! word, the user would call the CRC function with even parity i.e.
//! STL_CRC_PARITY_EVEN \n
//! Address: HI LO \n
//! 0x8000 : B1 B0 \n
//! 0x8001 : B3 B2 \n
//! 0x8002 : B5 B4 \n
//! 0x8003 : B7 B6 \n
//! 0x8004 : B9 B8 \n
//
typedef enum
{
CRC_PARITY_EVEN = 0U, //!< Even parity, CRC starts at the low byte of
//!< the first word (16-bit)
CRC_PARITY_ODD = 1U //!< Odd parity, CRC starts at the high byte of
//!< the first word (16-bit)
} CRC_Parity;
//! \brief CRC structure
//!
typedef struct
{
uint32_t seedValue; //!< Initial value of the CRC calculation
uint16_t numBytes; //!< Number of bytes in the message buffer
CRC_Parity parity; //!< Start the CRC from the low byte
//!< or high byte
uint32_t crcResult; //!< The calculated CRC
void * msgBuffer; //!< Pointer to the message buffer
} CRC_Obj;
//! \brief Handle to the CRC structure
//!
typedef CRC_Obj *CRC_Handle;
//
// CRC8 table
//
//! \brief crc8 table.
//!
static const uint16_t crc8Table[] = {
0x00, 0x07, 0x0E, 0x09, 0x1C, 0x1B, 0x12, 0x15,
0x38, 0x3F, 0x36, 0x31, 0x24, 0x23, 0x2A, 0x2D,
0x70, 0x77, 0x7E, 0x79, 0x6C, 0x6B, 0x62, 0x65,
0x48, 0x4F, 0x46, 0x41, 0x54, 0x53, 0x5A, 0x5D,
0xE0, 0xE7, 0xEE, 0xE9, 0xFC, 0xFB, 0xF2, 0xF5,
0xD8, 0xDF, 0xD6, 0xD1, 0xC4, 0xC3, 0xCA, 0xCD,
0x90, 0x97, 0x9E, 0x99, 0x8C, 0x8B, 0x82, 0x85,
0xA8, 0xAF, 0xA6, 0xA1, 0xB4, 0xB3, 0xBA, 0xBD,
0xC7, 0xC0, 0xC9, 0xCE, 0xDB, 0xDC, 0xD5, 0xD2,
0xFF, 0xF8, 0xF1, 0xF6, 0xE3, 0xE4, 0xED, 0xEA,
0xB7, 0xB0, 0xB9, 0xBE, 0xAB, 0xAC, 0xA5, 0xA2,
0x8F, 0x88, 0x81, 0x86, 0x93, 0x94, 0x9D, 0x9A,
0x27, 0x20, 0x29, 0x2E, 0x3B, 0x3C, 0x35, 0x32,
0x1F, 0x18, 0x11, 0x16, 0x03, 0x04, 0x0D, 0x0A,
0x57, 0x50, 0x59, 0x5E, 0x4B, 0x4C, 0x45, 0x42,
0x6F, 0x68, 0x61, 0x66, 0x73, 0x74, 0x7D, 0x7A,
0x89, 0x8E, 0x87, 0x80, 0x95, 0x92, 0x9B, 0x9C,
0xB1, 0xB6, 0xBF, 0xB8, 0xAD, 0xAA, 0xA3, 0xA4,
0xF9, 0xFE, 0xF7, 0xF0, 0xE5, 0xE2, 0xEB, 0xEC,
0xC1, 0xC6, 0xCF, 0xC8, 0xDD, 0xDA, 0xD3, 0xD4,
0x69, 0x6E, 0x67, 0x60, 0x75, 0x72, 0x7B, 0x7C,
0x51, 0x56, 0x5F, 0x58, 0x4D, 0x4A, 0x43, 0x44,
0x19, 0x1E, 0x17, 0x10, 0x05, 0x02, 0x0B, 0x0C,
0x21, 0x26, 0x2F, 0x28, 0x3D, 0x3A, 0x33, 0x34,
0x4E, 0x49, 0x40, 0x47, 0x52, 0x55, 0x5C, 0x5B,
0x76, 0x71, 0x78, 0x7F, 0x6A, 0x6D, 0x64, 0x63,
0x3E, 0x39, 0x30, 0x37, 0x22, 0x25, 0x2C, 0x2B,
0x06, 0x01, 0x08, 0x0F, 0x1A, 0x1D, 0x14, 0x13,
0xAE, 0xA9, 0xA0, 0xA7, 0xB2, 0xB5, 0xBC, 0xBB,
0x96, 0x91, 0x98, 0x9F, 0x8A, 0x8D, 0x84, 0x83,
0xDE, 0xD9, 0xD0, 0xD7, 0xC2, 0xC5, 0xCC, 0xCB,
0xE6, 0xE1, 0xE8, 0xEF, 0xFA, 0xFD, 0xF4, 0xF3,
};
//*****************************************************************************
//
// CRC_calculate(CRC_Handle hndCRC)
//
//*****************************************************************************
static inline void CRC_calculate(CRC_Handle hndCRC)
{
uint32_t i;
uint16_t tableIndex;
uint16_t accumulator = hndCRC->seedValue;
uint16_t parity = (uint16_t)hndCRC->parity;
uint16_t *pInputVector = (uint16_t *)hndCRC->msgBuffer;
uint16_t *pCrcTable = (uint16_t *)crc8Table;
// The assumption is the message bytes are packed into 16-bit words
// and the calculation starts from from either the high or low byte
// The memory arrangement is as follows
// Address|__LB__|__HB__|
// 0x0000 |__D0__|__D1__|
// 0x0001 |__D2__|__D3__|
// 0x0002 |__D4__|__D5__|
// 0x0003 |__D6__|__D7__|
// 0x0004 |__D8__|__D9__|
// ...
for(i = 0; i < hndCRC->numBytes; i++, parity++){
// __byte selects either the low(0) or high(1) byte in a word
// the initial selection provided by the enumeration parity
tableIndex = accumulator ^ __byte((int *)pInputVector, parity);
accumulator = pCrcTable[tableIndex];
}
// Save the CRC result
hndCRC->crcResult = (uint32_t)(accumulator & 0x00FF);
}
#endif /* VCU_CRC */
#endif /* SPIFSI_SPI_H_ */
//
// End of File
//
C2000Ware/utilities/spifsi/spifsi.c
+450
View File
@@ -0,0 +1,450 @@
//#############################################################################
//
// FILE: spifsi.c
//
// TITLE: SPI to FSI communication
//
//! \addtogroup spifsi_communication
//
//
//#############################################################################
//
//
//
// C2000Ware v5.04.00.00
//
// Copyright (C) 2024 Texas Instruments Incorporated - http://www.ti.com/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the
// distribution.
//
// Neither the name of Texas Instruments Incorporated nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// $
//#############################################################################
//
// Includes
//
#include "spifsi.h"
//*****************************************************************************
//
// SPIFSI_readFrame(uint32_t base, SPIFSI_FrameInfo *frameInfo)
// SPIFSI_DID_R_04
//
//*****************************************************************************
SPIFSI_Error SPIFSI_readFrame(uint32_t base, SPIFSI_FrameInfo *frameInfo)
{
//
// Frame sections.
//
uint16_t sof = 0U;
uint16_t frameType = 0U;
uint16_t userData = 0U;
uint16_t crc8 = 0U;
uint16_t frameTag = 0U;
uint16_t eof = 0U;
uint16_t dataLength = 0U;
//
// Temp variables.
//
uint16_t word = 0U;
uint16_t userDataCRC8 = 0U;
uint16_t finalCRC8 = 0U;
uint16_t i;
//
// Error flag.
//
uint16_t readError = SPIFSI_PASS;
//
// Read first word (16 bits) and extract sof and frameType.
//
readError = SPI_read16Bits(base, &word);
//
// Return readError if error occurs from reading.
//
if(readError) {
return(SPIFSI_READ_ERROR);
}
//
// Extract sof and frameType, then populate frameType.
//
sof = (word & SPIFSI_FIRST_BIT_MASK) >> SPIFSI_SHIFT_12;
frameType = (word & SPIFSI_SECOND_BIT_MASK) >> SPIFSI_SHIFT_8;
frameInfo->frameType = (SPIFSI_FrameType) frameType;
//
// Verify sof.
// SPIFSI_DID_R_05
//
if(sof != SPIFSI_START_OF_FRAME)
{
return(SPIFSI_SOF_ERROR);
}
//
// Check frameType.
//
switch(frameType)
{
case SPIFSI_FRAME_TYPE_NWORD_DATA:
//
// If NWORD frame type, given paramenter, nLength,
// is the length of data.
//
//
// Verify nLength
// SPIFSI_DID_R_06
//
if((frameInfo->nLength < SPIFSI_MIN_DATA_WORDS) ||
(frameInfo->nLength > SPIFSI_MAX_DATA_WORDS))
{
return(SPIFSI_N_RANGE_ERROR);
}
dataLength = frameInfo->nLength;
break;
case SPIFSI_FRAME_TYPE_1WORD_DATA:
//
// Initialize dataLength.
//
dataLength = 1U;
break;
case SPIFSI_FRAME_TYPE_2WORD_DATA:
dataLength = 2U;
break;
case SPIFSI_FRAME_TYPE_4WORD_DATA:
dataLength = 4U;
break;
case SPIFSI_FRAME_TYPE_6WORD_DATA:
dataLength = 6U;
break;
case SPIFSI_FRAME_TYPE_ERROR:
case SPIFSI_FRAME_TYPE_PING:
//
// In case of ERROR or PING, check eof, then populate tag.
// SPIFSI_DID_R_07
//
eof = (word & SPIFSI_FOURTH_BIT_MASK);
if(eof != SPIFSI_END_OF_FRAME)
{
return(SPIFSI_EOF_ERROR);
}
//
// Different structure of word for ERROR and PING.
// SPIFSI_DID_R_08
//
frameInfo->frameTag = (SPIFSI_FrameTag)
(word & SPIFSI_THIRD_BIT_MASK) >> SPIFSI_SHIFT_4;
return(SPIFSI_NO_ERROR);
default:
//
// Return frame type error.
// SPIFSI_DID_R_09
//
return(SPIFSI_F_TYPE_ERROR);
}
//
// Extract userData and populate.
// SPIFSI_DID_R_11
//
userData = (word & SPIFSI_LAST_TWO_BITS_MASK);
frameInfo->userData = userData;
//
// Read as many words as data length determined by frameType and nLength.
// SPIFSI_DID_R_14
//
for(i = 0U; i < dataLength; i++)
{
//
// Read and check for error.
//
readError = SPI_read16Bits(base, (frameInfo->data+i));
if(readError)
{
return(SPIFSI_READ_ERROR);
}
}
//
// Read the last word and extract crc, frameTag, and eof.
// SPIFSI_DID_R_15
//
readError = SPI_read16Bits(base, &word);
if(readError)
{
return(SPIFSI_READ_ERROR);
}
crc8 = (word & SPIFSI_FIRST_TWO_BITS_MASK) >> SPIFSI_SHIFT_8;
frameInfo->crc8 = crc8;
frameTag = (word & SPIFSI_THIRD_BIT_MASK) >> SPIFSI_SHIFT_4;
frameInfo->frameTag = (SPIFSI_FrameTag) frameTag;
eof = (word & SPIFSI_FOURTH_BIT_MASK);
//
// Verify eof.
// SPIFSI_DID_R_13
//
if(eof != SPIFSI_END_OF_FRAME)
{
return(SPIFSI_EOF_ERROR);
}
//
// Verify CRC8. First, crc8 check on user data.
// SPIFSI_DID_R_16
//
userDataCRC8 = (uint16_t) SPIFSI_calcCRC8(SPIFSI_CRC8_SEED_0,
&(frameInfo->userData),
SPIFSI_CRC8_DEFAULT_PARITY,
1U);
//
// Second, crc8 check on user data + dataLength * 2
// because number of byte (1 word = 2 bytes).
// SPIFSI_DID_R_17
//
finalCRC8 = (uint16_t) SPIFSI_calcCRC8(userDataCRC8,
(frameInfo->data),
SPIFSI_CRC8_DEFAULT_PARITY,
dataLength * 2U);
//
// Compare crc8
// SPIFSI_DID_R_18
//
if(crc8 != (finalCRC8 & SPIFSI_LAST_TWO_BITS_MASK))
{
return(SPIFSI_CRC_ERROR);
}
//
// No error.
// SPIFSI_DID_R_20
//
return(SPIFSI_NO_ERROR);
}
//*****************************************************************************
//
// SPIFSI_writeFrame(uint32_t base, SPIFSI_frameInfo *frameInfo)
// SPIFSI_DID_W_04
//
//*****************************************************************************
SPIFSI_Error SPIFSI_writeFrame(uint32_t base, SPIFSI_FrameInfo *frameInfo)
{
//
// Initialize temp variables.
//
uint16_t dataLength = 0U;
uint16_t word = 0U;
uint16_t i;
uint16_t userDataCRC8 = 0U;
uint16_t finalCRC8 = 0U;
//
// Error flag.
//
uint16_t writeError = SPIFSI_PASS;
//
// Build a first part of the first ward.
// SPIFSI_DID_W_06
//
word |= SPIFSI_START_OF_FRAME << SPIFSI_SHIFT_12;
word |= (frameInfo->frameType & SPIFSI_FOURTH_BIT_MASK) << SPIFSI_SHIFT_8;
//
// Check frameType.
//
switch(frameInfo->frameType)
{
case SPIFSI_FRAME_TYPE_NWORD_DATA:
//
// Verify nLength
// SPIFSI_DID_W_05
//
if((frameInfo->nLength < SPIFSI_MIN_DATA_WORDS) ||
(frameInfo->nLength > SPIFSI_MAX_DATA_WORDS))
{
return(SPIFSI_N_RANGE_ERROR);
}
//
// If NWORD frame type, given parameter, nLength, is
// the length of data.
//
dataLength = frameInfo->nLength;
break;
case SPIFSI_FRAME_TYPE_1WORD_DATA:
//
// Save dataLength
//
dataLength = 1U;
break;
case SPIFSI_FRAME_TYPE_2WORD_DATA:
dataLength = 2U;
break;
case SPIFSI_FRAME_TYPE_4WORD_DATA:
dataLength = 4U;
break;
case SPIFSI_FRAME_TYPE_6WORD_DATA:
dataLength = 6U;
break;
case SPIFSI_FRAME_TYPE_ERROR:
case SPIFSI_FRAME_TYPE_PING:
//
// For ERROR and PING, build a 16-bit word consisting of sof, frameType,
// frameTag, and eof.
// SPIFSI_DID_W_08
//
word |= (frameInfo->frameTag & SPIFSI_FOURTH_BIT_MASK) << SPIFSI_SHIFT_4;
word |= SPIFSI_END_OF_FRAME;
//
// Send the word and check for error.
// SPIFSI_DID_W_08
//
writeError = SPI_write16Bits(base, &word);
if(writeError)
{
return(SPIFSI_WRITE_ERROR);
}
return(SPIFSI_NO_ERROR);
default:
//
// Return frame type error.
// SPIFSI_DID_W_07
//
return(SPIFSI_F_TYPE_ERROR);
}
//
// Fill in the rest of the first word.
// SPIFSI_DID_W_09
//
word |= (frameInfo->userData & SPIFSI_LAST_TWO_BITS_MASK);
//
// Send/write the first word (sof, frameType, and userData)
// SPIFSI_DID_W_09
//
writeError = SPI_write16Bits(base, &word);
if(writeError)
{
return(SPIFSI_WRITE_ERROR);
}
//
// Send/write data.
// SPIFSI_DID_W_10
//
for(i = 0U; i < dataLength; i++)
{
writeError = SPI_write16Bits(base, (frameInfo->data + i));
if(writeError)
{
return(SPIFSI_WRITE_ERROR);
}
}
//
// Crc8 generation. first, on user data.
// SPIFSI_DID_W_11
//
userDataCRC8 = (uint16_t) SPIFSI_calcCRC8(SPIFSI_CRC8_SEED_0,
&(frameInfo->userData),
SPIFSI_CRC8_DEFAULT_PARITY,
1U);
//
// Second, crc8 check on user data + dataLength * 2
// because number of byte (1 word = 2 bytes).
// SPIFSI_DID_W_12
//
finalCRC8 = (uint16_t) SPIFSI_calcCRC8(userDataCRC8,
(frameInfo->data),
SPIFSI_CRC8_DEFAULT_PARITY,
dataLength * 2U);
//
// Mask finalCRC8.
//
finalCRC8 &= SPIFSI_LAST_TWO_BITS_MASK;
//
// Populate crc8 field of frameInfo.
//
frameInfo->crc8 = finalCRC8;
//
// Construct the last word consisted of crc, tag, and eof.
// SPIFSI_DID_W_13
//
word = 0U;
word |= finalCRC8 << SPIFSI_SHIFT_8;
word |= (frameInfo->frameTag & SPIFSI_FOURTH_BIT_MASK) << SPIFSI_SHIFT_4;
word |= SPIFSI_END_OF_FRAME;
//
// Write/send the last word then check for write error.
// SPIFSI_DID_W_13
//
writeError = SPI_write16Bits(base, &word);
if(writeError)
{
return(SPIFSI_WRITE_ERROR);
}
//
// Return no error.
// SPIFSI_DID_W_14
//
return(SPIFSI_NO_ERROR);
}
//
// End of File
//
C2000Ware/utilities/spifsi/spifsi.h
+321
View File
@@ -0,0 +1,321 @@
//#############################################################################
//
// FILE: spifsi.h
//
// TITLE: SPI to FSI communication header file
//
//! \addtogroup spifsi_communication
//
//#############################################################################
//
//
//
// C2000Ware v5.04.00.00
//
// Copyright (C) 2024 Texas Instruments Incorporated - http://www.ti.com/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the
// distribution.
//
// Neither the name of Texas Instruments Incorporated nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// $
//#############################################################################
#ifndef SPIFSI_H
#define SPIFSI_H
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
//
// Includes
//
#include "spifsi_map.h"
//*****************************************************************************
//
//!
//! The code for this module is contained in <tt>source/spifsi.c</tt>, with
//! <tt>source/spifsi.h</tt> containing the API declarations for use by
//! applications.
//!
//! @{
//
//*****************************************************************************
//
// Defines
//
#define SPIFSI_PASS 0x0000U
//! \brief sof and eof.
//!
#define SPIFSI_START_OF_FRAME 0x0009U
#define SPIFSI_END_OF_FRAME 0x0006U
//! \brief maximum number of words
#define SPIFSI_MIN_DATA_WORDS 0x0001U
#define SPIFSI_MAX_DATA_WORDS 0x0010U
//! \brief mask bits and shift bits
//!
#define SPIFSI_FIRST_BIT_MASK 0xF000U
#define SPIFSI_SECOND_BIT_MASK 0x0F00U
#define SPIFSI_THIRD_BIT_MASK 0x00F0U
#define SPIFSI_FOURTH_BIT_MASK 0x000FU
#define SPIFSI_FIRST_TWO_BITS_MASK 0xFF00U
#define SPIFSI_LAST_TWO_BITS_MASK 0x00FFU
#define SPIFSI_SHIFT_4 0x0004U
#define SPIFSI_SHIFT_8 0x0008U
#define SPIFSI_SHIFT_12 0x000CU
//! \brief CRC8 default function arguments
//!
#define SPIFSI_CRC8_SEED_0 0x00000000UL
#define SPIFSI_CRC8_DEFAULT_PARITY 0x0000U
//! \brief Various SPIFSI frame types
//!
//! \details Three frame types exist-
//! - \b Ping: Used for checking line integrity, can be sent by
//! software or automatically by hardware.
//! - \b Error: Used typically during error conditions or when one
//! side wants to signal the other side for attention.
//! - \b Data: Two subtypes exist based on data-length-
//! a) \b Fixed (1/2/4/6 words)
//! b) \b Nwords Software programs number of data words
//!
//! \note 4 bit code for frame types- 0x1, 0x2 and 0x8 to 0xE are reserved
//!
typedef enum
{
SPIFSI_FRAME_TYPE_PING = 0x0000U,
SPIFSI_FRAME_TYPE_ERROR = 0x000FU,
SPIFSI_FRAME_TYPE_1WORD_DATA = 0x0004U,
SPIFSI_FRAME_TYPE_2WORD_DATA = 0x0005U,
SPIFSI_FRAME_TYPE_4WORD_DATA = 0x0006U,
SPIFSI_FRAME_TYPE_6WORD_DATA = 0x0007U,
SPIFSI_FRAME_TYPE_NWORD_DATA = 0x0003U
} SPIFSI_FrameType;
//! \brief Possible values of a SPIFSI frame tag
//!
//! \details 4 bit field inside SPIFSI frame is available to set
//! tag value(0-15)
//!
typedef enum
{
SPIFSI_FRAME_TAG0 = 0x0000U,
SPIFSI_FRAME_TAG1 = 0x0001U,
SPIFSI_FRAME_TAG2 = 0x0002U,
SPIFSI_FRAME_TAG3 = 0x0003U,
SPIFSI_FRAME_TAG4 = 0x0004U,
SPIFSI_FRAME_TAG5 = 0x0005U,
SPIFSI_FRAME_TAG6 = 0x0006U,
SPIFSI_FRAME_TAG7 = 0x0007U,
SPIFSI_FRAME_TAG8 = 0x0008U,
SPIFSI_FRAME_TAG9 = 0x0009U,
SPIFSI_FRAME_TAG10 = 0x000AU,
SPIFSI_FRAME_TAG11 = 0x000BU,
SPIFSI_FRAME_TAG12 = 0x000CU,
SPIFSI_FRAME_TAG13 = 0x000DU,
SPIFSI_FRAME_TAG14 = 0x000EU,
SPIFSI_FRAME_TAG15 = 0x000FU
} SPIFSI_FrameTag;
//! \brief FSI frame structure in SPI compatibility mode.
//!
typedef struct
{
SPIFSI_FrameType frameType;
//!< readFrame: output. writeFrame: input.
uint16_t userData;
//!< readFrame: output. writeFrame: input.
uint16_t *data;
//!< readFrame: input(address)/output(data filled). writeFrame: input(address and data filled).
uint16_t nLength;
//!< readFrame: input. writeFrame: input. (required only when type is N_WORD).
uint16_t crc8;
//!< readFrame: output. writeFrame: output.
SPIFSI_FrameTag frameTag;
//!< readFrame: output. writeFrame: input.
}SPIFSI_FrameInfo;
//! \brief ERROR enum type returned by SPIFSI_readFrame() and SPIFSI_writeFrame().
//!
typedef enum
{
SPIFSI_NO_ERROR = 0x0000U,
SPIFSI_SOF_ERROR = 0x0001U,
SPIFSI_F_TYPE_ERROR = 0x0002U,
SPIFSI_CRC_ERROR = 0x0003U,
SPIFSI_EOF_ERROR = 0x0004U,
SPIFSI_N_RANGE_ERROR = 0x0005U,
SPIFSI_READ_ERROR = 0x0006U,
SPIFSI_WRITE_ERROR = 0x0007U
} SPIFSI_Error;
//*****************************************************************************
//
//! \brief Reads/Receives frame from FSI.
//!
//! \param base is base address of SPI
//! \param frameInfo is a pointer to the \b SPIFSI_FrameInfo object.
//!
//! First, this function reads-in the first word which contains frameType.
//! If frameType is \b SPIFSI_FRAME_TYPE_PING or ERROR, it populates frameType
//! and frameTag fields of frameInfo then returns. Else, it reads-in data and
//! calculates crc8. If crc8 is valid, it populates frameType, userData,
//! data, crc8, and frameTag of frameInfo, then returns.
//!
//! \note The user must populate nLength field if frameType is N_WORD and
//! initialize the *data field prior to function call.
//!
//! \return If there is an error within the received frame, it returns one of
//! the listed \b SPIFSI_Error enum. Otherwise, it returns \b SPIFSI_NO_ERROR.
//
//*****************************************************************************
extern SPIFSI_Error SPIFSI_readFrame(uint32_t base,
SPIFSI_FrameInfo *frameInfo);
//*****************************************************************************
//
//! \brief Writes/sends frame to FSI.
//!
//! \param base is base address of SPI
//! \param frameInfo is a pointer to the \b SPIFSI_FrameInfo object.
//!
//! First, if a frameType, a field of frameInfo parameter, is
//! \b SPIFSI_FRAME_TYPE_PING or ERROR, this function sends a word consisting of
//! sof, frameType, frameTag, and eof to FSI. Else, it calculates crc8 and if
//! valid, it then sends a frame consisting of sof, frameType, userData, data,
//! crc, frameTag, and eof to FSI.
//!
//! \note The user must populate every field of frameInfo except crc8 prior to
//! function call.
//!
//! \return If there is an error within the received frame, it returns one of
//! the listed \b SPIFSI_Error enum. Otherwise, it returns \b SPIFSI_NO_ERROR.
//
//*****************************************************************************
extern SPIFSI_Error SPIFSI_writeFrame(uint32_t base,
SPIFSI_FrameInfo *frameInfo);
//*****************************************************************************
//
//! \brief reads 16-bit word.
//!
//! \param base is base address of SPI.
//! \param data16 is a pointer to 16-bit word.
//!
//! This function reads 16-bit word from SPI and assigns the word to *data16.
//! If any error occurs during reading, this function returns non-zero 16-bit
//! int. Otherwise, it returns zero 16-bit int.
//!
//! \note The user must define the function body per device.
//!
//! \return If there is an error while reading, it returns non-zero 16-bit int.
//! Otherwise, it returns zero 16-bit int.
//
//*****************************************************************************
extern uint16_t SPI_read16Bits(uint32_t base, uint16_t *data16);
//*****************************************************************************
//
//! \brief writes 16-bit word.
//!
//! \param base is base address of SPI.
//! \param data16 is a word to be written.
//!
//! This function writes 16-bit word, data16, to SPI. If any error occurs during
//! reading, this function returns non-zero 16-bit int. Otherwise, it returns
//! zero 16-bit int.
//!
//! \note The user must define the function body per device.
//!
//! \return If there is an error while reading, it returns non-zero 16-bit int.
//! Otherwise, it returns zero 16-bit int.
//
//*****************************************************************************
extern uint16_t SPI_write16Bits(uint32_t base, uint16_t *data16);
//*****************************************************************************
//
//! \brief VCU(ASM)- function to get the 8-bit CRC
//!
//! Calculate the 8-bit CRC of a message buffer by using the VCU instructions,
//! VCRC8L_1 and VCRC8H_1
//!
//! \param inputCRC8Accum The seed value for the CRC, in the event of a
//! multi-part message, the result of the previous crc8 can be used as
//! the initial value for the current segment crc8 calculation
//! until the final crc is derived.
//! \param msg Address of the message buffer
//! \param parity Parity of the first message word. The parity determines whether
//! the CRC begins at the low byte (even parity, 0U) or at the high
//! byte (odd parity, 1U) of the first word
//! determines whether the CRC begins at the low byte (EVEN) or at the high byte (ODD).
//! \param rxLen Length of the message in bytes
//! \return CRC result
//
//*****************************************************************************
extern uint16_t SPIFSI_calcCRC8(uint32_t inputCRC8Accum, uint16_t *msg,
uint16_t parity, uint16_t rxLen);
//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
#endif
#endif // SPIFSI_H
//
// End of File
//
C2000Ware/utilities/spifsi/spifsi_map.h
+103
View File
@@ -0,0 +1,103 @@
//#############################################################################
//
// FILE: spifsi_map.h
//
// TITLE: SPI to FSI communication user-defined function mapping
//
//! \addtogroup spifsi_communication
//
//#############################################################################
//
//
//
// C2000Ware v5.04.00.00
//
// Copyright (C) 2024 Texas Instruments Incorporated - http://www.ti.com/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the
// distribution.
//
// Neither the name of Texas Instruments Incorporated nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// $
//#############################################################################
#ifndef SPIFSI_MAP_H
#define SPIFSI_MAP_H
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
//
// Include
//
// User will include headers containing the mapped functions
// For C2000:
#include "spifsi_spi.h"
//*****************************************************************************
//
//!
//! @{
//
//*****************************************************************************
//
// Mapping
//
#define SPI_read16Bits SPI_read16Bits
#define SPI_write16Bits SPI_write16Bits
#define SPIFSI_calcCRC8 SPIFSI_calcCRC8
//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
#endif
#endif // SPIFSI_MAPPING_H
//
// End of File
//