uart.h

Go to the documentation of this file.

/*
 * Copyright 2018-2020 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __HAL_UART_ADAPTER_H__
#define __HAL_UART_ADAPTER_H__
 
#if defined(FSL_RTOS_FREE_RTOS)
#include "FreeRTOS.h"
#endif
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#ifdef DEBUG_CONSOLE_TRANSFER_NON_BLOCKING
#define UART_ADAPTER_NON_BLOCKING_MODE (1U)
#else
#ifndef SERIAL_MANAGER_NON_BLOCKING_MODE
#define UART_ADAPTER_NON_BLOCKING_MODE (0U)
#else
#define UART_ADAPTER_NON_BLOCKING_MODE SERIAL_MANAGER_NON_BLOCKING_MODE
#endif
#endif
 
#if defined(__GIC_PRIO_BITS)
#ifndef HAL_UART_ISR_PRIORITY
#define HAL_UART_ISR_PRIORITY (25U)
#endif
#else
#if defined(configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY)
#ifndef HAL_UART_ISR_PRIORITY
#define HAL_UART_ISR_PRIORITY (configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY)
#endif
#else
/* The default value 3 is used to support different ARM Core, such as CM0P, CM4, CM7, and CM33, etc.
 * The minimum number of priority bits implemented in the NVIC is 2 on these SOCs. The value of mininum
 * priority is 3 (2^2 - 1). So, the default value is 3.
 */
#ifndef HAL_UART_ISR_PRIORITY
#define HAL_UART_ISR_PRIORITY (3U)
#endif
#endif
#endif
 
#ifndef HAL_UART_ADAPTER_LOWPOWER
#define HAL_UART_ADAPTER_LOWPOWER (0U)
#endif /* HAL_UART_ADAPTER_LOWPOWER */
 
#if (defined(UART_ADAPTER_NON_BLOCKING_MODE) && (UART_ADAPTER_NON_BLOCKING_MODE > 0U))
#define HAL_UART_HANDLE_SIZE (90U + HAL_UART_ADAPTER_LOWPOWER * 16U)
#else
#define HAL_UART_HANDLE_SIZE (4U + HAL_UART_ADAPTER_LOWPOWER * 16U)
#endif
 
#define UART_HANDLE_DEFINE(name) uint32_t name[((HAL_UART_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t))]
 
#ifndef HAL_UART_TRANSFER_MODE
#define HAL_UART_TRANSFER_MODE (0U)
#endif
 
typedef void *hal_uart_handle_t;
 
typedef enum _hal_uart_status
{
    kStatus_HAL_UartSuccess = kStatus_Success,                       
    kStatus_HAL_UartTxBusy  = MAKE_STATUS(kStatusGroup_HAL_UART, 1), 
    kStatus_HAL_UartRxBusy  = MAKE_STATUS(kStatusGroup_HAL_UART, 2), 
    kStatus_HAL_UartTxIdle  = MAKE_STATUS(kStatusGroup_HAL_UART, 3), 
    kStatus_HAL_UartRxIdle  = MAKE_STATUS(kStatusGroup_HAL_UART, 4), 
    kStatus_HAL_UartBaudrateNotSupport =
        MAKE_STATUS(kStatusGroup_HAL_UART, 5), 
    kStatus_HAL_UartProtocolError = MAKE_STATUS(
        kStatusGroup_HAL_UART,
        6),                                                        
    kStatus_HAL_UartError = MAKE_STATUS(kStatusGroup_HAL_UART, 7), 
} hal_uart_status_t;
 
typedef enum _hal_uart_parity_mode
{
    kHAL_UartParityDisabled = 0x0U, 
    kHAL_UartParityEven     = 0x1U, 
    kHAL_UartParityOdd      = 0x2U, 
} hal_uart_parity_mode_t;
 
typedef enum _hal_uart_stop_bit_count
{
    kHAL_UartOneStopBit = 0U, 
    kHAL_UartTwoStopBit = 1U, 
} hal_uart_stop_bit_count_t;
 
