smbae/ADM
1
0
Fork 0
mirror of https://github.com/Dev-KATECH/ADM.git synced 2026-05-17 01:43:59 +09:00
Code Issues Actions Packages Projects Releases Wiki Activity
20241015_EILS_VCU_V1
ADM/GW/RTD/include/Lpuart_Uart_Ip.h
S2-CHICKEN 77297108b6 VCU C code first commit
2024-08-08 10:00:15 +09:00

364 lines
17 KiB
C
Raw Permalink Blame History

/*==================================================================================================
* Project : RTD AUTOSAR 4.4
* Platform : CORTEXM
* Peripheral : FLEXIO
* Dependencies :
*
* 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_UART_IP_H
#define LPUART_UART_IP_H
/**
* @file
* @defgroup lpuart_uart_ip Lpuart UART IPL
* @addtogroup lpuart_uart_ip Lpuart UART 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 "Lpuart_Uart_Ip_Types.h"
#include "Lpuart_Uart_Ip_Cfg.h"
#include "Mcal.h"
/*==================================================================================================
* SOURCE FILE VERSION INFORMATION
==================================================================================================*/
#define LPUART_UART_IP_VENDOR_ID 43
#define LPUART_UART_IP_AR_RELEASE_MAJOR_VERSION 4
#define LPUART_UART_IP_AR_RELEASE_MINOR_VERSION 4
#define LPUART_UART_IP_AR_RELEASE_REVISION_VERSION 0
#define LPUART_UART_IP_SW_MAJOR_VERSION 0
#define LPUART_UART_IP_SW_MINOR_VERSION 9
#define LPUART_UART_IP_SW_PATCH_VERSION 0
/*==================================================================================================
* FILE VERSION CHECKS
==================================================================================================*/
/* Checks against Lpuart_Uart_Ip_Types.h */
#if (LPUART_UART_IP_VENDOR_ID != LPUART_UART_IP_TYPES_VENDOR_ID)
#error "Lpuart_Uart_Ip.h and Lpuart_Uart_Ip_Types.h have different vendor ids"
#endif
#if ((LPUART_UART_IP_AR_RELEASE_MAJOR_VERSION != LPUART_UART_IP_TYPES_AR_RELEASE_MAJOR_VERSION) || \
(LPUART_UART_IP_AR_RELEASE_MINOR_VERSION != LPUART_UART_IP_TYPES_AR_RELEASE_MINOR_VERSION) || \
(LPUART_UART_IP_AR_RELEASE_REVISION_VERSION != LPUART_UART_IP_TYPES_AR_RELEASE_REVISION_VERSION))
#error "AUTOSAR Version Numbers of Lpuart_Uart_Ip.h and Lpuart_Uart_Ip_Types.h are different"
#endif
#if ((LPUART_UART_IP_SW_MAJOR_VERSION != LPUART_UART_IP_TYPES_SW_MAJOR_VERSION) || \
(LPUART_UART_IP_SW_MINOR_VERSION != LPUART_UART_IP_TYPES_SW_MINOR_VERSION) || \
(LPUART_UART_IP_SW_PATCH_VERSION != LPUART_UART_IP_TYPES_SW_PATCH_VERSION))
#error "Software Version Numbers of Lpuart_Uart_Ip.h and Lpuart_Uart_Ip_Types.h are different"
#endif
/* Checks against Lpuart_Uart_Ip_Cfg.h */
#if (LPUART_UART_IP_VENDOR_ID != LPUART_UART_IP_CFG_VENDOR_ID)
#error "Lpuart_Uart_Ip.h and Lpuart_Uart_Ip_Cfg.h have different vendor ids"
#endif
#if ((LPUART_UART_IP_AR_RELEASE_MAJOR_VERSION != LPUART_UART_IP_CFG_AR_RELEASE_MAJOR_VERSION) || \
(LPUART_UART_IP_AR_RELEASE_MINOR_VERSION != LPUART_UART_IP_CFG_AR_RELEASE_MINOR_VERSION) || \
(LPUART_UART_IP_AR_RELEASE_REVISION_VERSION != LPUART_UART_IP_CFG_AR_RELEASE_REVISION_VERSION))
#error "AUTOSAR Version Numbers of Lpuart_Uart_Ip.h and Lpuart_Uart_Ip_Cfg.h are different"
#endif
#if ((LPUART_UART_IP_SW_MAJOR_VERSION != LPUART_UART_IP_CFG_SW_MAJOR_VERSION) || \
(LPUART_UART_IP_SW_MINOR_VERSION != LPUART_UART_IP_CFG_SW_MINOR_VERSION) || \
(LPUART_UART_IP_SW_PATCH_VERSION != LPUART_UART_IP_CFG_SW_PATCH_VERSION))
#error "Software Version Numbers of Lpuart_Uart_Ip.h and Lpuart_Uart_Ip_Cfg.h are different"
#endif
/*==================================================================================================
* CONSTANTS
==================================================================================================*/
#define UART_START_SEC_CONFIG_DATA_UNSPECIFIED
/* @violates @ref Uart_c_REF_1 This violation is not fixed since the inclusion of Uart_MemMap.h is as per AUTOSAR requirement*/
#include "Uart_MemMap.h"
/* Calling the external Configuration symbols defined by Lpuart_Uart_Ip_Cfg.h */
LPUART_UART_IP_CONFIG_EXT
#define UART_STOP_SEC_CONFIG_DATA_UNSPECIFIED
/* @violates @ref Uart_c_REF_1 This violation is not fixed since the inclusion of Uart_MemMap.h is as per AUTOSAR requirement*/
#include "Uart_MemMap.h"
/*==================================================================================================
* DEFINES AND MACROS
==================================================================================================*/
/*==================================================================================================
* ENUMS
==================================================================================================*/
/*==================================================================================================
* STRUCTURES AND OTHER TYPEDEFS
==================================================================================================*/
/*==================================================================================================
* GLOBAL VARIABLE DECLARATIONS
==================================================================================================*/
/*==================================================================================================
* FUNCTION PROTOTYPES
==================================================================================================*/
#define UART_START_SEC_CODE
/* @violates @ref Uart_c_REF_1 This violation is not fixed since the inclusion of Uart_MemMap.h is as per AUTOSAR requirement*/
#include "Uart_MemMap.h"
/*!
* @brief Initializes an LPUART operation instance.
*
* The caller provides memory for the driver state structures during initialization.
* The user must select the LPUART clock source in the application to initialize the LPUART.
*
* @param u32Instance LPUART instance number
* @param pUserConfig user configuration structure of type #Lpuart_Uart_Ip_UserConfigType
* @return void
*/
void Lpuart_Uart_Ip_Init(uint32 u32Instance, const Lpuart_Uart_Ip_UserConfigType * pUserConfig);
/*!
* @brief Shuts down the LPUART by disabling interrupts and transmitter/receiver.
*
* @param u32Instance LPUART instance number
* @return void
*/
void Lpuart_Uart_Ip_Deinit(uint32 u32Instance);
/*!
* @brief Send out multiple bytes of data using polling method.
*
* @param u32Instance LPUART instance number.
* @param pTxBuff The buffer pointer which saves the data to be sent.
* @param u32TxSize Size of data to be sent in unit of byte.
* @return LPUART_UART_IP_STATUS_SUCCESS if successful;
* LPUART_UART_IP_STATUS_BUSY if the resource is busy;
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_SyncSend(uint32 u32Instance,
const uint8 *pTxBuff,
uint32 u32TxSize);
/*!
* @brief Sends data out through the LPUART module using a non-blocking method.
* This enables an a-sync method for transmitting data. When used with
* a non-blocking receive, the LPUART can perform a full duplex operation.
* Non-blocking means that the function returns immediately.
* The application has to get the transmit status to know when the transmit is complete.
*
* @param u32Instance LPUART instance number.
* @param pTxBuff The buffer pointer which saves the data to be sent.
* @param u32TxSize Size of data to be sent in unit of byte.
* @return LPUART_UART_IP_STATUS_SUCCESS if successful;
* LPUART_UART_IP_STATUS_BUSY if the resource is busy;
* LPUART_UART_IP_STATUS_TIMEOUT if timeout occur
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_AsyncSend(uint32 u32Instance,
const uint8 * pTxBuff,
uint32 u32TxSize);
/*!
* @brief Returns whether the previous transmit is complete.
*
* @param u32Instance LPUART instance number
* @param pBytesRemaining Pointer to value that is populated with the number of bytes that
* have been sent in the active transfer
* @note In DMA mode, this parameter may not be accurate, in case the transfer completes
* right after calling this function; in this edge-case, the parameter will reflect
* the initial transfer size, due to automatic reloading of the major loop count
* in the DMA transfer descriptor.
* @return The transmit status.
* @retval LPUART_UART_IP_STATUS_SUCCESS The transmit has completed successfully.
* @retval LPUART_UART_IP_STATUS_BUSY The transmit is still in progress. @a bytesRemaining will be
* filled with the number of bytes that are yet to be transmitted.
* @retval LPUART_UART_IP_STATUS_ABORTED The transmit was aborted.
* @retval LPUART_UART_IP_STATUS_TIMEOUT A timeout was reached.
* @retval LPUART_UART_IP_STATUS_ERROR An error occurred.
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_GetTransmitStatus(uint32 u32Instance, uint32 * pBytesRemaining);
/*!
* @brief Terminates a non-blocking transmission early.
*
* @param instance LPUART instance number
* @return Whether the aborting is successful or not.
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_AbortSendingData(uint32 u32Instance);
/*!
* @brief Receive multiple bytes of data using polling method.
*
*
* @param u32Instance LPUART instance number.
* @param pRxBuff The buffer pointer which saves the data to be received.
* @param u32RxSize Size of data need to be received in unit of byte.
* @return LPUART_UART_IP_STATUS_SUCCESS if the transaction is successful;
* LPUART_UART_IP_STATUS_BUSY if the resource is busy;
* LPUART_UART_IP_STATUS_RX_OVERRUN if an overrun error occured
* LPUART_UART_IP_STATUS_FRAMING_ERROR if a framing error occured
* LPUART_UART_IP_STATUS_PARITY_ERROR if a parity error occured
* LPUART_UART_IP_STATUS_NOISE_ERROR if a noise error occured
* LPUART_UART_IP_STATUS_TIMEOUT if timeout occur
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_SyncReceive(uint32 u32Instance,
uint8 *pRxBuff,
uint32 u32RxSize);
/*!
* @brief Gets data from the LPUART module by using a non-blocking method.
* This enables an a-sync method for receiving data. When used with
* a non-blocking transmission, the LPUART can perform a full duplex operation.
* Non-blocking means that the function returns immediately.
* The application has to get the receive status to know when the receive is complete.
*
* @param u32Instance LPUART instance number
* @param pRxBuff buffer containing 8-bit read data chars received
* @param u32RxSize the number of bytes to receive
* @return LPUART_UART_IP_STATUS_SUCCESS if successful;
* LPUART_UART_IP_STATUS_BUSY if the resource is busy
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_AsyncReceive(uint32 u32Instance,
uint8 * pRxBuff,
uint32 u32RxSize);
/*!
* @brief Returns whether the previous receive is complete.
*
* @param u32Instance LPUART instance number
* @param pBytesRemaining pointer to value that is filled with the number of bytes that
* still need to be received in the active transfer.
* @note In DMA mode, this parameter may not be accurate, in case the transfer completes
* right after calling this function; in this edge-case, the parameter will reflect
* the initial transfer size, due to automatic reloading of the major loop count
* in the DMA transfer descriptor.
* @return The receive status.
* @retval LPUART_UART_IP_STATUS_SUCCESS the receive has completed successfully.
* @retval LPUART_UART_IP_STATUS_BUSY the receive is still in progress. @a bytesReceived will be
* filled with the number of bytes that have been received so far.
* @retval LPUART_UART_IP_STATUS_ABORTED The receive was aborted.
* @retval LPUART_UART_IP_STATUS_TIMEOUT A timeout was reached.
* @retval LPUART_UART_IP_STATUS_RX_OVERRUN, LPUART_UART_IP_STATUS_FRAMING_ERROR, LPUART_UART_IP_STATUS_PARITY_ERROR,
or LPUART_UART_IP_STATUS_NOISE_ERROR, LPUART_UART_IP_STATUS_ERROR An error occurred during reception.
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_GetReceiveStatus(uint32 u32Instance, uint32 * pBytesRemaining);
/*!
* @brief Terminates a non-blocking receive early.
*
* @param u32Instance LPUART instance number
*
* @return Whether the receiving was successful or not.
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_AbortReceivingData(uint32 u32Instance);
/*!
* @brief Configures the LPUART baud rate.
*
* This function configures the LPUART baud rate.
* In some LPUART instances the user must disable the transmitter/receiver
* before calling this function.
* Generally, this may be applied to all LPUARTs to ensure safe operation.
*
* @param u32Instance LPUART instance number.
* @param u32DesiredBaudrate LPUART desired baud rate.
* @param u32ClockFrequency Clock Frequency of LPUART instance.
* @return LPUART_UART_IP_STATUS_BUSY if called during an on-going transfer, LPUART_UART_IP_STATUS_SUCCESS otherwise
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_SetBaudRate(uint32 u32Instance,
Lpuart_Uart_Ip_BaudrateType u32DesiredBaudrate,
uint32 u32ClockFrequency);
/*!
* @brief Returns the LPUART baud rate.
*
* This function returns the LPUART configured baud rate.
*
* @param u32Instance LPUART instance number.
* @param[out] pConfiguredBaudRate LPUART configured baud rate.
*/
void Lpuart_Uart_Ip_GetBaudRate(uint32 u32Instance, uint32 * pConfiguredBaudRate);
/*!
* @brief Sets the internal driver reference to the tx buffer.
*
* This function can be called from the tx callback to provide the driver
* with a new buffer, for continuous transmission.
*
* @param u32Instance LPUART instance number
* @param pTxBuff source buffer containing 8-bit data chars to send
* @param u32TxSize the number of bytes to send
* @return LPUART_UART_IP_STATUS_SUCCESS
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_SetTxBuffer(uint32 u32Instance,
const uint8 * pTxBuff,
uint32 u32TxSize);
/*!
* @brief Sets the internal driver reference to the rx buffer.
*
* This function can be called from the rx callback to provide the driver
* with a new buffer, for continuous reception.
*
* @param instance LPUART instance number
* @param pRxBuff destination buffer containing 8-bit data chars to receive
* @param u32RxSize the number of bytes to receive
* @return LPUART_UART_IP_STATUS_SUCCESS
*/
Lpuart_Uart_Ip_StatusType Lpuart_Uart_Ip_SetRxBuffer(uint32 u32Instance,
uint8 * pRxBuff,
uint32 u32RxSize);
void Lpuart_Uart_Ip_IRQHandler(uint32 u32Instance);
#if (LPUART_UART_IP_HAS_DMA_ENABLED == STD_ON)
/**
* @internal
* @brief : Finish up a transmit by completing the process of sending
* data and disabling the DMA requests. This is a part of callback for DMA major loop
* completion, so it must match the DMA callback signature.
* @param u32Instance Lpuart instance number
* @return void
*/
void Lpuart_Uart_Ip_CompleteSendUsingDma(uint32 u32Instance);
/**
* @internal
* @brief : Finish up a receive by completing the process of receiving data
* and disabling the DMA requests. This is a part of callback for DMA major loop
* completion, so it must match the DMA callback signature.
* @param u32Instance Lpuart instance number
* @return void
*/
void Lpuart_Uart_Ip_CompleteReceiveUsingDma(uint32 u32Instance);
#endif
#define UART_STOP_SEC_CODE
/* @violates @ref Uart_c_REF_1 This violation is not fixed since the inclusion of Uart_MemMap.h is as per AUTOSAR requirement*/
#include "Uart_MemMap.h"
#if defined(__cplusplus)
}
#endif
/*! @}*/
#endif /* LPUART_UART_IP_H */
Reference in New Issue View Git Blame Copy Permalink