190 lines
5.7 KiB
C
Executable File
190 lines
5.7 KiB
C
Executable File
/*
|
|
* Copyright (c) 2006-2023, RT-Thread Development Team
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Change Logs:
|
|
* Date Author Notes
|
|
* 2012-05-15 lgnq first version.
|
|
* 2012-05-28 bernard change interfaces
|
|
* 2013-02-20 bernard use RT_SERIAL_RB_BUFSZ to define
|
|
* the size of ring buffer.
|
|
*/
|
|
|
|
#ifndef __SERIAL_H__
|
|
#define __SERIAL_H__
|
|
|
|
#include <rtthread.h>
|
|
|
|
#define BAUD_RATE_2400 2400
|
|
#define BAUD_RATE_4800 4800
|
|
#define BAUD_RATE_9600 9600
|
|
#define BAUD_RATE_19200 19200
|
|
#define BAUD_RATE_38400 38400
|
|
#define BAUD_RATE_57600 57600
|
|
#define BAUD_RATE_115200 115200
|
|
#define BAUD_RATE_230400 230400
|
|
#define BAUD_RATE_460800 460800
|
|
#define BAUD_RATE_500000 500000
|
|
#define BAUD_RATE_576000 576000
|
|
#define BAUD_RATE_921600 921600
|
|
#define BAUD_RATE_1000000 1000000
|
|
#define BAUD_RATE_1152000 1152000
|
|
#define BAUD_RATE_1500000 1500000
|
|
#define BAUD_RATE_2000000 2000000
|
|
#define BAUD_RATE_2500000 2500000
|
|
#define BAUD_RATE_3000000 3000000
|
|
#define BAUD_RATE_3500000 3500000
|
|
#define BAUD_RATE_4000000 4000000
|
|
|
|
#define DATA_BITS_5 5
|
|
#define DATA_BITS_6 6
|
|
#define DATA_BITS_7 7
|
|
#define DATA_BITS_8 8
|
|
#define DATA_BITS_9 9
|
|
|
|
#define STOP_BITS_1 0
|
|
#define STOP_BITS_2 1
|
|
#define STOP_BITS_3 2
|
|
#define STOP_BITS_4 3
|
|
|
|
#ifdef _WIN32
|
|
#include <windows.h>
|
|
#else
|
|
#define PARITY_NONE 0
|
|
#define PARITY_ODD 1
|
|
#define PARITY_EVEN 2
|
|
#endif
|
|
|
|
#define BIT_ORDER_LSB 0
|
|
#define BIT_ORDER_MSB 1
|
|
|
|
#define NRZ_NORMAL 0 /* Non Return to Zero : normal mode */
|
|
#define NRZ_INVERTED 1 /* Non Return to Zero : inverted mode */
|
|
|
|
#ifndef RT_SERIAL_RB_BUFSZ
|
|
#define RT_SERIAL_RB_BUFSZ 64
|
|
#endif
|
|
|
|
#define RT_SERIAL_EVENT_RX_IND 0x01 /* Rx indication */
|
|
#define RT_SERIAL_EVENT_TX_DONE 0x02 /* Tx complete */
|
|
#define RT_SERIAL_EVENT_RX_DMADONE 0x03 /* Rx DMA transfer done */
|
|
#define RT_SERIAL_EVENT_TX_DMADONE 0x04 /* Tx DMA transfer done */
|
|
#define RT_SERIAL_EVENT_RX_TIMEOUT 0x05 /* Rx timeout */
|
|
|
|
#define RT_SERIAL_DMA_RX 0x01
|
|
#define RT_SERIAL_DMA_TX 0x02
|
|
|
|
#define RT_SERIAL_RX_INT 0x01
|
|
#define RT_SERIAL_TX_INT 0x02
|
|
|
|
#define RT_SERIAL_ERR_OVERRUN 0x01
|
|
#define RT_SERIAL_ERR_FRAMING 0x02
|
|
#define RT_SERIAL_ERR_PARITY 0x03
|
|
|
|
#define RT_SERIAL_TX_DATAQUEUE_SIZE 2048
|
|
#define RT_SERIAL_TX_DATAQUEUE_LWM 30
|
|
|
|
#define RT_SERIAL_FLOWCONTROL_CTSRTS 1
|
|
#define RT_SERIAL_FLOWCONTROL_NONE 0
|
|
|
|
/* Default config for serial_configure structure */
|
|
#define RT_SERIAL_CONFIG_DEFAULT \
|
|
{ \
|
|
BAUD_RATE_115200, /* 115200 bits/s */ \
|
|
DATA_BITS_8, /* 8 databits */ \
|
|
STOP_BITS_1, /* 1 stopbit */ \
|
|
PARITY_NONE, /* No parity */ \
|
|
BIT_ORDER_LSB, /* LSB first sent */ \
|
|
NRZ_NORMAL, /* Normal mode */ \
|
|
RT_SERIAL_RB_BUFSZ, /* Buffer size */ \
|
|
RT_SERIAL_FLOWCONTROL_NONE, /* Off flowcontrol */ \
|
|
0 \
|
|
}
|
|
|
|
struct serial_configure
|
|
{
|
|
rt_uint32_t baud_rate;
|
|
|
|
rt_uint32_t data_bits :4;
|
|
rt_uint32_t stop_bits :2;
|
|
rt_uint32_t parity :2;
|
|
rt_uint32_t bit_order :1;
|
|
rt_uint32_t invert :1;
|
|
rt_uint32_t bufsz :16;
|
|
rt_uint32_t flowcontrol :1;
|
|
rt_uint32_t reserved :5;
|
|
};
|
|
|
|
/*
|
|
* Serial FIFO mode
|
|
*/
|
|
struct rt_serial_rx_fifo
|
|
{
|
|
/* software fifo */
|
|
rt_uint8_t *buffer;
|
|
|
|
rt_uint16_t put_index, get_index;
|
|
|
|
rt_bool_t is_full;
|
|
};
|
|
|
|
struct rt_serial_tx_fifo
|
|
{
|
|
struct rt_completion completion;
|
|
};
|
|
|
|
/*
|
|
* Serial DMA mode
|
|
*/
|
|
struct rt_serial_rx_dma
|
|
{
|
|
rt_bool_t activated;
|
|
};
|
|
|
|
struct rt_serial_tx_dma
|
|
{
|
|
rt_bool_t activated;
|
|
struct rt_data_queue data_queue;
|
|
};
|
|
|
|
struct rt_serial_device
|
|
{
|
|
struct rt_device parent;
|
|
|
|
const struct rt_uart_ops *ops;
|
|
struct serial_configure config;
|
|
|
|
void *serial_rx;
|
|
void *serial_tx;
|
|
|
|
struct rt_spinlock spinlock;
|
|
|
|
struct rt_device_notify rx_notify;
|
|
};
|
|
typedef struct rt_serial_device rt_serial_t;
|
|
|
|
/**
|
|
* uart operators
|
|
*/
|
|
struct rt_uart_ops
|
|
{
|
|
rt_err_t (*configure)(struct rt_serial_device *serial, struct serial_configure *cfg);
|
|
rt_err_t (*control)(struct rt_serial_device *serial, int cmd, void *arg);
|
|
|
|
int (*putc)(struct rt_serial_device *serial, char c);
|
|
int (*getc)(struct rt_serial_device *serial);
|
|
|
|
rt_ssize_t (*dma_transmit)(struct rt_serial_device *serial, rt_uint8_t *buf, rt_size_t size, int direction);
|
|
};
|
|
|
|
void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
|
|
|
|
rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
|
|
const char *name,
|
|
rt_uint32_t flag,
|
|
void *data);
|
|
|
|
rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
|
|
#endif
|