sci_lin.h

Go to the documentation of this file.

/*
 * Copyright (C) 2025 Texas Instruments Incorporated
 *
 * 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 SCI_LIN_V0_H_
#define SCI_LIN_V0_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <kernel/dpl/HwiP.h>
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_soc.h>
#include <drivers/hw_include/cslr_lin.h>
#include <drivers/hw_include/hw_types.h>
#include <kernel/dpl/CacheP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
typedef struct LIN_Config_ts        *LIN_Handle;
 
typedef void                        *LIN_DmaChConfig;
 
typedef void                        *LIN_DmaHandle;
 
/* ========================================================================== */
/*                                   Enums                                    */
/* ========================================================================== */
 
typedef enum
{
    LIN_OPER_MODE_POLLING           = 0x00U,
    LIN_OPER_MODE_INTERRUPT         = 0x01U,
    LIN_OPER_MODE_DMA               = 0x02U
} LIN_OperationalMode;
 
typedef enum
{
    LIN_TRANSFER_MODE_BLOCKING      = 0x00U,
    LIN_TRANSFER_MODE_CALLBACK      = 0x01U
} LIN_TransferMode;
 
typedef enum
{
    LIN_MODULE_OP_MODE_LIN          = 0x01U,
    LIN_MODULE_OP_MODE_SCI          = 0x00U
} LIN_HLD_ModuleMode;
 
typedef enum
{
    LIN_MODE_HLD_LIN_COMMANDER      = 0x01U,
    LIN_MODE_HLD_LIN_RESPONDER      = 0x00U
} LIN_HLD_LinMode;
 
typedef enum
{
    LIN_COMM_HLD_LIN_ID4ID5LENCTL   = 0x01U,
    LIN_COMM_HLD_LIN_USELENGTHVAL   = 0x00U,
    LIN_COMM_HLD_SCI_ADDRBITMODE    = 0x01U,
    LIN_COMM_HLD_SCI_IDLELINEMODE   = 0x00U
} LIN_HLD_CommMode;
 
typedef enum
{
    LIN_HLD_DEBUG_FROZEN            = 0x00U,
    LIN_HLD_DEBUG_COMPLETE          = 0x01U
} LIN_HLD_DebugMode;
 
typedef enum
{
    LIN_HLD_CHECKSUM_CLASSIC        = 0x00U,
    LIN_HLD_CHECKSUM_ENHANCED       = 0x01U
} LIN_HLD_ChecksumType;
 
typedef enum
{
    LIN_HLD_MSG_FILTER_IDBYTE       = 0x00U,
    LIN_HLD_MSG_FILTER_IDRESPONDER  = 0x01U
} LIN_HLD_MaskFilterType;
 
typedef enum
{
    LIN_HLD_SCI_PARITY_ODD          = 0x00U,
    LIN_HLD_SCI_PARITY_EVEN         = 0x01U
} LIN_HLD_SCIParityType;
 
typedef enum
{
    LIN_HLD_SCI_STOP_BITS_1         = 0x00U,
    LIN_HLD_SCI_STOP_BITS_2         = 0x01U
} LIN_HLD_SCIStopBits;
 
typedef enum
{
    LIN_HLD_LOOPBACK_INTERNAL       = 0x00U,
    LIN_HLD_LOOPBACK_EXTERNAL       = 0x01U
} LIN_HLD_LoopbackMode;
 
typedef enum
{
    LIN_HLD_LOOPBACK_DIGITAL        = 0x00U,
    LIN_HLD_LOOPBACK_ANALOG         = 0x01U
} LIN_HLD_LoopbackType;
 
typedef enum
{
 
    LIN_HLD_ANALOG_LOOP_TX          = 0x00U,
    LIN_HLD_ANALOG_LOOP_RX          = 0x01U
} LIN_HLD_LoopbackPath;
 
typedef enum
{
    LIN_HLD_SYNC_DELIMITER_LEN_1    = 0x0U,
    LIN_HLD_SYNC_DELIMITER_LEN_2    = 0x1U,
    LIN_HLD_SYNC_DELIMITER_LEN_3    = 0x2U,
    LIN_HLD_SYNC_DELIMITER_LEN_4    = 0x3U,
} LIN_HLD_Sync_Delimiter;
 
typedef enum
{
    LIN_HLD_SYNC_BREAK_LEN_13       = 0x0U,
    LIN_HLD_SYNC_BREAK_LEN_14       = 0x1U,
    LIN_HLD_SYNC_BREAK_LEN_15       = 0x2U,
    LIN_HLD_SYNC_BREAK_LEN_16       = 0x3U,
    LIN_HLD_SYNC_BREAK_LEN_17       = 0x4U,
    LIN_HLD_SYNC_BREAK_LEN_18       = 0x5U,
    LIN_HLD_SYNC_BREAK_LEN_19       = 0x6U,
    LIN_HLD_SYNC_BREAK_LEN_20       = 0x7U,
} LIN_HLD_Sync_Break;
 
typedef enum
{
    LIN_HLD_TXN_STS_SUCCESS         = 0x00U,
    LIN_HLD_TXN_STS_FAILURE         = 0x01U,
    LIN_HLD_TXN_STS_TIMEOUT         = 0x02U,
    LIN_HLD_TXN_PHY_BUS_ERR         = 0x03U,
    LIN_HLD_TXN_FRAMING_ERR         = 0x04U,
    LIN_HLD_TXN_OVERRUN_ERR         = 0x05U,
    LIN_HLD_TXN_PARITY_ERR          = 0x06U,
    LIN_HLD_TXN_CHECKSUM_ERR        = 0x07U,
    LIN_HLD_TXN_NO_RES_ERR          = 0x08U,
    LIN_HLD_TXN_BIT_ERR             = 0x09U,
} LIN_HLD_Txn_Status;
 
