fsl_lpuart_freertos.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * Copyright 2016-2020 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef __FSL_LPUART_RTOS_H__
#define __FSL_LPUART_RTOS_H__
 
#include "fsl_lpuart.h"
#include <FreeRTOS.h>
#include <event_groups.h>
#include <semphr.h>
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#define FSL_LPUART_FREERTOS_DRIVER_VERSION (MAKE_VERSION(2, 6, 0))
typedef struct _lpuart_rtos_config
{
    LPUART_Type *base;                
    uint32_t srcclk;                  
    uint32_t baudrate;                
    lpuart_parity_mode_t parity;      
    lpuart_stop_bit_count_t stopbits; 
    uint8_t *buffer;                  
    uint32_t buffer_size;             
    /* Zero in constant and multiplier is interpreted as infinit timeout. */
    uint32_t rx_timeout_constant_ms;   
    uint32_t rx_timeout_multiplier_ms; 
    uint32_t tx_timeout_constant_ms;   
    uint32_t tx_timeout_multiplier_ms; 
#if defined(FSL_FEATURE_LPUART_HAS_MODEM_SUPPORT) && FSL_FEATURE_LPUART_HAS_MODEM_SUPPORT
    bool enableRxRTS;                         
    bool enableTxCTS;                         
    lpuart_transmit_cts_source_t txCtsSource; 
    lpuart_transmit_cts_config_t txCtsConfig; 
#endif
} lpuart_rtos_config_t;
 
#define RTOS_LPUART_TX_COMPLETE 0x1U
#define RTOS_LPUART_RX_COMPLETE 0x2U
#define RTOS_LPUART_RING_BUFFER_OVERRUN 0x4U
#define RTOS_LPUART_HARDWARE_BUFFER_OVERRUN 0x8U
typedef struct _lpuart_rtos_handle
{
    LPUART_Type *base;                 
    lpuart_transfer_t txTransfer;      
    lpuart_transfer_t rxTransfer;      
    SemaphoreHandle_t rxSemaphore;     
    SemaphoreHandle_t txSemaphore;     
    EventGroupHandle_t rxEvent;        
    EventGroupHandle_t txEvent;        
    uint32_t rx_timeout_constant_ms;   
    uint32_t rx_timeout_multiplier_ms; 
    uint32_t tx_timeout_constant_ms;   
    uint32_t tx_timeout_multiplier_ms; 
    void *t_state;                     
#if (configSUPPORT_STATIC_ALLOCATION == 1)
    StaticSemaphore_t txSemaphoreBuffer; 
    StaticSemaphore_t rxSemaphoreBuffer; 
    StaticEventGroup_t txEventBuffer;    
    StaticEventGroup_t rxEventBuffer;    
#endif
} lpuart_rtos_handle_t;
/*******************************************************************************
 * API
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif
 
int LPUART_RTOS_Init(lpuart_rtos_handle_t *handle, lpuart_handle_t *t_handle, const lpuart_rtos_config_t *cfg);
 
int LPUART_RTOS_Deinit(lpuart_rtos_handle_t *handle);
 
int LPUART_RTOS_Send(lpuart_rtos_handle_t *handle, uint8_t *buffer, uint32_t length);
 
int LPUART_RTOS_Receive(lpuart_rtos_handle_t *handle, uint8_t *buffer, uint32_t length, size_t *received);
 
int LPUART_RTOS_SetRxTimeout(lpuart_rtos_handle_t *handle,
                             uint32_t rx_timeout_constant_ms,
                             uint32_t rx_timeout_multiplier_ms);
 
int LPUART_RTOS_SetTxTimeout(lpuart_rtos_handle_t *handle,
                             uint32_t tx_timeout_constant_ms,
                             uint32_t tx_timeout_multiplier_ms);
 
/* @} */
 
#if defined(__cplusplus)
}
#endif
 
#endif /* __FSL_LPUART_RTOS_H__ */