uart.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Sung Ho Park and CSOS
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef UBIDRV_UART_H_
#define UBIDRV_UART_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <ubinos_config.h>
#include <ubinos/type.h>
 
#define UBIDRV_UART_FILE_NAME_MAX           64
 
#define UBIDRV_UART_DATA_BITS_8             0
#define UBIDRV_UART_DATA_BITS_9             1
 
#define UBIDRV_UART_STOP_BITS_1             0
#define UBIDRV_UART_STOP_BITS_2             1
 
#define UBIDRV_UART_PARITY_TYPE_NONE        0
#define UBIDRV_UART_PARITY_TYPE_EVEN        1
#define UBIDRV_UART_PARITY_TYPE_ODD         2
 
#define UBIDRV_UART_HW_FLOW_CTRL_NONE       0
#define UBIDRV_UART_HW_FLOW_CTRL_RTS        1
#define UBIDRV_UART_HW_FLOW_CTRL_CTS        2
#define UBIDRV_UART_HW_FLOW_CTRL_RTS_CTS    3
 
typedef struct _ubidrv_uart_t
{
    char file_name[UBIDRV_UART_FILE_NAME_MAX];
    uint32_t baud_rate;
    unsigned int data_bits :2;
    unsigned int stop_bits :2;
    unsigned int parity_type :2;
    unsigned int hw_flow_ctl :2;
 
    int fd;
} ubidrv_uart_t;
 
ubi_st_t ubidrv_uart_open(ubidrv_uart_t * uart);
 
ubi_st_t ubidrv_uart_close(ubidrv_uart_t * uart);
 
ubi_st_t ubidrv_uart_getc(int fd, char *ch_p);
 
ubi_st_t ubidrv_uart_getc_unblocked(int fd, char *ch_p);
 
ubi_st_t ubidrv_uart_getc_timedms(int fd, char *ch_p, uint32_t timeoutms, uint32_t *remain_timeoutms);
 
ubi_st_t ubidrv_uart_putc(int fd, int ch);
 
ubi_st_t ubidrv_uart_flush(int fd);
 
int ubidrv_uart_putn(int fd, const char *str, int len);
 
int ubidrv_uart_kbhit(int fd);
 
int ubidrv_uart_puts(int fd, const char *str, int max);
 
int ubidrv_uart_gets(int fd, char *str, int max);
 
ubi_st_t ubidrv_uart_setecho(int fd, int echo);
 
int ubidrv_uart_getecho(int fd);
 
ubi_st_t ubidrv_uart_setautocr(int fd, int autocr);
 
int ubidrv_uart_getautocr(int fd);
 
#ifdef __cplusplus
}
#endif
 
#endif /* UBIDRV_UART_H_ */