Serial

Collaboration diagram for Serial:

Data Structures
struct	rt_serial_rx_fifo
struct	rt_serial_tx_fifo
struct	rt_serial_device
struct	rt_uart_ops

Typedefs
typedef void(*	rt_hw_serial_rxind_hookproto_t) (rt_device_t dev, rt_size_t size)

Functions
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)

Detailed Description

Serial driver api.

Example

#include <rtthread.h>
 
#define SAMPLE_UART_NAME       "uart2"
static struct rt_semaphore rx_sem;
static rt_device_t serial;
 
static rt_err_t uart_input(rt_device_t dev, rt_size_t size)
{
 
    rt_sem_release(&rx_sem);
 
    return RT_EOK;
}
 
static void serial_thread_entry(void *parameter)
{
    char ch;
 
    while (1)
    {
 
        while (rt_device_read(serial, -1, &ch, 1) != 1)
        {
 
            rt_sem_take(&rx_sem, RT_WAITING_FOREVER);
        }
 
        ch = ch + 1;
        rt_device_write(serial, 0, &ch, 1);
    }
}
 
static int uart_sample(int argc, char *argv[])
{
    rt_err_t ret = RT_EOK;
    char uart_name[RT_NAME_MAX];
    char str[] = "hello RT-Thread!\r\n";
 
    if (argc == 2)
    {
        rt_strncpy(uart_name, argv[1], RT_NAME_MAX);
    }
    else
    {
        rt_strncpy(uart_name, SAMPLE_UART_NAME, RT_NAME_MAX);
    }
 
 
    serial = rt_device_find(uart_name);
    if (!serial)
    {
        rt_kprintf("find %s failed!\n", uart_name);
        return -RT_ERROR;
    }
 
 
    rt_sem_init(&rx_sem, "rx_sem", 0, RT_IPC_FLAG_FIFO);
 
    rt_device_open(serial, RT_DEVICE_FLAG_INT_RX);
 
    rt_device_set_rx_indicate(serial, uart_input);
 
    rt_device_write(serial, 0, str, (sizeof(str) - 1));
 
 
    rt_thread_t thread = rt_thread_create("serial", serial_thread_entry, RT_NULL, 1024, 25, 10);
 
    if (thread != RT_NULL)
    {
        rt_thread_startup(thread);
    }
    else
    {
        ret = -RT_ERROR;
    }
 
    return ret;
}
 
MSH_CMD_EXPORT(uart_sample, uart device sample);

Typedef Documentation

rt_hw_serial_rxind_hookproto_t

typedef void(* rt_hw_serial_rxind_hookproto_t) (rt_device_t dev, rt_size_t size)

Sets a hook function when RX indicate is called.

Function Documentation

rt_hw_serial_isr()

void rt_hw_serial_isr	(	struct rt_serial_device *	serial,
		int	event
	)

Serial interrupt service routine.

Parameters

serial	serial device
event	event mask

rt_hw_serial_register()

rt_err_t rt_hw_serial_register	(	struct rt_serial_device *	serial,
		const char *	name,
		rt_uint32_t	flag,
		void *	data
	)

Register a serial device to device list.

Parameters

serial	serial device
name	device name
flag	device flag
data	device private data

Returns

rt_err_t error code

Note

This function will register a serial device to system device list, and add a device object to system object list.

rt_hw_serial_register_tty()

rt_err_t rt_hw_serial_register_tty

(

struct rt_serial_device *

serial

)

register a serial device to system device list and add a device object to system object list

Parameters

serial

serial device

Returns

rt_err_t error code