typedef struct _hal_uart_config
{
    uint32_t srcClock_Hz;                   
    uint32_t baudRate_Bps;                  
    hal_uart_parity_mode_t parityMode;      
    hal_uart_stop_bit_count_t stopBitCount; 
    uint8_t enableRx;                       
    uint8_t enableTx;                       
    uint8_t instance; 
} hal_uart_config_t;
 
typedef void (*hal_uart_transfer_callback_t)(hal_uart_handle_t handle, hal_uart_status_t status, void *callbackParam);
 
typedef struct _hal_uart_transfer
{
    uint8_t *data;   
    size_t dataSize; 
} hal_uart_transfer_t;
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif /* _cplusplus */
 
hal_uart_status_t HAL_UartInit(hal_uart_handle_t handle, hal_uart_config_t *config);
 
hal_uart_status_t HAL_UartDeinit(hal_uart_handle_t handle);
 
hal_uart_status_t HAL_UartReceiveBlocking(hal_uart_handle_t handle, uint8_t *data, size_t length);
 
hal_uart_status_t HAL_UartSendBlocking(hal_uart_handle_t handle, const uint8_t *data, size_t length);
 
#if (defined(UART_ADAPTER_NON_BLOCKING_MODE) && (UART_ADAPTER_NON_BLOCKING_MODE > 0U))
#if (defined(HAL_UART_TRANSFER_MODE) && (HAL_UART_TRANSFER_MODE > 0U))
 
hal_uart_status_t HAL_UartTransferInstallCallback(hal_uart_handle_t handle,
                                                  hal_uart_transfer_callback_t callback,
                                                  void *callbackParam);
 
hal_uart_status_t HAL_UartTransferReceiveNonBlocking(hal_uart_handle_t handle, hal_uart_transfer_t *transfer);
 
hal_uart_status_t HAL_UartTransferSendNonBlocking(hal_uart_handle_t handle, hal_uart_transfer_t *transfer);
 
hal_uart_status_t HAL_UartTransferGetReceiveCount(hal_uart_handle_t handle, uint32_t *count);
 
hal_uart_status_t HAL_UartTransferGetSendCount(hal_uart_handle_t handle, uint32_t *count);
 
hal_uart_status_t HAL_UartTransferAbortReceive(hal_uart_handle_t handle);
 
hal_uart_status_t HAL_UartTransferAbortSend(hal_uart_handle_t handle);
 
#else
 
hal_uart_status_t HAL_UartInstallCallback(hal_uart_handle_t handle,
                                          hal_uart_transfer_callback_t callback,
                                          void *callbackParam);
 
hal_uart_status_t HAL_UartReceiveNonBlocking(hal_uart_handle_t handle, uint8_t *data, size_t length);
 
hal_uart_status_t HAL_UartSendNonBlocking(hal_uart_handle_t handle, uint8_t *data, size_t length);
 
hal_uart_status_t HAL_UartGetReceiveCount(hal_uart_handle_t handle, uint32_t *reCount);
 
hal_uart_status_t HAL_UartGetSendCount(hal_uart_handle_t handle, uint32_t *seCount);
 
hal_uart_status_t HAL_UartAbortReceive(hal_uart_handle_t handle);
 
hal_uart_status_t HAL_UartAbortSend(hal_uart_handle_t handle);
 
#endif
#endif
 
hal_uart_status_t HAL_UartEnterLowpower(hal_uart_handle_t handle);
 
hal_uart_status_t HAL_UartExitLowpower(hal_uart_handle_t handle);
 
#if (defined(UART_ADAPTER_NON_BLOCKING_MODE) && (UART_ADAPTER_NON_BLOCKING_MODE > 0U))
 
void HAL_UartIsrFunction(hal_uart_handle_t handle);
#endif
 
#if defined(__cplusplus)
}
#endif
 
#endif /* __HAL_UART_ADAPTER_H__ */