AM243x MCU+ SDK  09.01.00
mcspi_lld.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
50 #ifndef MCSPI_LLD_H_
51 #define MCSPI_LLD_H_
52 
53 /* ========================================================================== */
54 /* Include Files */
55 /* ========================================================================== */
56 #include <stdint.h>
57 #include <stdbool.h>
58 #include <drivers/hw_include/csl_types.h>
59 #include <drivers/hw_include/cslr_mcspi.h>
60 #include <drivers/hw_include/cslr.h>
61 
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65 
66 /* ========================================================================== */
67 /* Macros & Typedefs */
68 /* ========================================================================== */
69 
70 /* pointer for DMA Handle */
71 typedef void *MCSPI_DmaHandle;
72 /* pointer for DMA Channel Config */
73 typedef void *MCSPI_DmaChConfig;
74 
75 /* function pointer to get clock ticks */
76 typedef uint32_t (*MCSPI_clockGet) (void);
77 
78 
85 #define MCSPI_STATUS_SUCCESS ((int32_t)0)
86 
90 #define MCSPI_STATUS_FAILURE ((int32_t)-1)
91 
95 #define MCSPI_TIMEOUT ((int32_t)-2)
96 
100 #define MCSPI_INVALID_PARAM ((int32_t)-3)
101 
105 #define MCSPI_STATUS_BUSY ((int32_t)-4)
106 
110 #define MCSPI_INVALID_STATE ((int32_t)-5)
111 
120 #define MCSPI_NO_WAIT ((uint32_t)0)
121 
125 #define MCSPI_WAIT_FOREVER ((uint32_t)-1)
126 
134 #define MCSPI_STATE_RESET ((uint32_t)0U)
135 
139 #define MCSPI_STATE_READY ((uint32_t)1U)
140 
144 #define MCSPI_STATE_BUSY ((uint32_t)2U)
145 
149 #define MCSPI_STATE_ERROR ((uint32_t)3U)
150 
161 #define MCSPI_CHANNEL_0 (0U)
162 #define MCSPI_CHANNEL_1 (1U)
163 #define MCSPI_CHANNEL_2 (2U)
164 #define MCSPI_CHANNEL_3 (3U)
165 
175 #define MCSPI_OPER_MODE_POLLED (0U)
176 #define MCSPI_OPER_MODE_INTERRUPT (1U)
177 #define MCSPI_OPER_MODE_DMA (2U)
178 
181 #define MCSPI_MAX_NUM_CHANNELS (4U)
182 
191 #define MCSPI_TRANSFER_COMPLETED ((int32_t)0U)
192 #define MCSPI_TRANSFER_STARTED ((int32_t)1U)
193 #define MCSPI_TRANSFER_CANCELLED ((int32_t)2U)
194 #define MCSPI_TRANSFER_FAILED ((int32_t)3U)
195 #define MCSPI_TRANSFER_CSN_DEASSERT ((int32_t)4U)
196 #define MCSPI_TRANSFER_TIMEOUT ((int32_t)5U)
197 
215 #define MCSPI_MS_MODE_CONTROLLER (CSL_MCSPI_MODULCTRL_MS_MASTER)
216 
217 #define MCSPI_MS_MODE_PERIPHERAL (CSL_MCSPI_MODULCTRL_MS_SLAVE)
218 
234 #define MCSPI_FF_POL0_PHA0 (0U)
235 #define MCSPI_FF_POL0_PHA1 (1U)
236 #define MCSPI_FF_POL1_PHA0 (2U)
237 #define MCSPI_FF_POL1_PHA1 (3U)
238 
249 #define MCSPI_CS_POL_HIGH (CSL_MCSPI_CH0CONF_EPOL_ACTIVEHIGH)
250 
251 #define MCSPI_CS_POL_LOW (CSL_MCSPI_CH0CONF_EPOL_ACTIVELOW)
252 
260 #define MCSPI_TR_MODE_TX_RX (CSL_MCSPI_CH0CONF_TRM_TRANSRECEI)
261 #define MCSPI_TR_MODE_RX_ONLY (CSL_MCSPI_CH0CONF_TRM_RECEIVONLY)
262 #define MCSPI_TR_MODE_TX_ONLY (CSL_MCSPI_CH0CONF_TRM_TRANSONLY)
263 
272 #define MCSPI_IS_D0 (CSL_MCSPI_CH0CONF_IS_LINE0)
273 
274 #define MCSPI_IS_D1 (CSL_MCSPI_CH0CONF_IS_LINE1)
275 
284 #define MCSPI_DPE_ENABLE (CSL_MCSPI_CH0CONF_DPE0_ENABLED)
285 
286 #define MCSPI_DPE_DISABLE (CSL_MCSPI_CH0CONF_DPE0_DISABLED)
287 
295 #define MCSPI_SLV_CS_SELECT_0 (CSL_MCSPI_CH0CONF_SPIENSLV_SPIEN0)
296 #define MCSPI_SLV_CS_SELECT_1 (CSL_MCSPI_CH0CONF_SPIENSLV_SPIEN1)
297 #define MCSPI_SLV_CS_SELECT_2 (CSL_MCSPI_CH0CONF_SPIENSLV_SPIEN2)
298 #define MCSPI_SLV_CS_SELECT_3 (CSL_MCSPI_CH0CONF_SPIENSLV_SPIEN3)
299 
308 #define MCSPI_SB_POL_HIGH (CSL_MCSPI_CH0CONF_SBPOL_HIGHLEVEL)
309 
310 #define MCSPI_SB_POL_LOW (CSL_MCSPI_CH0CONF_SBPOL_LOWLEVEL)
311 
322 #define MCSPI_TCS0_0_CLK (CSL_MCSPI_CH0CONF_TCS0_ZEROCYCLEDLY)
323 
324 #define MCSPI_TCS0_1_CLK (CSL_MCSPI_CH0CONF_TCS0_ONECYCLEDLY)
325 
326 #define MCSPI_TCS0_2_CLK (CSL_MCSPI_CH0CONF_TCS0_TWOCYCLEDLY)
327 
328 #define MCSPI_TCS0_3_CLK (CSL_MCSPI_CH0CONF_TCS0_THREECYCLEDLY)
329 
341 #define MCSPI_CH_MODE_SINGLE (CSL_MCSPI_MODULCTRL_SINGLE_SINGLE)
342 
343 #define MCSPI_CH_MODE_MULTI (CSL_MCSPI_MODULCTRL_SINGLE_MULTI)
344 
356 #define MCSPI_PINMODE_3PIN (CSL_MCSPI_MODULCTRL_PIN34_3PINMODE)
357 #define MCSPI_PINMODE_4PIN (CSL_MCSPI_MODULCTRL_PIN34_4PINMODE)
358 
369 #define MCSPI_INITDLY_0 (CSL_MCSPI_MODULCTRL_INITDLY_NODELAY)
370 
371 #define MCSPI_INITDLY_4 (CSL_MCSPI_MODULCTRL_INITDLY_4CLKDLY)
372 
373 #define MCSPI_INITDLY_8 (CSL_MCSPI_MODULCTRL_INITDLY_8CLKDLY)
374 
375 #define MCSPI_INITDLY_16 (CSL_MCSPI_MODULCTRL_INITDLY_16CLKDLY)
376 
377 #define MCSPI_INITDLY_32 (CSL_MCSPI_MODULCTRL_INITDLY_32CLKDLY)
378 
381 #define MCSPI_ERROR_TX_UNDERFLOW (0x00000001U)
382 #define MCSPI_ERROR_RX_OVERFLOW (0x00000002U)
383 
385 #define MCSPI_MAX_CLK_DIVIDER_SUPPORTED (4096U)
386 
387 /* ========================================================================== */
388 /* Advanced Macros & Typedefs */
389 /* ========================================================================== */
390 
392 #define MCSPI_FIFO_LENGTH (64U)
393 
396 #define MCSPI_RX_FIFO_ENABLE ((uint32_t) CSL_MCSPI_CH0CONF_FFER_FFENABLED \
397  << \
398  CSL_MCSPI_CH0CONF_FFER_SHIFT)
399 
403 #define MCSPI_RX_FIFO_DISABLE ((uint32_t) CSL_MCSPI_CH0CONF_FFER_FFDISABLED \
404  << CSL_MCSPI_CH0CONF_FFER_SHIFT)
405 
409 #define MCSPI_TX_FIFO_ENABLE ((uint32_t) CSL_MCSPI_CH0CONF_FFEW_FFENABLED \
410  << CSL_MCSPI_CH0CONF_FFEW_SHIFT)
411 
415 #define MCSPI_TX_FIFO_DISABLE ((uint32_t) CSL_MCSPI_CH0CONF_FFEW_FFDISABLED \
416  << CSL_MCSPI_CH0CONF_FFEW_SHIFT)
417 
421 #define MCSPI_REG_OFFSET (0x14U)
422 
423 #define MCSPI_CHCONF(x) ((uint32_t) CSL_MCSPI_CH0CONF + \
424  (uint32_t) ((uint32_t) MCSPI_REG_OFFSET * \
425  (uint32_t) (x)))
426 
427 #define MCSPI_CHSTAT(x) ((uint32_t) CSL_MCSPI_CH0STAT + \
428  (uint32_t) ((uint32_t) MCSPI_REG_OFFSET * \
429  (uint32_t) (x)))
430 
431 #define MCSPI_CHCTRL(x) ((uint32_t) CSL_MCSPI_CH0CTRL + \
432  (uint32_t) ((uint32_t) MCSPI_REG_OFFSET * \
433  (uint32_t) (x)))
434 
435 #define MCSPI_CHTX(x) ((uint32_t) CSL_MCSPI_TX0 + \
436  (uint32_t) ((uint32_t) MCSPI_REG_OFFSET * \
437  (uint32_t) (x)))
438 
439 #define MCSPI_CHRX(x) ((uint32_t) CSL_MCSPI_RX0 + \
440  (uint32_t) ((uint32_t) MCSPI_REG_OFFSET * \
441  (uint32_t) (x)))
442 
443 #define MCSPI_CLKD_MASK (0x0FU)
444 
446 #define MCSPI_IRQSTATUS_CLEAR_ALL (CSL_MCSPI_IRQSTATUS_EOW_MASK | \
447  CSL_MCSPI_IRQSTATUS_WKS_MASK | \
448  CSL_MCSPI_IRQSTATUS_RX3_FULL_MASK | \
449  CSL_MCSPI_IRQSTATUS_TX3_UNDERFLOW_MASK | \
450  CSL_MCSPI_IRQSTATUS_TX3_EMPTY_MASK | \
451  CSL_MCSPI_IRQSTATUS_RX2_FULL_MASK | \
452  CSL_MCSPI_IRQSTATUS_TX2_UNDERFLOW_MASK | \
453  CSL_MCSPI_IRQSTATUS_TX2_EMPTY_MASK | \
454  CSL_MCSPI_IRQSTATUS_RX1_FULL_MASK | \
455  CSL_MCSPI_IRQSTATUS_TX1_UNDERFLOW_MASK | \
456  CSL_MCSPI_IRQSTATUS_TX1_EMPTY_MASK | \
457  CSL_MCSPI_IRQSTATUS_RX0_OVERFLOW_MASK | \
458  CSL_MCSPI_IRQSTATUS_RX0_FULL_MASK | \
459  CSL_MCSPI_IRQSTATUS_TX0_UNDERFLOW_MASK | \
460  CSL_MCSPI_IRQSTATUS_TX0_EMPTY_MASK)
461 
462 /* ========================================================================== */
463 /* Structure Declarations */
464 /* ========================================================================== */
465 
474 typedef struct
475 {
476  uint32_t channel;
479  uint32_t csDisable;
485  uint32_t dataSize;
496  uint32_t count;
499  void *txBuf;
510  void *rxBuf;
517  void *args;
519  uint32_t timeout;
521  uint32_t status;
524 
534 typedef struct MCSPI_ExtendedParams_s
535 {
536  uint32_t channel;
539  uint32_t csDisable;
545  uint32_t dataSize;
557 
569 typedef struct
570 {
571  uint32_t chNum;
573  uint32_t frameFormat;
575  uint32_t bitRate;
577  uint32_t csPolarity;
579  uint32_t trMode;
581  uint32_t inputSelect;
583  uint32_t dpe0;
585  uint32_t dpe1;
587  uint32_t slvCsSelect;
590  uint32_t startBitEnable;
596  uint32_t turboEnable;
598  uint32_t csIdleTime;
601  uint32_t defaultTxData;
604  uint32_t txFifoTrigLvl;
606  uint32_t rxFifoTrigLvl;
609 
610 /* ========================================================================== */
611 /* Function pointers Declarations */
612 /* ========================================================================== */
613 
620 typedef void (*MCSPI_transferCallbackFxn) (void *args, uint32_t tansferStatus);
621 
628 typedef void (*MCSPI_errorCallbackFxn) (void *args);
629 
630 /* ========================================================================== */
631 /* Internal/Private Structure Declarations */
632 /* ========================================================================== */
633 
637 typedef struct
638 {
639  /*
640  * User parameters
641  */
644  uint32_t dmaChConfigNum;
647  /*
648  * State variables
649  */
650  uint32_t isOpen;
652  uint32_t csDisable;
654  uint32_t csEnable;
656  uint8_t *curTxBufPtr;
658  uint8_t *curRxBufPtr;
660  uint32_t curTxWords;
664  uint32_t curRxWords;
667  /*
668  * MCSPI derived variables
669  */
670  uint8_t bufWidthShift;
678  uint32_t effTxFifoDepth;
680  uint32_t effRxFifoDepth;
682  uint32_t intrMask;
686  uint32_t chConfRegVal;
688  uint32_t chCtrlRegVal;
690  uint32_t systRegVal;
692 
696 typedef struct
697 {
698  uint32_t inputClkFreq;
700  uint32_t intrNum;
702  uint32_t operMode;
704  uint8_t intrPriority;
706  uint32_t chMode;
708  uint32_t pinMode;
710  uint32_t initDelay;
712  uint32_t multiWordAccess;
714  uint32_t msMode;
716  uint32_t chEnabled[MCSPI_MAX_NUM_CHANNELS];
723  /* clock usec to tick */
729 
733 typedef struct
734 {
735  uint32_t baseAddr;
738  /*
739  * User parameters
740  */
741  uint32_t state;
747  uint32_t errorFlag;
750  /*
751  * Transfer parameters
752  */
753  uint32_t transferChannel;
761  void* args;
764 
765 /* ========================================================================== */
766 /* Function Declarations */
767 /* ========================================================================== */
768 
769 /* Low level HW functions */
770 void MCSPI_reset(uint32_t baseAddr);
771 void MCSPI_clearAllIrqStatus(uint32_t baseAddr);
772 void MCSPI_stop(MCSPILLD_Handle hMcspi, MCSPI_ChObject *chObj, uint32_t chNum);
773 void MCSPI_setChDataSize(uint32_t baseAddr, MCSPI_ChObject *chObj,
774  uint32_t dataSize, uint32_t csDisable);
775 
776 static inline void MCSPI_intrStatusClear(const MCSPI_ChObject *chObj,
777  uint32_t baseAddr, uint32_t intFlags)
778 {
779  /* Clear the SSB bit in the MCSPI_SYST register. */
780  CSL_REG32_WR(baseAddr + CSL_MCSPI_SYST, chObj->systRegVal);
781  /* Clear the interrupt status. */
782  CSL_REG32_WR(baseAddr + CSL_MCSPI_IRQSTATUS, intFlags);
783 }
784 
785 /* ========================================================================== */
786 /* Function Declarations */
787 /* ========================================================================== */
788 
798 
817 
827 
840 int32_t MCSPI_lld_write(MCSPILLD_Handle hMcspi, void *txBuf, uint32_t count, uint32_t timeout,
841  const MCSPI_ExtendedParams *extendedParams);
842 
855 int32_t MCSPI_lld_writeIntr(MCSPILLD_Handle hMcspi, void *txBuf, uint32_t count, uint32_t timeout,
856  const MCSPI_ExtendedParams *extendedParams);
857 
870 int32_t MCSPI_lld_writeDma(MCSPILLD_Handle hMcspi, void * txBuf, uint32_t count,
871  uint32_t timeout, const MCSPI_ExtendedParams *extendedParams);
872 
885 int32_t MCSPI_lld_read(MCSPILLD_Handle hMcspi, void * rxBuf, uint32_t count, uint32_t timeout,
886  const MCSPI_ExtendedParams *extendedParams);
887 
900 int32_t MCSPI_lld_readIntr(MCSPILLD_Handle hMcspi, void * rxBuf, uint32_t count, uint32_t timeout,
901  const MCSPI_ExtendedParams *extendedParams);
902 
916 int32_t MCSPI_lld_readDma(MCSPILLD_Handle hMcspi, void * rxBuf, uint32_t count,
917  uint32_t timeout, const MCSPI_ExtendedParams *extendedParams);
930 int32_t MCSPI_lld_readWrite(MCSPILLD_Handle hMcspi, void *txBuf, void *rxBuf, uint32_t count,
931  uint32_t timeout, const MCSPI_ExtendedParams *extendedParams);
944 int32_t MCSPI_lld_readWriteIntr(MCSPILLD_Handle hMcspi, void *txBuf, void *rxBuf, uint32_t count,
945  uint32_t timeout, const MCSPI_ExtendedParams *extendedParams);
958 int32_t MCSPI_lld_readWriteDma(MCSPILLD_Handle hMcspi, void *txBuf, void *rxBuf, uint32_t count,
959  uint32_t timeout, const MCSPI_ExtendedParams *extendedParams);
960 
970 
980 
991 
1002 
1013 
1020 void MCSPI_lld_controllerIsr(void* args);
1021 
1028 void MCSPI_lld_peripheralIsr(void* args);
1029 
1037 
1047 
1057 
1064 static inline void MCSPI_lld_ChConfig_init(MCSPI_ChConfig *chConfig);
1065 
1072 static inline void MCSPI_lld_Transaction_init(MCSPI_Transaction *trans);
1073 
1083 
1096  uint32_t chNum,
1097  uint32_t numWordsRxTx);
1098 
1113 static inline uint8_t MCSPI_getBufWidthShift(uint32_t dataSize);
1114 
1138 static inline uint32_t MCSPI_readChStatusReg(uint32_t baseAddr, uint32_t chNum);
1139 
1150 static inline uint32_t MCSPI_readChCtrlReg(uint32_t baseAddr, uint32_t chNum);
1151 
1161 static inline void MCSPI_writeChCtrlReg(uint32_t baseAddr, uint32_t chNum,
1162  uint32_t regVal);
1163 
1174 static inline uint32_t MCSPI_readChConf(uint32_t baseAddr, uint32_t chNum);
1175 
1185 static inline void MCSPI_writeChConfReg(uint32_t baseAddr, uint32_t chNum,
1186  uint32_t regVal);
1187 
1204 static inline void MCSPI_writeTxDataReg(uint32_t baseAddr,
1205  uint32_t txData,
1206  uint32_t chNum);
1207 
1227 static inline void MCSPI_enableTxFIFO(uint32_t baseAddr, uint32_t chNum,
1228  uint32_t enableFlag);
1229 
1249 static inline void MCSPI_enableRxFIFO(uint32_t baseAddr, uint32_t chNum,
1250  uint32_t enableFlag);
1251 
1267 static inline uint32_t MCSPI_readRxDataReg(uint32_t baseAddr,
1268  uint32_t chNum);
1269 
1286 static inline void MCSPI_setDataWidth(uint32_t baseAddr, uint32_t chNum,
1287  uint32_t dataWidth);
1288 
1289 /* ========================================================================== */
1290 /* Static Function Definitions */
1291 /* ========================================================================== */
1292 
1293 static inline void MCSPI_lld_ChConfig_init(MCSPI_ChConfig *chConfig)
1294 {
1295  if(chConfig != NULL)
1296  {
1297  chConfig->chNum = MCSPI_CHANNEL_0;
1298  chConfig->frameFormat = MCSPI_FF_POL0_PHA0;
1299  chConfig->bitRate = 1000000U;
1300  chConfig->csPolarity = MCSPI_CS_POL_LOW;
1301  chConfig->trMode = MCSPI_TR_MODE_TX_RX;
1302  chConfig->inputSelect = MCSPI_IS_D1;
1303  chConfig->dpe0 = MCSPI_DPE_ENABLE;
1304  chConfig->dpe1 = MCSPI_DPE_DISABLE;
1305  chConfig->slvCsSelect = MCSPI_SLV_CS_SELECT_0;
1306  chConfig->startBitEnable = FALSE;
1307  chConfig->startBitPolarity = MCSPI_SB_POL_LOW;
1308  chConfig->csIdleTime = MCSPI_TCS0_0_CLK;
1309  chConfig->defaultTxData = 0x00000000U;
1310  }
1311 }
1312 
1314 {
1315  if(trans != NULL)
1316  {
1317  trans->channel = 0U;
1318  trans->csDisable = TRUE;
1319  trans->dataSize = 8U;
1320  trans->count = 0U;
1321  trans->txBuf = NULL;
1322  trans->rxBuf = NULL;
1323  trans->args = NULL;
1324  trans->timeout = MCSPI_WAIT_FOREVER;
1325  }
1326 }
1327 
1328 static inline uint8_t MCSPI_getBufWidthShift(uint32_t dataSize)
1329 {
1330  uint8_t bufWidthShift = 0U;
1331 
1332  if(dataSize <= 8U)
1333  {
1334  bufWidthShift = 0U;
1335  }
1336  else if(dataSize <= 16U)
1337  {
1338  bufWidthShift = 1U;
1339  }
1340  else
1341  {
1342  bufWidthShift = 2U;
1343  }
1344 
1345  return bufWidthShift;
1346 }
1347 
1348 static inline uint32_t MCSPI_readChStatusReg(uint32_t baseAddr, uint32_t chNum)
1349 {
1350  /* Return the status from MCSPI_CHSTAT register. */
1351  return (CSL_REG32_RD(baseAddr + MCSPI_CHSTAT(chNum)));
1352 }
1353 
1354 static inline uint32_t MCSPI_readChCtrlReg(uint32_t baseAddr, uint32_t chNum)
1355 {
1356  return CSL_REG32_RD(baseAddr + MCSPI_CHCTRL(chNum));
1357 }
1358 
1359 static inline void MCSPI_writeChCtrlReg(uint32_t baseAddr, uint32_t chNum,
1360  uint32_t regVal)
1361 {
1362  CSL_REG32_WR(baseAddr + MCSPI_CHCTRL(chNum), regVal);
1363 }
1364 
1365 static inline uint32_t MCSPI_readChConf(uint32_t baseAddr, uint32_t chNum)
1366 {
1367  return CSL_REG32_RD(baseAddr + MCSPI_CHCONF(chNum));
1368 }
1369 
1370 static inline void MCSPI_writeChConfReg(uint32_t baseAddr, uint32_t chNum,
1371  uint32_t regVal)
1372 {
1373  CSL_REG32_WR(baseAddr + MCSPI_CHCONF(chNum), regVal);
1374 }
1375 
1376 static inline void MCSPI_writeTxDataReg(uint32_t baseAddr,
1377  uint32_t txData,
1378  uint32_t chNum)
1379 {
1380  /* Load the MCSPI_TX register with the data to be transmitted */
1381  CSL_REG32_WR(baseAddr + MCSPI_CHTX(chNum), txData);
1382 }
1383 
1384 static inline void MCSPI_enableTxFIFO(uint32_t baseAddr,
1385  uint32_t chNum,
1386  uint32_t enableFlag)
1387 {
1388  /* Set the FFEW field with user sent value. */
1389  CSL_REG32_FINS(
1390  baseAddr + MCSPI_CHCONF(chNum),
1391  MCSPI_CH0CONF_FFEW,
1392  enableFlag >> CSL_MCSPI_CH0CONF_FFEW_SHIFT);
1393 }
1394 
1395 static inline void MCSPI_enableRxFIFO(uint32_t baseAddr,
1396  uint32_t chNum,
1397  uint32_t enableFlag)
1398 {
1399  /* Set the FFER field with the user sent value. */
1400  CSL_REG32_FINS(
1401  baseAddr + MCSPI_CHCONF(chNum),
1402  MCSPI_CH0CONF_FFER,
1403  enableFlag >> CSL_MCSPI_CH0CONF_FFER_SHIFT);
1404 }
1405 
1406 static inline uint32_t MCSPI_readRxDataReg(uint32_t baseAddr, uint32_t chNum)
1407 {
1408  /* Return the data present in the MCSPI_RX register. */
1409  return (CSL_REG32_RD(baseAddr + MCSPI_CHRX(chNum)));
1410 }
1411 
1412 static inline void MCSPI_setDataWidth(uint32_t baseAddr, uint32_t chNum,
1413  uint32_t dataWidth)
1414 {
1415  uint32_t regVal;
1416 
1417  regVal = CSL_REG32_RD(baseAddr + MCSPI_CHCONF(chNum));
1418  CSL_FINS(regVal, MCSPI_CH0CONF_WL, (dataWidth - 1U));
1419  CSL_REG32_WR(baseAddr + MCSPI_CHCONF(chNum), regVal);
1420 }
1421 
1422 #ifdef __cplusplus
1423 }
1424 #endif
1425 
1426 #endif /* #ifndef MCSPI_LLD_H_ */
1427 
MCSPI_lld_readWriteDmaCancel
int32_t MCSPI_lld_readWriteDmaCancel(MCSPILLD_Handle hMcspi)
This API cancels current McSPI transfer in DMA mode.
MCSPILLD_InitObject::pinMode
uint32_t pinMode
Definition: mcspi_lld.h:708
MCSPI_getBufWidthShift
static uint8_t MCSPI_getBufWidthShift(uint32_t dataSize)
This API will return the buffer width in bytes based on dataSize.
Definition: mcspi_lld.h:1328
MCSPI_clockGet
uint32_t(* MCSPI_clockGet)(void)
Definition: mcspi_lld.h:76
MCSPI_ChObject::curTxBufPtr
uint8_t * curTxBufPtr
Definition: mcspi_lld.h:656
MCSPILLD_InitObject
MCSPI driver initialization object.
Definition: mcspi_lld.h:697
MCSPI_ChObject
MCSPI channel object.
Definition: mcspi_lld.h:638
MCSPI_Transaction::count
uint32_t count
Definition: mcspi_lld.h:496
MCSPI_ChConfig::txFifoTrigLvl
uint32_t txFifoTrigLvl
Definition: mcspi_lld.h:604
MCSPI_CHTX
#define MCSPI_CHTX(x)
Base address of McSPI_CHTX(x)
Definition: mcspi_lld.h:435
MCSPI_FF_POL0_PHA0
#define MCSPI_FF_POL0_PHA0
Definition: mcspi_lld.h:234
MCSPI_ChConfig::rxFifoTrigLvl
uint32_t rxFifoTrigLvl
Definition: mcspi_lld.h:606
MCSPILLD_InitObject::intrNum
uint32_t intrNum
Definition: mcspi_lld.h:700
MCSPI_lld_readWriteCancel
int32_t MCSPI_lld_readWriteCancel(MCSPILLD_Handle hMcspi)
This API cancels current McSPI transfer.
MCSPI_DPE_DISABLE
#define MCSPI_DPE_DISABLE
No transmission on Data Line.
Definition: mcspi_lld.h:286
MCSPI_Transaction::status
uint32_t status
Definition: mcspi_lld.h:521
MCSPI_Transaction
Data structure used with MCSPI_transfer()
Definition: mcspi_lld.h:475
MCSPI_ChObject::effTxFifoDepth
uint32_t effTxFifoDepth
Definition: mcspi_lld.h:678
MCSPI_TCS0_0_CLK
#define MCSPI_TCS0_0_CLK
0.5 clock cycles delay
Definition: mcspi_lld.h:322
MCSPI_writeTxDataReg
static void MCSPI_writeTxDataReg(uint32_t baseAddr, uint32_t txData, uint32_t chNum)
This API will put the data on to the McSPI Channel transmit register.
Definition: mcspi_lld.h:1376
MCSPILLD_Object::transferDataSize
uint32_t transferDataSize
Definition: mcspi_lld.h:757
MCSPI_lld_getBaseAddr
uint32_t MCSPI_lld_getBaseAddr(MCSPILLD_Handle handle)
Function to get base address of MCSPI instance of a particular handle.
MCSPI_ChObject::intrMask
uint32_t intrMask
Definition: mcspi_lld.h:682
MCSPILLD_InitObject::clockP_get
MCSPI_clockGet clockP_get
Definition: mcspi_lld.h:722
MCSPI_WAIT_FOREVER
#define MCSPI_WAIT_FOREVER
Value to use when needing a timeout of infinity or wait forver until resource is available.
Definition: mcspi_lld.h:125
MCSPI_ChObject::chConfRegVal
uint32_t chConfRegVal
Definition: mcspi_lld.h:686
count
uint32_t count
Definition: tisci_rm_ra.h:6
MCSPI_enableTxFIFO
static void MCSPI_enableTxFIFO(uint32_t baseAddr, uint32_t chNum, uint32_t enableFlag)
This API will enable/disable the Tx FIFOs of McSPI peripheral.
Definition: mcspi_lld.h:1384
MCSPI_lld_transferCancel
int32_t MCSPI_lld_transferCancel(MCSPILLD_Handle hMcspi)
This API cancels current McSPI transfer.
MCSPILLD_Object::errorFlag
uint32_t errorFlag
Definition: mcspi_lld.h:747
MCSPI_SLV_CS_SELECT_0
#define MCSPI_SLV_CS_SELECT_0
Definition: mcspi_lld.h:295
MCSPILLD_InitObject::intrPriority
uint8_t intrPriority
Definition: mcspi_lld.h:704
MCSPI_ChObject::dmaChConfigNum
uint32_t dmaChConfigNum
Definition: mcspi_lld.h:644
MCSPI_CHCONF
#define MCSPI_CHCONF(x)
Base address of McSPI_CHCONF(x)
Definition: mcspi_lld.h:423
MCSPI_lld_controllerIsr
void MCSPI_lld_controllerIsr(void *args)
This is the McSPI Controller ISR and can be used as IRQ handler in Controller mode.
MCSPI_lld_readWriteIntr
int32_t MCSPI_lld_readWriteIntr(MCSPILLD_Handle hMcspi, void *txBuf, void *rxBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API reads writes data from the McSPI instance in Interrupt mode.
MCSPI_ChConfig::bitRate
uint32_t bitRate
Definition: mcspi_lld.h:575
MCSPILLD_InitObject::transferCallbackFxn
MCSPI_transferCallbackFxn transferCallbackFxn
Definition: mcspi_lld.h:724
MCSPI_lld_read
int32_t MCSPI_lld_read(MCSPILLD_Handle hMcspi, void *rxBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API reads data from the McSPI instance in Polling mode.
MCSPI_lld_Transaction_init
static void MCSPI_lld_Transaction_init(MCSPI_Transaction *trans)
Function to initialize the MCSPI_Transaction struct to its defaults.
Definition: mcspi_lld.h:1313
MCSPILLD_Object
MCSPI driver object.
Definition: mcspi_lld.h:734
MCSPI_SB_POL_LOW
#define MCSPI_SB_POL_LOW
Start-bit polarity is held to 0 during MCSPI transfer.
Definition: mcspi_lld.h:310
MCSPI_Transaction::timeout
uint32_t timeout
Definition: mcspi_lld.h:519
MCSPI_errorCallbackFxn
void(* MCSPI_errorCallbackFxn)(void *args)
The definition of a error callback function used by the SPI driver when used in MCSPI_TRANSFER_MODE_C...
Definition: mcspi_lld.h:628
MCSPI_readRxDataReg
static uint32_t MCSPI_readRxDataReg(uint32_t baseAddr, uint32_t chNum)
This API will return the data present in the MCSPI_RX register.
Definition: mcspi_lld.h:1406
MCSPI_DPE_ENABLE
#define MCSPI_DPE_ENABLE
Data line selected for transmission.
Definition: mcspi_lld.h:284
MCSPI_DmaHandle
void * MCSPI_DmaHandle
Definition: mcspi_lld.h:71
MCSPI_Transaction::csDisable
uint32_t csDisable
Definition: mcspi_lld.h:479
MCSPI_IS_D1
#define MCSPI_IS_D1
Data line 1 (SPIDAT[1]) selected for reception.
Definition: mcspi_lld.h:274
MCSPI_ChObject::chCtrlRegVal
uint32_t chCtrlRegVal
Definition: mcspi_lld.h:688
MCSPILLD_InitHandle
struct MCSPILLD_InitObject * MCSPILLD_InitHandle
MCSPI_lld_peripheralIsr
void MCSPI_lld_peripheralIsr(void *args)
This is the McSPI Peripheral ISR and can be used as IRQ handler in Peripheral mode.
MCSPI_CHRX
#define MCSPI_CHRX(x)
Base address of McSPI_CHRX(x)
Definition: mcspi_lld.h:439
MCSPI_lld_writeDma
int32_t MCSPI_lld_writeDma(MCSPILLD_Handle hMcspi, void *txBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API writes data to the McSPI instance in DMA mode.
MCSPI_ChConfig::trMode
uint32_t trMode
Definition: mcspi_lld.h:579
MCSPILLD_Object::hMcspiInit
MCSPILLD_InitHandle hMcspiInit
Definition: mcspi_lld.h:745
MCSPI_TR_MODE_TX_RX
#define MCSPI_TR_MODE_TX_RX
Definition: mcspi_lld.h:260
MCSPI_CHSTAT
#define MCSPI_CHSTAT(x)
Base address of McSPI_CHSTAT(x)
Definition: mcspi_lld.h:427
MCSPI_CHANNEL_0
#define MCSPI_CHANNEL_0
Definition: mcspi_lld.h:161
MCSPILLD_Object::transferChannel
uint32_t transferChannel
Definition: mcspi_lld.h:753
MCSPI_lld_ChConfig_init
static void MCSPI_lld_ChConfig_init(MCSPI_ChConfig *chConfig)
Function to initialize the MCSPI_ChConfig struct to its defaults.
Definition: mcspi_lld.h:1293
MCSPI_ChObject::isOpen
uint32_t isOpen
Definition: mcspi_lld.h:650
MCSPI_readChCtrlReg
static uint32_t MCSPI_readChCtrlReg(uint32_t baseAddr, uint32_t chNum)
This API returns Channel control register value.
Definition: mcspi_lld.h:1354
MCSPILLD_Object::state
uint32_t state
Definition: mcspi_lld.h:741
MCSPI_lld_initDma
int32_t MCSPI_lld_initDma(MCSPILLD_Handle hMcspi)
This API Initializes the McSPI instance in DMA Mode.
MCSPI_lld_deInitDma
int32_t MCSPI_lld_deInitDma(MCSPILLD_Handle hMcspi)
This API De-Initializes the McSPI instance in DMA mode.
MCSPI_lld_transfer
int32_t MCSPI_lld_transfer(MCSPILLD_Handle hMcspi, MCSPI_Transaction *transaction)
This API transfers data from the McSPI instance in Polling mode.
MCSPI_ChObject::curRxWords
uint32_t curRxWords
Definition: mcspi_lld.h:664
MCSPI_lld_transferDmaCancel
int32_t MCSPI_lld_transferDmaCancel(MCSPILLD_Handle hMcspi)
This API cancels current McSPI transfer in DMA mode.
MCSPI_lld_init
int32_t MCSPI_lld_init(MCSPILLD_Handle hMcspi)
This API Initializes the McSPI instance.
MCSPI_clearAllIrqStatus
void MCSPI_clearAllIrqStatus(uint32_t baseAddr)
MCSPI_lld_transferDma
int32_t MCSPI_lld_transferDma(MCSPILLD_Handle hMcspi, MCSPI_Transaction *transaction)
This API reads data from the McSPI instance in DMA mode.
MCSPI_enableRxFIFO
static void MCSPI_enableRxFIFO(uint32_t baseAddr, uint32_t chNum, uint32_t enableFlag)
This API will enable/disable the Rx FIFOs of McSPI peripheral.
Definition: mcspi_lld.h:1395
MCSPI_intrStatusClear
static void MCSPI_intrStatusClear(const MCSPI_ChObject *chObj, uint32_t baseAddr, uint32_t intFlags)
Definition: mcspi_lld.h:776
MCSPI_ChConfig::csPolarity
uint32_t csPolarity
Definition: mcspi_lld.h:577
MCSPI_ChConfig::startBitPolarity
uint32_t startBitPolarity
Definition: mcspi_lld.h:593
MCSPI_ChConfig::turboEnable
uint32_t turboEnable
Definition: mcspi_lld.h:596
MCSPI_ExtendedParams::channel
uint32_t channel
Definition: mcspi_lld.h:536
MCSPILLD_Object::transferMutex
void * transferMutex
Definition: mcspi_lld.h:743
MCSPILLD_InitObject::multiWordAccess
uint32_t multiWordAccess
Definition: mcspi_lld.h:712
MCSPI_reset
void MCSPI_reset(uint32_t baseAddr)
MCSPI_lld_writeIntr
int32_t MCSPI_lld_writeIntr(MCSPILLD_Handle hMcspi, void *txBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API writes data to the McSPI instance in Interrupt mode.
MCSPI_ChObject::csDisable
uint32_t csDisable
Definition: mcspi_lld.h:652
MCSPI_Transaction::args
void * args
Definition: mcspi_lld.h:517
MCSPI_ChObject::dataWidthBitMask
uint32_t dataWidthBitMask
Definition: mcspi_lld.h:676
MCSPI_ExtendedParams
Data structure used with MCSPI_lld_read(), MCSPI_lld_readIntr(), MCSPI_lld_readDma(),...
Definition: mcspi_lld.h:535
MCSPI_ExtendedParams::dataSize
uint32_t dataSize
Definition: mcspi_lld.h:545
MCSPI_ChConfig::startBitEnable
uint32_t startBitEnable
Definition: mcspi_lld.h:590
MCSPI_Transaction::txBuf
void * txBuf
Definition: mcspi_lld.h:499
MCSPI_CHCTRL
#define MCSPI_CHCTRL(x)
Base address of McSPI_CHCTRL(x)
Definition: mcspi_lld.h:431
MCSPILLD_InitObject::chMode
uint32_t chMode
Definition: mcspi_lld.h:706
MCSPI_lld_reConfigFifo
int32_t MCSPI_lld_reConfigFifo(MCSPILLD_Handle handle, uint32_t chNum, uint32_t numWordsRxTx)
Function to re-configure Effective FIFO Words.
MCSPI_Transaction::rxBuf
void * rxBuf
Definition: mcspi_lld.h:510
MCSPI_ChObject::systRegVal
uint32_t systRegVal
Definition: mcspi_lld.h:690
MCSPI_ChObject::effRxFifoDepth
uint32_t effRxFifoDepth
Definition: mcspi_lld.h:680
MCSPI_MAX_NUM_CHANNELS
#define MCSPI_MAX_NUM_CHANNELS
Max number of channels/Chip Select (CS) supported.
Definition: mcspi_lld.h:181
MCSPI_Transaction::dataSize
uint32_t dataSize
Definition: mcspi_lld.h:485
MCSPI_lld_write
int32_t MCSPI_lld_write(MCSPILLD_Handle hMcspi, void *txBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API writes data to the McSPI instance in Polling mode.
MCSPI_ChObject::curTxWords
uint32_t curTxWords
Definition: mcspi_lld.h:660
MCSPILLD_InitObject::mcspiDmaHandle
MCSPI_DmaHandle mcspiDmaHandle
Definition: mcspi_lld.h:720
MCSPI_ChConfig::slvCsSelect
uint32_t slvCsSelect
Definition: mcspi_lld.h:587
MCSPI_lld_deInit
int32_t MCSPI_lld_deInit(MCSPILLD_Handle hMcspi)
This API De-Initializes the McSPI instance.
MCSPI_readChStatusReg
static uint32_t MCSPI_readChStatusReg(uint32_t baseAddr, uint32_t chNum)
This API will return the status of the McSPI channel currently in use.
Definition: mcspi_lld.h:1348
MCSPI_stop
void MCSPI_stop(MCSPILLD_Handle hMcspi, MCSPI_ChObject *chObj, uint32_t chNum)
MCSPI_ChObject::bufWidthShift
uint8_t bufWidthShift
Definition: mcspi_lld.h:670
MCSPILLD_Object::transaction
MCSPI_Transaction transaction
Definition: mcspi_lld.h:759
MCSPILLD_Handle
struct MCSPILLD_Object * MCSPILLD_Handle
MCSPI_lld_readWriteDma
int32_t MCSPI_lld_readWriteDma(MCSPILLD_Handle hMcspi, void *txBuf, void *rxBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API reads writes data from the McSPI instance in DMA mode.
MCSPI_ExtendedParams::csDisable
uint32_t csDisable
Definition: mcspi_lld.h:539
MCSPI_ChObject::curRxBufPtr
uint8_t * curRxBufPtr
Definition: mcspi_lld.h:658
MCSPI_lld_readIntr
int32_t MCSPI_lld_readIntr(MCSPILLD_Handle hMcspi, void *rxBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API reads data from the McSPI instance in Interrupt mode.
MCSPI_CS_POL_LOW
#define MCSPI_CS_POL_LOW
SPIEN (CS) is held low during the ACTIVE state.
Definition: mcspi_lld.h:251
MCSPILLD_Object::args
void * args
Definition: mcspi_lld.h:761
MCSPI_lld_readWrite
int32_t MCSPI_lld_readWrite(MCSPILLD_Handle hMcspi, void *txBuf, void *rxBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API reads writes data from the McSPI instance in polling mode.
MCSPI_ChConfig::defaultTxData
uint32_t defaultTxData
Definition: mcspi_lld.h:601
MCSPI_ChConfig::dpe1
uint32_t dpe1
Definition: mcspi_lld.h:585
MCSPILLD_InitObject::msMode
uint32_t msMode
Definition: mcspi_lld.h:714
MCSPI_ChObject::csEnable
uint32_t csEnable
Definition: mcspi_lld.h:654
MCSPILLD_InitObject::operMode
uint32_t operMode
Definition: mcspi_lld.h:702
MCSPI_writeChCtrlReg
static void MCSPI_writeChCtrlReg(uint32_t baseAddr, uint32_t chNum, uint32_t regVal)
This API sets Channel control register value.
Definition: mcspi_lld.h:1359
MCSPI_ChObject::chCfg
MCSPI_ChConfig * chCfg
Definition: mcspi_lld.h:642
MCSPI_readChConf
static uint32_t MCSPI_readChConf(uint32_t baseAddr, uint32_t chNum)
This API returns Channel Config register value.
Definition: mcspi_lld.h:1365
MCSPI_ChObject::dmaChCfg
MCSPI_DmaChConfig dmaChCfg
Definition: mcspi_lld.h:684
MCSPI_Transaction::channel
uint32_t channel
Definition: mcspi_lld.h:476
MCSPI_transferCallbackFxn
void(* MCSPI_transferCallbackFxn)(void *args, uint32_t tansferStatus)
The definition of a transfer completion callback function used by the SPI driver when used in MCSPI_T...
Definition: mcspi_lld.h:620
MCSPI_lld_readDma
int32_t MCSPI_lld_readDma(MCSPILLD_Handle hMcspi, void *rxBuf, uint32_t count, uint32_t timeout, const MCSPI_ExtendedParams *extendedParams)
This API reads data from the McSPI instance in DMA mode.
MCSPI_lld_transferIntr
int32_t MCSPI_lld_transferIntr(MCSPILLD_Handle hMcspi, MCSPI_Transaction *transaction)
This API reads data from the McSPI instance in Interrupt mode.
MCSPI_ChConfig::inputSelect
uint32_t inputSelect
Definition: mcspi_lld.h:581
MCSPILLD_Object::baseAddr
uint32_t baseAddr
Definition: mcspi_lld.h:735
MCSPI_ChConfig::dpe0
uint32_t dpe0
Definition: mcspi_lld.h:583
MCSPI_setChDataSize
void MCSPI_setChDataSize(uint32_t baseAddr, MCSPI_ChObject *chObj, uint32_t dataSize, uint32_t csDisable)
MCSPI_lld_getState
int32_t MCSPI_lld_getState(MCSPILLD_Handle hMcspi)
This API returns the driver state.
MCSPI_ChConfig
MCSPI configuration parameters for the channel.
Definition: mcspi_lld.h:570
MCSPI_writeChConfReg
static void MCSPI_writeChConfReg(uint32_t baseAddr, uint32_t chNum, uint32_t regVal)
This API sets Channel Config register value.
Definition: mcspi_lld.h:1370
MCSPILLD_InitObject::errorCallbackFxn
MCSPI_errorCallbackFxn errorCallbackFxn
Definition: mcspi_lld.h:726
MCSPILLD_Object::transferCsDisable
uint32_t transferCsDisable
Definition: mcspi_lld.h:755
MCSPILLD_InitObject::initDelay
uint32_t initDelay
Definition: mcspi_lld.h:710
MCSPI_setDataWidth
static void MCSPI_setDataWidth(uint32_t baseAddr, uint32_t chNum, uint32_t dataWidth)
This API will set the data width in the channel config register.
Definition: mcspi_lld.h:1412
MCSPILLD_InitObject::inputClkFreq
uint32_t inputClkFreq
Definition: mcspi_lld.h:698
MCSPI_ChConfig::frameFormat
uint32_t frameFormat
Definition: mcspi_lld.h:573
MCSPI_ChConfig::csIdleTime
uint32_t csIdleTime
Definition: mcspi_lld.h:598
MCSPI_DmaChConfig
void * MCSPI_DmaChConfig
Definition: mcspi_lld.h:73
MCSPI_ChConfig::chNum
uint32_t chNum
Definition: mcspi_lld.h:571