typedef enum
{
    LIN_HLD_TXN_TYPE_WRITE          = 0x00U,
    LIN_HLD_TXN_TYPE_READ           = 0x01U,
} LIN_HLD_Txn_Type;
 
typedef enum
{
    LIN_HLD_STATE_RESET             = (uint8_t)0U,
    LIN_HLD_STATE_IDLE              = (uint8_t)1U,
    LIN_HLD_STATE_BUSY              = (uint8_t)2U,
    LIN_HLD_STATE_ERROR             = (uint8_t)3U,
} LIN_HLD_State;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct LIN_HwAttrs_ts
{
    uint32_t                        baseAddr;
    uint32_t                        intrNum0;
    uint32_t                        intrNum1;
    LIN_OperationalMode             opMode;
    uint8_t                         intrPriority;
    LIN_HLD_DebugMode               debugMode;
    uint32_t                        linClk;
    bool                            enableLoopback;
    LIN_HLD_LoopbackMode            loopBackMode;
    LIN_HLD_LoopbackType            loopBackType;
 
} LIN_HwAttrs;
 
typedef struct LIN_BaudConfigParams_ts
{
    uint32_t                        preScaler;
    uint8_t                         fracDivSel_M;
    uint8_t                         supFracDivSel_U;
 
} LIN_BaudConfigParams;
 
typedef struct LIN_SCI_Frame_ts
{
    uint8_t                         id;
    uint8_t                         frameLen;
    void                            *dataBuf;
    LIN_HLD_Txn_Type                txnType;
    uint32_t                        timeout;
    LIN_HLD_Txn_Status              status;
    void                            *args;
 
} LIN_SCI_Frame;
 
/* ========================================================================== */
/*                      Function Pointers Declarations                        */
/* ========================================================================== */
 
typedef void (*LIN_IdMatchCallbackFxn) (LIN_Handle handle,
                                        LIN_SCI_Frame *frame);
 
typedef void (*LIN_TransferCompleteCallbackFxn) (LIN_Handle handle,
                                                 LIN_SCI_Frame *frame);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct LIN_SciConfigParams_ts
{
    LIN_HLD_SCIParityType           parityType;
    LIN_HLD_SCIStopBits             stopBits;
    uint8_t                         dataBits;
    LIN_TransferCompleteCallbackFxn transferCompleteCallbackFxn;
 
} LIN_SciConfigParams;
 
typedef struct LIN_LinConfigParams_ts
{
    LIN_HLD_LinMode                 linMode;
    LIN_HLD_MaskFilterType          maskFilteringType;
    uint8_t                         linTxMask;
    uint8_t                         linRxMask;
    LIN_HLD_ChecksumType            checksumType;
    bool                            adaptModeEnable;
    uint32_t                        maxBaudRate;
    LIN_HLD_Sync_Delimiter          syncDelimiter;
    LIN_HLD_Sync_Break              syncBreak;
    LIN_IdMatchCallbackFxn          idMatchCallbackFxn;
    LIN_TransferCompleteCallbackFxn transferCompleteCallbackFxn;
 
} LIN_LinConfigParams;
 
typedef struct LIN_OpenParams_ts
{
    LIN_TransferMode                transferMode;
    LIN_HLD_ModuleMode              moduleMode;
    bool                            enableParity;
    LIN_HLD_CommMode                commMode;
    bool                            multiBufferMode;
    LIN_BaudConfigParams            baudConfigParams;
    LIN_SciConfigParams             sciConfigParams;
    LIN_LinConfigParams             linConfigParams;
 
} LIN_OpenParams;
 
typedef struct LIN_Object_ts
{
    SemaphoreP_Object               mutex;
    HwiP_Object                     hwiObj0;
    HwiP_Object                     hwiObj1;
    LIN_HLD_State                   state;
    bool                            isOpen;
    LIN_OpenParams                  *openParams;
    LIN_DmaHandle                   linDmaHandle;
    LIN_DmaChConfig                 dmaChCfg;
    LIN_SCI_Frame                   *currentTxnFrame;
    uint8_t                         *writeBufIdx;
    uint32_t                        writeCountIdx;
    uint8_t                         *readBufIdx __attribute__((aligned(CacheP_CACHELINE_ALIGNMENT)));
    uint32_t                        readCountIdx __attribute__((aligned(CacheP_CACHELINE_ALIGNMENT)));
    uint8_t                         tempBuffer[8] __attribute__((aligned(CacheP_CACHELINE_ALIGNMENT)));
    SemaphoreP_Object               writeFrmCompSemObj;
    SemaphoreP_Object               readFrmCompSemObj;
 
} LIN_Object;
 
typedef struct LIN_Config_ts
{
    LIN_Object                      *object;
    LIN_HwAttrs const               *hwAttrs;
 
} LIN_Config;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void LIN_init(void);
 
void LIN_deinit(void);
 
void LIN_Params_init(LIN_OpenParams *openParams);
 
LIN_Handle LIN_open(uint32_t index, LIN_OpenParams *openParams);
 
void LIN_close(LIN_Handle handle);
 
void LIN_SCI_Frame_init(LIN_SCI_Frame *frame);
 
int32_t LIN_SCI_transferFrame(LIN_Handle handle, LIN_SCI_Frame *frame);
 
LIN_Handle LIN_getHandle(uint32_t index);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* SCI_LIN_V0_H_ */