ADM/GW/RTD/include/Lpuart_Lin_Ip_Hw_Access.h
2024-08-08 10:00:15 +09:00

850 lines
31 KiB
C

/*==================================================================================================
* Project : RTD AUTOSAR 4.4
* Platform : CORTEXM
* Peripheral : LPUART
* Dependencies : none
*
* Autosar Version : 4.4.0
* Autosar Revision : ASR_REL_4_4_REV_0000
* Autosar Conf.Variant :
* SW Version : 0.9.0
* Build Version : S32K3_RTD_0_9_0__ASR_REL_4_4_REV_0000_20210326
*
* (c) Copyright 2020 - 2021 NXP Semiconductors
* All Rights Reserved.
*
* NXP Confidential. This software is owned or controlled by NXP and may only be
* used strictly in accordance with the applicable license terms. By expressly
* accepting such terms or by downloading, installing, activating and/or otherwise
* using the software, you are agreeing that you have read, and that you agree to
* comply with and are bound by, such license terms. If you do not agree to be
* bound by the applicable license terms, then you may not retain, install,
* activate or otherwise use the software.
==================================================================================================*/
#ifndef LPUART_HW_ACCESS_H
#define LPUART_HW_ACCESS_H
/**
* @file
* @internal
* @defgroup lpuart_lin_ip Lpuart Lin IPL
* @addtogroup lpuart_lin_ip Lpuart Lin IPL
* @{
*/
#ifdef __cplusplus
extern "C"{
#endif
/*==================================================================================================
* INCLUDE FILES
* 1) system and project includes
* 2) needed interfaces from external units
* 3) internal and external interfaces from this unit
==================================================================================================*/
#include "S32K344_LPUART.h"
#include "StandardTypes.h"
#include "OsIf.h"
#include "Lpuart_Lin_Ip_Cfg.h"
#include "SchM_Lin.h"
#if (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT)
#include "Devassert.h"
#endif /* (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT) */
/*==================================================================================================
* SOURCE FILE VERSION INFORMATION
==================================================================================================*/
#define LPUART_LIN_IP_HW_ACCESS_VENDOR_ID 43
#define LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MAJOR_VERSION 4
#define LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MINOR_VERSION 4
#define LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_REVISION_VERSION 0
#define LPUART_LIN_IP_HW_ACCESS_SW_MAJOR_VERSION 0
#define LPUART_LIN_IP_HW_ACCESS_SW_MINOR_VERSION 9
#define LPUART_LIN_IP_HW_ACCESS_SW_PATCH_VERSION 0
/*==================================================================================================
* FILE VERSION CHECKS
==================================================================================================*/
#if (LPUART_LIN_IP_HW_ACCESS_VENDOR_ID != LPUART_LIN_IP_CFG_VENDOR_ID)
#error "Lpuart_Lin_Ip_Hw_Access.h and Lpuart_Lin_Ip_Types.h have different vendor ids"
#endif
/* Check if current file and Lpuart_Lin_Ip_Cfg header file are of the same Autosar version */
#if ((LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MAJOR_VERSION != LPUART_LIN_IP_CFG_AR_RELEASE_MAJOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MINOR_VERSION != LPUART_LIN_IP_CFG_AR_RELEASE_MINOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_REVISION_VERSION != LPUART_LIN_IP_CFG_AR_RELEASE_REVISION_VERSION) )
#error "Software Version Numbers of Lpuart_Lin_Ip_Hw_Access.c and Lpuart_Lin_Ip_Cfg.h are different"
#endif
/* Check if current file and Lpuart_Lin_Ip_Types header file are of the same Software version */
#if ((LPUART_LIN_IP_HW_ACCESS_SW_MAJOR_VERSION != LPUART_LIN_IP_CFG_SW_MAJOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_SW_MINOR_VERSION != LPUART_LIN_IP_CFG_SW_MINOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_SW_PATCH_VERSION != LPUART_LIN_IP_CFG_SW_PATCH_VERSION) )
#error "Software Version Numbers of Lpuart_Lin_Ip_Hw_Access.h and Lpuart_Lin_Ip_Cfg.h are different"
#endif
#ifndef DISABLE_MCAL_INTERMODULE_ASR_CHECK
/* Check if current file and StandardTypes.h header file are of the same Autosar version */
#if ((LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MAJOR_VERSION != STD_AR_RELEASE_MAJOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MINOR_VERSION != STD_AR_RELEASE_MINOR_VERSION))
#error "AutoSar Version Numbers of Lpuart_Lin_Ip_Hw_Access.h and StandardTypes.h are different"
#endif
/* Check if current file and OsIf.h header file are of the same Autosar version */
#if ((LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MAJOR_VERSION != OSIF_AR_RELEASE_MAJOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MINOR_VERSION != OSIF_AR_RELEASE_MINOR_VERSION))
#error "AutoSar Version Numbers of Lpuart_Lin_Ip_Hw_Access.h and OsIf.h are different"
#endif
/* Check if current file and SchM_Lin.h header file are of the same Autosar version */
#if ((LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MAJOR_VERSION != SCHM_LIN_AR_RELEASE_MAJOR_VERSION) || \
(LPUART_LIN_IP_HW_ACCESS_AR_RELEASE_MINOR_VERSION != SCHM_LIN_AR_RELEASE_MINOR_VERSION))
#error "AutoSar Version Numbers of Lpuart_Lin_Ip_Hw_Access.h and SchM_Lin.h are different"
#endif
#endif
/*==================================================================================================
* CONSTANTS
==================================================================================================*/
/*==================================================================================================
* DEFINES AND MACROS
==================================================================================================*/
#if (LPUART_LIN_IP_DEV_ERROR_DETECT == STD_ON)
#define LPUART_LIN_IP_DEV_ASSERT(x) DevAssert(x)
#endif
/**
* @internal
* @brief Lpuart shift using for read/write 16 bits of a register.
*
*
*/
#define LPUART_LIN_IP_SHIFT (16U)
/**
* @internal
* @brief Macro indicating BAUD register.
*
*
*/
#define LPUART_LIN_IP_BAUD_REG_ID (1U)
/**
* @internal
* @brief Macro indicating STAT register.
*
*
*/
#define LPUART_LIN_IP_STAT_REG_ID (2U)
/**
* @internal
* @brief Macro indicating CTRL register.
*
*
*/
#define LPUART_LIN_IP_CTRL_REG_ID (3U)
/**
* @internal
* @brief Macro indicating DATA register.
*
*
*/
#define LPUART_LIN_IP_DATA_REG_ID (4U)
/**
* @internal
* @brief Flag clearance mask for STAT register.
*
*
*/
#define LPUART_LIN_IP_STAT_REG_FLAGS_MASK (0xC01FC000U)
/**
* @internal
* @brief Default oversampling ratio.
*
*
*/
#define LPUART_LIN_IP_DEFAULT_OSR (0x0FUL)
/**
* @internal
* @brief Default baud rate modulo divisor.
*
*
*/
#define LPUART_LIN_IP_DEFAULT_SBR (0x04UL)
/**
* @internal
* @brief Has extended data register ED.
*
*
*/
#define LPUART_LIN_IP_HAS_EXTENDED_DATA_REGISTER_FLAGS (1U)
/**
* @internal
* @brief Mask for all used interrupt flags.
*
*
*/
#define LPUART_LIN_IP_STAT_ALL_INT_FLAGS_MASK_U32 ( (uint32)LPUART_STAT_LBKDIF_MASK \
| (uint32)LPUART_STAT_RXEDGIF_MASK \
| (uint32)LPUART_STAT_IDLE_MASK \
| (uint32)LPUART_STAT_OR_MASK \
| (uint32)LPUART_STAT_NF_MASK \
| (uint32)LPUART_STAT_FE_MASK \
| (uint32)LPUART_STAT_PF_MASK \
)
/*==================================================================================================
* CONSTANTS
==================================================================================================*/
/*==================================================================================================
* DEFINES AND MACROS
==================================================================================================*/
/**
* @internal
* @brief LPUART number of bits in a character
*
*
*/
typedef enum
{
LPUART_LIN_IP_8_BITS_PER_CHAR = 0x0U, /**< 8-bit data characters */
LPUART_LIN_IP_9_BITS_PER_CHAR = 0x1U, /**< 9-bit data characters */
LPUART_LIN_IP_10_BITS_PER_CHAR = 0x2U /**< 10-bit data characters */
} Lpuart_Lin_Ip_BitCountPerCharType;
/**
* @internal
* @brief LPUART parity mode
*
*
*/
typedef enum
{
LPUART_LIN_IP_PARITY_DISABLED = 0x0U, /**< parity disabled */
LPUART_LIN_IP_PARITY_EVEN = 0x2U, /**< parity enabled, type even, bit setting: PE|PT = 10 */
LPUART_LIN_IP_PARITY_ODD = 0x3U /**< parity enabled, type odd, bit setting: PE|PT = 11 */
} Lpuart_Lin_Ip_ParityModeType;
/**
* @internal
* @brief LPUART stop bits
*
*
*/
typedef enum
{
LPUART_LIN_IP_ONE_STOP_BIT = 0x0U, /**< one stop bit */
LPUART_LIN_IP_TWO_STOP_BIT = 0x1U /**< two stop bits */
} Lpuart_Lin_Ip_StopBitCountType;
/**
* @internal
* @brief LPUART status flags.
* @details This provides constants for the LPUART status flags for use in the UART functions.
*
*
*/
typedef enum
{
LPUART_LIN_IP_ALL_INT_FLAGS = ((uint32)0x00U), \
/**< All status flag */
LPUART_LIN_IP_TX_DATA_REG_EMPTY = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_TDRE_SHIFT), \
/**< Tx data register empty flag, sets when Tx buffer is empty */
LPUART_LIN_IP_TX_COMPLETE = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_TC_SHIFT), \
/**< Transmission complete flag, sets when transmission activity complete */
LPUART_LIN_IP_RX_DATA_REG_FULL = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_RDRF_SHIFT), \
/**< Rx data register full flag, sets when the receive data buffer is full */
LPUART_LIN_IP_IDLE_LINE_DETECT = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_IDLE_SHIFT), \
/**< Idle line detect flag, sets when idle line detected */
LPUART_LIN_IP_RX_OVERRUN = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_OR_SHIFT), \
/**< Rx Overrun sets if new data is received before data is read */
LPUART_LIN_IP_NOISE_DETECT = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_NF_SHIFT), \
/**< Rx takes 3 samples of each received bit. If these differ, the flag sets */
LPUART_LIN_IP_FRAME_ERR = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_FE_SHIFT), \
/**< Frame error flag, sets if logic 0 was detected where stop bit expected */
LPUART_LIN_IP_PARITY_ERR = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_PF_SHIFT), \
/**< If parity enabled, sets upon parity error detection */
LPUART_LIN_IP_BREAK_DETECT = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_LBKDIF_SHIFT), \
/**< LIN break detect interrupt flag, sets when LIN break char detected */
LPUART_LIN_IP_RX_ACTIVE_EDGE_DETECT = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_RXEDGIF_SHIFT), \
/**< Rx pin active edge interrupt flag, sets when active edge detected */
LPUART_LIN_IP_RX_ACTIVE = (((uint32)LPUART_LIN_IP_STAT_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_STAT_RAF_SHIFT), \
/**< Receiver Active Flag (RAF), sets at beginning of valid start bit */
LPUART_LIN_IP_NOISE_IN_CURRENT_WORD = (((uint32)LPUART_LIN_IP_DATA_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_DATA_NOISY_SHIFT), \
/**< NOISY bit, sets if noise detected in current data word */
LPUART_LIN_IP_PARITY_ERR_IN_CURRENT_WORD = (((uint32)LPUART_LIN_IP_DATA_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_DATA_PARITYE_SHIFT), \
/**< PARITYE bit, sets if noise detected in current data word */
} Lpuart_Lin_Ip_StatusFlagType;
/**
* @internal
* @brief LPUART interrupt configuration structure, default settings are 0 (disabled)
*
*
* */
typedef enum
{
LPUART_LIN_IP_INT_BREAK_DETECT = (((uint32)LPUART_LIN_IP_BAUD_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_BAUD_LBKDIE_SHIFT), /**< LIN break detect. */
LPUART_LIN_IP_INT_RX_ACTIVE_EDGE = (((uint32)LPUART_LIN_IP_BAUD_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_BAUD_RXEDGIE_SHIFT), /**< RX Active Edge. */
LPUART_LIN_IP_INT_TX_DATA_REG_EMPTY = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_TIE_SHIFT), /**< Transmit data register empty. */
LPUART_LIN_IP_INT_TX_COMPLETE = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_TCIE_SHIFT), /**< Transmission complete. */
LPUART_LIN_IP_INT_RX_DATA_REG_FULL = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_RIE_SHIFT), /**< Receiver data register full. */
LPUART_LIN_IP_INT_IDLE_LINE = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_ILIE_SHIFT), /**< Idle line. */
LPUART_LIN_IP_INT_RX_OVERRUN = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_ORIE_SHIFT), /**< Receiver Overrun. */
LPUART_LIN_IP_INT_NOISE_ERR_FLAG = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_NEIE_SHIFT), /**< Noise error flag. */
LPUART_LIN_IP_INT_FRAME_ERR_FLAG = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_FEIE_SHIFT), /**< Framing error flag. */
LPUART_LIN_IP_INT_PARITY_ERR_FLAG = (((uint32)LPUART_LIN_IP_CTRL_REG_ID << (uint32)LPUART_LIN_IP_SHIFT) \
| (uint32)LPUART_CTRL_PEIE_SHIFT), /**< Parity error flag. */
} Lpuart_Lin_Ip_InterruptType;
/*==================================================================================================
* STRUCTURES AND OTHER TYPEDEFS
==================================================================================================*/
/*==================================================================================================
* GLOBAL VARIABLE DECLARATIONS
==================================================================================================*/
/*==================================================================================================
* FUNCTION PROTOTYPES
==================================================================================================*/
#define LIN_START_SEC_CODE
#include "Lin_MemMap.h"
/**
* @internal
* @brief Lpuart_Lin_Ip_StartTimeout
*
* @details Checks for timeout condition
*
* @param[in] startTimeOut Current time counter (in microseconds)
* @param[in] timeoutTicksOut Time counter in ticks
* @param[in] timeoutUs LPUART Timeout value to check (in microseconds)
* @param[in] osifCounter Type of counter used by Osif
*
* @return void
*
*
*/
void Lpuart_Lin_Ip_StartTimeout(uint32 *startTimeOut, uint32 *timeoutTicksOut, uint32 timeoutUs, OsIf_CounterType osifCounter);
/**
* @internal
* @brief Lpuart_Lin_Ip_TimeoutExpired
*
* @details Checks for timeout expiration condition
*
* @param[in] startTime Current time counter (in microseconds)
* @param[in] timeoutTicks Time counter in ticks
* @param[in] osifCounter Type of counter used by Osif
*
* @return boolean
* @retval true : Timeout expired.
* @retval false : Timeout didn't expire.
*
*
*/
boolean Lpuart_Lin_Ip_TimeoutExpired(uint32 startTime, uint32 timeoutTicks, OsIf_CounterType osifCounter);
/**
* @internal
* @brief Initializes the LPUART controller.
* @details This function Initializes the LPUART controller to known state.
*
* @param[in] base LPUART base pointer.
*
* @return void
*
*
*/
void Lpuart_Lin_Ip_HwInit(LPUART_Type * base);
/**
* @internal
* @brief Enable/Disable the LPUART transmitter.
*
* @details This function enables or disables the LPUART transmitter, based on the
* parameter received.
*
* @param[in] base LPUART base pointer.
* @param[in] enable Enable(true) or disable(false) transmitter.
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetTransmitterCmd(LPUART_Type * base, boolean enable)
{
uint32 startTime;
uint32 timeoutTicks;
base->CTRL = (base->CTRL & ~LPUART_CTRL_TE_MASK) | ((enable ? 1UL : 0UL) << LPUART_CTRL_TE_SHIFT);
Lpuart_Lin_Ip_StartTimeout(&startTime, &timeoutTicks, LPUART_LIN_IP_TIMEOUT_VALUE_US, LPUART_LIN_IP_TIMEOUT_TYPE);
do
{
/* Wait for the register write operation to complete */
while((boolean)((base->CTRL & LPUART_CTRL_TE_MASK) != 0U) != enable) {}
}
while (!Lpuart_Lin_Ip_TimeoutExpired(startTime, timeoutTicks, LPUART_LIN_IP_TIMEOUT_TYPE));
}
/**
* @internal
* @brief Enable/Disable the LPUART receiver.
*
* @details This function enables or disables the LPUART receiver, based on the
* parameter received.
*
* @param[in] base LPUART base pointer
* @param[in] enable Enable(true) or disable(false) receiver.
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetReceiverCmd(LPUART_Type * base, boolean enable)
{
uint32 startTime;
uint32 timeoutTicks;
base->CTRL = (base->CTRL & ~LPUART_CTRL_RE_MASK) | ((enable ? 1UL : 0UL) << LPUART_CTRL_RE_SHIFT);
Lpuart_Lin_Ip_StartTimeout(&startTime, &timeoutTicks, LPUART_LIN_IP_TIMEOUT_VALUE_US, LPUART_LIN_IP_TIMEOUT_TYPE);
do
{
/* Wait for the register write operation to complete */
while((boolean)((base->CTRL & LPUART_CTRL_RE_MASK) != 0U) != enable) {}
}
while (!Lpuart_Lin_Ip_TimeoutExpired(startTime, timeoutTicks, LPUART_LIN_IP_TIMEOUT_TYPE));
}
/**
* @internal
* @brief Sets the LPUART baud rate modulo divisor.
*
* @details This function sets the LPUART baud rate modulo divisor.
*
*
* @param[in] base LPUART base pointer.
* @param[in] baudRateDivisor The baud rate modulo division "SBR"
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetBaudRateDivisor(LPUART_Type * base, uint32 baudRateDivisor)
{
uint32 baudRegValTemp;
#if (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT)
LPUART_LIN_IP_DEV_ASSERT((baudRateDivisor <= 0x1FFFU) && (baudRateDivisor >= 1U));
#endif /* (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT) */
baudRegValTemp = base->BAUD;
baudRegValTemp &= ~(LPUART_BAUD_SBR_MASK);
/* Removed the shift operation as the SBR field position is zero; shifting with 0 violates MISRA */
baudRegValTemp |= baudRateDivisor & LPUART_BAUD_SBR_MASK;
base->BAUD = baudRegValTemp;
}
/**
* @internal
* @brief Gets the LPUART baud rate modulo divisor.
*
* @details This function gets the LPUART baud rate modulo divisor.
*
* @param[in] base LPUART base pointer.
*
* @return The baud rate modulo division "SBR"
*
*
*/
static inline uint16 Lpuart_Lin_Ip_HwGetBaudRateDivisor(const LPUART_Type * base)
{
return ((uint16)((base->BAUD & LPUART_BAUD_SBR_MASK) >> LPUART_BAUD_SBR_SHIFT));
}
/**
* @internal
* @brief Sets the LPUART baud rate oversampling ratio
*
* @details This function sets the LPUART baud rate oversampling ratio.
* (Note: Feature available on select LPUART instances used together with baud rate programming)
* The oversampling ratio should be set between 4x (00011) and 32x (11111). Writing
* an invalid oversampling ratio results in an error and is set to a default
* 16x (01111) oversampling ratio.
* Disable the transmitter/receiver before calling this function.
*
*
* @param[in] base LPUART base pointer.
* @param[in] overSamplingRatio The oversampling ratio "OSR"
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetOversamplingRatio(LPUART_Type * base, uint32 overSamplingRatio)
{
uint32 baudRegValTemp;
#if (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT)
LPUART_LIN_IP_DEV_ASSERT(overSamplingRatio <= 0x1FU);
#endif /* (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT) */
baudRegValTemp = base->BAUD;
baudRegValTemp &= ~(LPUART_BAUD_OSR_MASK);
baudRegValTemp |= LPUART_BAUD_OSR(overSamplingRatio);
base->BAUD = baudRegValTemp;
}
/**
* @internal
* @brief Gets the LPUART baud rate oversampling ratio
*
* @details This function gets the LPUART baud rate oversampling ratio.
* (Note: Feature available on select LPUART instances used together with baud rate programming)
*
* @param[in] base LPUART base pointer.
*
* @return The oversampling ratio "OSR"
*
*
*/
static inline uint8 Lpuart_Lin_Ip_HwGetOversamplingRatio(const LPUART_Type * base)
{
return ((uint8)((base->BAUD & LPUART_BAUD_OSR_MASK) >> LPUART_BAUD_OSR_SHIFT));
}
/**
* @internal
* @brief Configures the LPUART baud rate both edge sampling
*
* @details This function configures the LPUART baud rate both edge sampling.
* (Note: Feature available on select LPUART instances used with baud rate programming)
* When enabled, the received data is sampled on both edges of the baud rate clock.
* This must be set when the oversampling ratio is between 4x and 7x.
* @details This function should only be called when the receiver is disabled.
*
* @param[in] base LPUART base pointer.
* @param[in] enable Enable (1) or Disable (0) Both Edge Sampling
*
* @return void
*/
static inline void Lpuart_Lin_Ip_HwEnableBothEdgeSamplingCmd(LPUART_Type * base)
{
base->BAUD |= LPUART_BAUD_BOTHEDGE_MASK;
}
/**
* @internal
* @brief Configures the number of bits per character in the LPUART controller.
*
* @details This function configures the number of bits per character in the LPUART controller.
* In some LPUART instances, the user should disable the transmitter/receiver
* before calling this function.
* Generally, this may be applied to all LPUARTs to ensure safe operation.
*
* @param[in] base LPUART base pointer.
* @param[in] bitCountPerChar Number of bits per char (8, 9, or 10, depending on the LPUART instance)
* @param[in] parity Specifies whether parity bit is enabled
*
* @return void
*
*
*/
void Lpuart_Lin_Ip_HwSetBitCountPerChar(LPUART_Type * base, Lpuart_Lin_Ip_BitCountPerCharType bitCountPerChar, boolean parity);
/**
* @internal
* @brief Configures parity mode in the LPUART controller.
*
* @details This function configures parity mode in the LPUART controller.
* In some LPUART instances, the user should disable the transmitter/receiver
* before calling this function.
* Generally, this may be applied to all LPUARTs to ensure safe operation.
*
* @param[in] base LPUART base pointer.
* @param[in] parityModeType Parity mode (enabled, disable, odd, even - see parity_mode_t struct)
*
* @return void
*
*
*/
void Lpuart_Lin_Ip_HwSetParityMode(LPUART_Type * base, Lpuart_Lin_Ip_ParityModeType parityModeType);
/**
* @internal
* @brief Configures the number of stop bits in the LPUART controller.
*
* @details This function configures the number of stop bits in the LPUART controller.
* In some LPUART instances, the user should disable the transmitter/receiver
* before calling this function.
* Generally, this may be applied to all LPUARTs to ensure safe operation.
*
* @param[in] base LPUART base pointer.
* @param[in] stopBitCount Number of stop bits (1 or 2 - see Lpuart_Lin_Ip_StopBitCountType struct)
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetStopBitCount(LPUART_Type * base, Lpuart_Lin_Ip_StopBitCountType stopBitCount)
{
base->BAUD = (base->BAUD & ~LPUART_BAUD_SBNS_MASK) | ((uint32)stopBitCount << LPUART_BAUD_SBNS_SHIFT);
}
/**
* @internal
* @brief Configures the LPUART module interrupts.
*
* @details This function configures the LPUART module interrupts to enable/disable various interrupt sources.
*
*
* @param[in] base LPUART module base pointer.
* @param[in] intSrc LPUART interrupt configuration data.
* @param[in] enable true: enable, false: disable.
*
* @return void
*
*
*/
void Lpuart_Lin_Ip_HwSetIntMode(LPUART_Type * base, Lpuart_Lin_Ip_InterruptType intSrc, boolean enable);
/**
* @internal
* @brief Returns LPUART module interrupts state.
*
* @details This function returns whether a certain LPUART module interrupt is enabled or disabled.
*
*
* @param[in] base LPUART module base pointer.
* @param[in] intSrc LPUART interrupt configuration data.
*
* @return true: enable, false: disable.
*
*
*/
boolean Lpuart_Lin_Ip_HwGetIntMode(const LPUART_Type * base, Lpuart_Lin_Ip_InterruptType intSrc);
/**
* @internal
* @brief Sends the LPUART 8-bit character.
*
* @details This functions sends an 8-bit character.
*
* @param[in] base LPUART Instance
* @param[in] data data to send (8-bit)
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwPutchar(LPUART_Type * base, uint8 data)
{
volatile uint8 * dataRegBytes = (volatile uint8 *)(&(base->DATA));
dataRegBytes[0] = data;
}
/**
* @internal
* @brief Gets the LPUART 8-bit character.
*
* @details This functions receives an 8-bit character.
*
*
* @param[in] base LPUART base pointer
* @param[in] readData Data read from receive (8-bit)
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwGetchar(const LPUART_Type * base, uint8 *readData)
{
#if (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT)
LPUART_LIN_IP_DEV_ASSERT(NULL_PTR != readData);
#endif /* (STD_ON == LPUART_LIN_IP_DEV_ERROR_DETECT) */
*readData = (uint8)base->DATA;
}
/**
* @internal
* @brief LPUART get status flag
*
* @details This function returns the state of a status flag.
*
*
* @param[in] base LPUART base pointer
* @param[in] statusFlag The status flag to query
*
* @return Whether the current status flag is set(true) or not(false).
*
*
*/
boolean Lpuart_Lin_Ip_HwGetStatusFlag(const LPUART_Type * base, Lpuart_Lin_Ip_StatusFlagType statusFlag);
/**
* @internal
* @brief LPUART clears an individual status flag.
*
* @details This function clears an individual status flag (see Lpuart_Lin_Ip_StatusFlagType for list of status bits).
*
*
* @param[in] base LPUART base pointer
* @param[in] statusFlag Desired LPUART status flag to clear
*
* @return STATUS_SUCCESS if successful or STATUS_ERROR if an error occured
*
*
*/
Lpuart_Lin_Ip_StatusType Lpuart_Lin_Ip_HwClearStatusFlag(LPUART_Type * base, Lpuart_Lin_Ip_StatusFlagType statusFlag);
/**
* @internal
* @brief Returns whether the receive data is inverted or not.
*
* @details This function returns the polarity of the receive data.
*
* @param[in] base LPUART base pointer.
*
* @return Rx data polarity; true: inverted, false: not inverted.
*
*
*/
static inline boolean Lpuart_Lin_Ip_HwGetRxDataPolarity(const LPUART_Type * base) {
return (((base->STAT >> LPUART_STAT_RXINV_SHIFT) & 1U) > 0U);
}
/**
* @internal
* @brief Sets whether the recevie data is inverted or not.
*
* @details This function sets the polarity of the receive data.
*
* @param[in] base LPUART base pointer.
* @param[in] polarity Rx Data polarity; true: inverted, false: not inverted.
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetRxDataPolarity(LPUART_Type * base, boolean polarity) {
base->STAT = (base->STAT
& (~LPUART_LIN_IP_STAT_REG_FLAGS_MASK & ~LPUART_STAT_RXINV_MASK))
| ((polarity ? 1UL : 0UL) << LPUART_STAT_RXINV_SHIFT);
}
/**
* @internal
* @brief LPUART break character transmit length configuration
*
* @details This function configures the break char length.
* In some LPUART instances, the user should disable the transmitter before calling
* this function. Generally, this may be applied to all LPUARTs to ensure safe operation.
*
* @param[in] base LPUART base pointer
* @param[in] length LPUART break character length setting: 0 - minimum 10-bit times (default),
* 1 - minimum 13-bit times
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwSetBreakCharTransmitLength(LPUART_Type * base, uint8 length) {
base->STAT = (base->STAT
& (~LPUART_LIN_IP_STAT_REG_FLAGS_MASK & ~LPUART_STAT_BRK13_MASK))
| ((uint32) length << LPUART_STAT_BRK13_SHIFT);
}
/**
* @internal
* @brief LPUART break character detect length configuration
*
* @details This function sets the LPUART detectable break character length.
*
*
* @param[in] base LPUART base pointer
* @param[in] length LPUART break character length setting: 0 - minimum 10-bit times (default),
* 1 - minimum 13-bit times
*
* @return void
*
*/
static inline void Lpuart_Lin_Ip_HwSetBreakCharDetectLength(LPUART_Type * base, uint8 length) {
SchM_Enter_Lin_LIN_EXCLUSIVE_AREA_04();
{
base->STAT = (base->STAT
& (~LPUART_LIN_IP_STAT_REG_FLAGS_MASK & ~LPUART_STAT_LBKDE_MASK))
| ((uint32) length << LPUART_STAT_LBKDE_SHIFT);
}
SchM_Exit_Lin_LIN_EXCLUSIVE_AREA_04();
}
/**
* @internal
* @brief LPUART transmit sends break character configuration.
*
* @details This function sets break character transmission in queue mode.
*
* @param[in] base LPUART base pointer
*
* @return void
*
*
*/
static inline void Lpuart_Lin_Ip_HwQueueBreakField(LPUART_Type * base) {
base->DATA = LPUART_DATA_FRETSC(1U);
}
#define LIN_STOP_SEC_CODE
#include "Lin_MemMap.h"
#if defined(__cplusplus)
}
#endif
/** @} */
#endif /* LPUART_HW_ACCESS_H_ */