hal_uart.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _HAL_UART_H_
#define _HAL_UART_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "hal_target.h"
#include "ring.h"
 
typedef struct
{
    handle_t *hal_uart_handle; 
    handle_t *drv_uart_handle; 
    bool init_state;           
} hal_uart_handle_register_t;
 
typedef enum
{
    HAL_UART_SUCCESS = 0,  
    HAL_UART_WRONG_PINS,   
    HAL_UART_MODULE_ERROR, 
    HAL_UART_ERROR = (-1)  
} hal_uart_err_t;
 
typedef enum
{
    HAL_UART_IRQ_RX, 
    HAL_UART_IRQ_TX  
} hal_uart_irq_t;
 
typedef enum
{
    HAL_UART_DATA_BITS_7 = 0,   
    HAL_UART_DATA_BITS_8,       
    HAL_UART_DATA_BITS_9,       
    HAL_UART_DATA_BITS_DEFAULT = HAL_UART_DATA_BITS_8 
} hal_uart_data_bits_t;
 
typedef enum
{
    HAL_UART_PARITY_NONE = 0, 
    HAL_UART_PARITY_EVEN,     
    HAL_UART_PARITY_ODD,      
    HAL_UART_PARITY_DEFAULT = HAL_UART_PARITY_NONE 
} hal_uart_parity_t;
 
typedef enum
{
    HAL_UART_STOP_BITS_HALF = 0,       
    HAL_UART_STOP_BITS_ONE,            
    HAL_UART_STOP_BITS_ONE_AND_A_HALF, 
    HAL_UART_STOP_BITS_TWO,            
    HAL_UART_STOP_BITS_DEFAULT = HAL_UART_STOP_BITS_ONE 
} hal_uart_stop_bits_t;
 
typedef struct
{
    hal_pin_name_t tx_pin; 
    hal_pin_name_t rx_pin; 
    uint32_t baud;                  
    hal_uart_data_bits_t data_bits; 
    hal_uart_parity_t parity;       
    hal_uart_stop_bits_t stop_bits; 
    ring_buf8_t tx_buf; 
    ring_buf8_t rx_buf; 
    size_t tx_ring_size; 
    size_t rx_ring_size; 
} hal_uart_config_t;
 
typedef struct
{
    handle_t handle; 
    hal_uart_config_t config; 
    uint8_t *tx_ring_buffer; 
    uint8_t *rx_ring_buffer; 
    bool is_tx_irq_enabled; 
    bool is_rx_irq_enabled; 
    bool is_blocking; 
} hal_uart_t;
 
void hal_uart_configure_default( hal_uart_config_t *config );
 
err_t hal_uart_open( handle_t *handle, bool hal_obj_open_state );
 
err_t hal_uart_set_baud( handle_t *handle, hal_uart_config_t *config );
 
err_t hal_uart_set_parity( handle_t *handle, hal_uart_config_t *config );
 
err_t hal_uart_set_stop_bits( handle_t *handle, hal_uart_config_t *config );
 
err_t hal_uart_set_data_bits( handle_t *handle, hal_uart_config_t *config );
 
void hal_uart_set_blocking( handle_t *handle, bool blocking );
 
size_t hal_uart_write( handle_t *handle, uint8_t *buffer, size_t size );
 
size_t hal_uart_print( handle_t *handle, char *text );
 
size_t hal_uart_println( handle_t *handle, char *text );
 
size_t hal_uart_read( handle_t *handle, uint8_t *buffer, size_t size );
 
size_t hal_uart_bytes_available( hal_uart_t *hal_obj );
 
void hal_uart_clear( hal_uart_t *hal_obj );
 
err_t hal_uart_close( handle_t *handle );
 
 // haluartgroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_UART_H_
// ------------------------------------------------------------------------- END