drv_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 _DRV_UART_H_
#define _DRV_UART_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_name.h"
#include "hal_uart.h"
#include "ring.h"
 
typedef enum
{
    UART_SUCCESS = 0,  
    UART_ERROR = (-1)  
} uart_err_t;
 
typedef enum
{
    UART_DATA_BITS_7 = 0,   
    UART_DATA_BITS_8,       
    UART_DATA_BITS_9,       
    UART_DATA_BITS_DEFAULT = UART_DATA_BITS_8 
} uart_data_bits_t;
 
typedef enum
{
    UART_PARITY_NONE = 0, 
    UART_PARITY_EVEN,     
    UART_PARITY_ODD,      
    UART_PARITY_DEFAULT = UART_PARITY_NONE 
} uart_parity_t;
 
typedef enum
{
    UART_STOP_BITS_HALF = 0,       
    UART_STOP_BITS_ONE,            
    UART_STOP_BITS_ONE_AND_A_HALF, 
    UART_STOP_BITS_TWO,            
    UART_STOP_BITS_DEFAULT = UART_STOP_BITS_ONE 
} uart_stop_bits_t;
 
typedef struct
{
    pin_name_t tx_pin; 
    pin_name_t rx_pin; 
    uint32_t baud;              
    uart_data_bits_t data_bits; 
    uart_parity_t parity;       
    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; 
} uart_config_t;
 
typedef struct
{
    handle_t handle; 
    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; 
} uart_t;
 
void uart_configure_default( uart_config_t *config );
 
err_t uart_open( uart_t *obj, uart_config_t *config );
 
err_t uart_set_baud( uart_t *obj, uint32_t baud );
 
err_t uart_set_parity( uart_t *obj, uart_parity_t parity );
 
err_t uart_set_stop_bits( uart_t *obj, uart_stop_bits_t stop );
 
err_t uart_set_data_bits( uart_t *obj, uart_data_bits_t bits );
 
void uart_set_blocking( uart_t *obj, bool blocking );
 
err_t uart_write( uart_t *obj, uint8_t *buffer, size_t size );
 
err_t uart_print( uart_t *obj, char *text );
 
err_t uart_println( uart_t *obj, char *text );
 
err_t uart_read( uart_t *obj, uint8_t *buffer, size_t size );
 
size_t uart_bytes_available( uart_t *obj );
 
void uart_clear( uart_t *obj );
 
err_t uart_close( uart_t *obj );
 
 // drvuartgroup
 // drvgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _DRV_UART_H_
// ------------------------------------------------------------------------- END