445 lines
13 KiB
C
445 lines
13 KiB
C
/*
|
|
* File : serial.c
|
|
* This file is part of RT-Thread RTOS
|
|
* COPYRIGHT (C) 2006 - 2012, RT-Thread Development Team
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Change Logs:
|
|
* Date Author Notes
|
|
* 2006-03-13 bernard first version
|
|
* 2012-05-15 lgnq modified according bernard's implementation.
|
|
* 2012-05-28 bernard code cleanup
|
|
* 2012-11-23 bernard fix compiler warning.
|
|
* 2013-02-20 bernard use RT_SERIAL_RB_BUFSZ to define
|
|
* the size of ring buffer.
|
|
* 2014-07-10 bernard rewrite serial framework
|
|
* 2014-12-31 bernard use open_flag for poll_tx stream mode.
|
|
* 2015-05-19 Quintin fix DMA tx mod tx_dma->activated flag !=RT_FALSE BUG
|
|
* in open function.
|
|
* 2015-11-10 bernard fix the poll rx issue when there is no data.
|
|
* 2016-05-10 armink add fifo mode to DMA rx when serial->config.bufsz != 0.
|
|
* 2017-01-19 aubr.cool prevent change serial rx bufsz when serial is opened.
|
|
* 2017-11-07 JasonJia fix data bits error issue when using tcsetattr.
|
|
* 2017-11-15 JasonJia fix poll rx issue when data is full.
|
|
* add TCFLSH and FIONREAD support.
|
|
*/
|
|
|
|
#include <rthw.h>
|
|
#include <rtthread.h>
|
|
#include <rtdevice.h>
|
|
|
|
// #define DEBUG_ENABLE
|
|
#define DEBUG_LEVEL DBG_LOG
|
|
#define DBG_SECTION_NAME "[UART]"
|
|
#define DEBUG_COLOR
|
|
#include <rtdbg.h>
|
|
|
|
/*
|
|
* Serial poll routines
|
|
*/
|
|
rt_inline int _serial_poll_rx(struct rt_serial_device *serial, rt_uint8_t *data, int length)
|
|
{
|
|
int ch;
|
|
int size;
|
|
|
|
RT_ASSERT(serial != RT_NULL);
|
|
size = length;
|
|
|
|
while (length)
|
|
{
|
|
ch = serial->ops->getc(serial);
|
|
if (ch == -1) break;
|
|
|
|
*data = ch;
|
|
data ++; length --;
|
|
|
|
if (ch == '\n') break;
|
|
}
|
|
|
|
return size - length;
|
|
}
|
|
|
|
rt_inline int _serial_poll_tx(struct rt_serial_device *serial, const rt_uint8_t *data, int length)
|
|
{
|
|
int size;
|
|
RT_ASSERT(serial != RT_NULL);
|
|
|
|
size = length;
|
|
while (length)
|
|
{
|
|
/*
|
|
* to be polite with serial console add a line feed
|
|
* to the carriage return character
|
|
*/
|
|
if (*data == '\n' && (serial->parent.open_flag & RT_DEVICE_FLAG_STREAM))
|
|
{
|
|
serial->ops->putc(serial, '\r');
|
|
}
|
|
|
|
serial->ops->putc(serial, *data);
|
|
|
|
++ data;
|
|
-- length;
|
|
}
|
|
|
|
return size - length;
|
|
}
|
|
|
|
/*
|
|
* Serial interrupt routines
|
|
*/
|
|
rt_inline int _serial_int_rx(struct rt_serial_device *serial, rt_uint8_t *data, int length)
|
|
{
|
|
int size;
|
|
struct rt_serial_rx_fifo* rx_fifo;
|
|
|
|
RT_ASSERT(serial != RT_NULL);
|
|
size = length;
|
|
|
|
rx_fifo = (struct rt_serial_rx_fifo*) serial->serial_rx;
|
|
RT_ASSERT(rx_fifo != RT_NULL);
|
|
|
|
/* read from software FIFO */
|
|
while (length)
|
|
{
|
|
int ch;
|
|
rt_base_t level;
|
|
|
|
/* disable interrupt */
|
|
level = rt_hw_interrupt_disable();
|
|
|
|
/* there's no data: */
|
|
if ((rx_fifo->get_index == rx_fifo->put_index) && (rx_fifo->is_full == RT_FALSE))
|
|
{
|
|
/* no data, enable interrupt and break out */
|
|
rt_hw_interrupt_enable(level);
|
|
break;
|
|
}
|
|
|
|
/* otherwise there's the data: */
|
|
ch = rx_fifo->buffer[rx_fifo->get_index];
|
|
rx_fifo->get_index += 1;
|
|
if (rx_fifo->get_index >= serial->config.bufsz) rx_fifo->get_index = 0;
|
|
|
|
if (rx_fifo->is_full == RT_TRUE)
|
|
{
|
|
rx_fifo->is_full = RT_FALSE;
|
|
}
|
|
|
|
/* enable interrupt */
|
|
rt_hw_interrupt_enable(level);
|
|
|
|
*data = ch & 0xff;
|
|
data ++; length --;
|
|
}
|
|
|
|
return size - length;
|
|
}
|
|
|
|
/* RT-Thread Device Interface */
|
|
/*
|
|
* This function initializes serial device.
|
|
*/
|
|
static rt_err_t rt_serial_init(struct rt_device *dev)
|
|
{
|
|
rt_err_t result = RT_EOK;
|
|
struct rt_serial_device *serial;
|
|
|
|
RT_ASSERT(dev != RT_NULL);
|
|
serial = (struct rt_serial_device *)dev;
|
|
|
|
/* initialize rx/tx */
|
|
serial->serial_rx = RT_NULL;
|
|
serial->serial_tx = RT_NULL;
|
|
|
|
/* apply configuration */
|
|
if (serial->ops->configure)
|
|
result = serial->ops->configure(serial, &serial->config);
|
|
|
|
return result;
|
|
}
|
|
|
|
static rt_err_t rt_serial_open(struct rt_device *dev, rt_uint16_t oflag)
|
|
{
|
|
rt_uint16_t stream_flag = 0;
|
|
struct rt_serial_device *serial;
|
|
|
|
RT_ASSERT(dev != RT_NULL);
|
|
serial = (struct rt_serial_device *)dev;
|
|
|
|
dbg_log(DBG_LOG, "open serial device: 0x%08x with open flag: 0x%04x\n",
|
|
dev, oflag);
|
|
/* check device flag with the open flag */
|
|
if ((oflag & RT_DEVICE_FLAG_INT_RX) && !(dev->flag & RT_DEVICE_FLAG_INT_RX))
|
|
return -RT_EIO;
|
|
if ((oflag & RT_DEVICE_FLAG_INT_TX) && !(dev->flag & RT_DEVICE_FLAG_INT_TX))
|
|
return -RT_EIO;
|
|
|
|
/* keep steam flag */
|
|
if ((oflag & RT_DEVICE_FLAG_STREAM) || (dev->open_flag & RT_DEVICE_FLAG_STREAM))
|
|
stream_flag = RT_DEVICE_FLAG_STREAM;
|
|
|
|
/* get open flags */
|
|
dev->open_flag = oflag & 0xff;
|
|
|
|
/* initialize the Rx/Tx structure according to open flag */
|
|
if (serial->serial_rx == RT_NULL)
|
|
{
|
|
if (oflag & RT_DEVICE_FLAG_INT_RX)
|
|
{
|
|
struct rt_serial_rx_fifo* rx_fifo;
|
|
|
|
rx_fifo = (struct rt_serial_rx_fifo*) rt_malloc (sizeof(struct rt_serial_rx_fifo) +
|
|
serial->config.bufsz);
|
|
RT_ASSERT(rx_fifo != RT_NULL);
|
|
rx_fifo->buffer = (rt_uint8_t*) (rx_fifo + 1);
|
|
rt_memset(rx_fifo->buffer, 0, serial->config.bufsz);
|
|
rx_fifo->put_index = 0;
|
|
rx_fifo->get_index = 0;
|
|
rx_fifo->is_full = RT_FALSE;
|
|
|
|
serial->serial_rx = rx_fifo;
|
|
dev->open_flag |= RT_DEVICE_FLAG_INT_RX;
|
|
/* configure low level device */
|
|
serial->ops->control(serial, RT_DEVICE_CTRL_SET_INT, (void *)RT_DEVICE_FLAG_INT_RX);
|
|
}
|
|
else
|
|
{
|
|
serial->serial_rx = RT_NULL;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (oflag & RT_DEVICE_FLAG_INT_RX)
|
|
dev->open_flag |= RT_DEVICE_FLAG_INT_RX;
|
|
}
|
|
|
|
if (serial->serial_tx == RT_NULL)
|
|
{
|
|
|
|
serial->serial_tx = RT_NULL;
|
|
}
|
|
|
|
/* set stream flag */
|
|
dev->open_flag |= stream_flag;
|
|
|
|
return RT_EOK;
|
|
}
|
|
|
|
static rt_err_t rt_serial_close(struct rt_device *dev)
|
|
{
|
|
struct rt_serial_device *serial;
|
|
|
|
RT_ASSERT(dev != RT_NULL);
|
|
serial = (struct rt_serial_device *)dev;
|
|
|
|
/* this device has more reference count */
|
|
if (dev->ref_count > 1) return RT_EOK;
|
|
|
|
if (dev->open_flag & RT_DEVICE_FLAG_INT_RX)
|
|
{
|
|
struct rt_serial_rx_fifo* rx_fifo;
|
|
|
|
rx_fifo = (struct rt_serial_rx_fifo*)serial->serial_rx;
|
|
RT_ASSERT(rx_fifo != RT_NULL);
|
|
|
|
rt_free(rx_fifo);
|
|
serial->serial_rx = RT_NULL;
|
|
dev->open_flag &= ~RT_DEVICE_FLAG_INT_RX;
|
|
/* configure low level device */
|
|
serial->ops->control(serial, RT_DEVICE_CTRL_CLR_INT, (void*)RT_DEVICE_FLAG_INT_RX);
|
|
}
|
|
|
|
return RT_EOK;
|
|
}
|
|
|
|
static rt_size_t rt_serial_read(struct rt_device *dev,
|
|
rt_off_t pos,
|
|
void *buffer,
|
|
rt_size_t size)
|
|
{
|
|
struct rt_serial_device *serial;
|
|
|
|
RT_ASSERT(dev != RT_NULL);
|
|
if (size == 0) return 0;
|
|
|
|
serial = (struct rt_serial_device *)dev;
|
|
|
|
if (dev->open_flag & RT_DEVICE_FLAG_INT_RX)
|
|
{
|
|
return _serial_int_rx(serial, buffer, size);
|
|
}
|
|
|
|
return _serial_poll_rx(serial, buffer, size);
|
|
}
|
|
|
|
static rt_size_t rt_serial_write(struct rt_device *dev,
|
|
rt_off_t pos,
|
|
const void *buffer,
|
|
rt_size_t size)
|
|
{
|
|
struct rt_serial_device *serial;
|
|
|
|
RT_ASSERT(dev != RT_NULL);
|
|
if (size == 0) return 0;
|
|
|
|
serial = (struct rt_serial_device *)dev;
|
|
|
|
return _serial_poll_tx(serial, buffer, size);
|
|
}
|
|
|
|
static rt_err_t rt_serial_control(struct rt_device *dev,
|
|
int cmd,
|
|
void *args)
|
|
{
|
|
rt_err_t ret = RT_EOK;
|
|
struct rt_serial_device *serial;
|
|
|
|
RT_ASSERT(dev != RT_NULL);
|
|
serial = (struct rt_serial_device *)dev;
|
|
|
|
switch (cmd)
|
|
{
|
|
case RT_DEVICE_CTRL_SUSPEND:
|
|
/* suspend device */
|
|
dev->flag |= RT_DEVICE_FLAG_SUSPENDED;
|
|
break;
|
|
|
|
case RT_DEVICE_CTRL_RESUME:
|
|
/* resume device */
|
|
dev->flag &= ~RT_DEVICE_FLAG_SUSPENDED;
|
|
break;
|
|
|
|
case RT_DEVICE_CTRL_CONFIG:
|
|
if (args)
|
|
{
|
|
struct serial_configure *pconfig = (struct serial_configure *) args;
|
|
if (pconfig->bufsz != serial->config.bufsz && serial->parent.ref_count)
|
|
{
|
|
/*can not change buffer size*/
|
|
return RT_EBUSY;
|
|
}
|
|
/* set serial configure */
|
|
serial->config = *pconfig;
|
|
if (serial->parent.ref_count)
|
|
{
|
|
/* serial device has been opened, to configure it */
|
|
serial->ops->configure(serial, (struct serial_configure *) args);
|
|
}
|
|
}
|
|
|
|
break;
|
|
|
|
default :
|
|
/* control device */
|
|
ret = serial->ops->control(serial, cmd, args);
|
|
break;
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
/*
|
|
* serial register
|
|
*/
|
|
rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
|
|
const char *name,
|
|
rt_uint32_t flag,
|
|
void *data)
|
|
{
|
|
rt_err_t ret;
|
|
struct rt_device *device;
|
|
RT_ASSERT(serial != RT_NULL);
|
|
|
|
device = &(serial->parent);
|
|
|
|
device->type = RT_Device_Class_Char;
|
|
device->rx_indicate = RT_NULL;
|
|
device->tx_complete = RT_NULL;
|
|
|
|
device->init = rt_serial_init;
|
|
device->open = rt_serial_open;
|
|
device->close = rt_serial_close;
|
|
device->read = rt_serial_read;
|
|
device->write = rt_serial_write;
|
|
device->control = rt_serial_control;
|
|
device->user_data = data;
|
|
|
|
/* register a character device */
|
|
ret = rt_device_register(device, name, flag);
|
|
|
|
return ret;
|
|
}
|
|
|
|
/* ISR for serial interrupt */
|
|
void rt_hw_serial_isr(struct rt_serial_device *serial, int event)
|
|
{
|
|
switch (event & 0xff)
|
|
{
|
|
case RT_SERIAL_EVENT_RX_IND:
|
|
{
|
|
int ch = -1;
|
|
rt_base_t level;
|
|
struct rt_serial_rx_fifo* rx_fifo;
|
|
|
|
/* interrupt mode receive */
|
|
rx_fifo = (struct rt_serial_rx_fifo*)serial->serial_rx;
|
|
RT_ASSERT(rx_fifo != RT_NULL);
|
|
|
|
while (1)
|
|
{
|
|
ch = serial->ops->getc(serial);
|
|
if (ch == -1) break;
|
|
|
|
|
|
/* disable interrupt */
|
|
level = rt_hw_interrupt_disable();
|
|
|
|
rx_fifo->buffer[rx_fifo->put_index] = ch;
|
|
rx_fifo->put_index += 1;
|
|
if (rx_fifo->put_index >= serial->config.bufsz) rx_fifo->put_index = 0;
|
|
|
|
/* if the next position is read index, discard this 'read char' */
|
|
if (rx_fifo->put_index == rx_fifo->get_index)
|
|
{
|
|
rx_fifo->get_index += 1;
|
|
rx_fifo->is_full = RT_TRUE;
|
|
if (rx_fifo->get_index >= serial->config.bufsz) rx_fifo->get_index = 0;
|
|
}
|
|
|
|
/* enable interrupt */
|
|
rt_hw_interrupt_enable(level);
|
|
}
|
|
|
|
/* invoke callback */
|
|
if (serial->parent.rx_indicate != RT_NULL)
|
|
{
|
|
rt_size_t rx_length;
|
|
|
|
/* get rx length */
|
|
level = rt_hw_interrupt_disable();
|
|
rx_length = (rx_fifo->put_index >= rx_fifo->get_index)? (rx_fifo->put_index - rx_fifo->get_index):
|
|
(serial->config.bufsz - (rx_fifo->get_index - rx_fifo->put_index));
|
|
rt_hw_interrupt_enable(level);
|
|
|
|
serial->parent.rx_indicate(&serial->parent, rx_length);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|