diff options
Diffstat (limited to 'nuttx/include/nuttx/serial/serial.h')
| -rw-r--r-- | nuttx/include/nuttx/serial/serial.h | 343 |
1 files changed, 0 insertions, 343 deletions
diff --git a/nuttx/include/nuttx/serial/serial.h b/nuttx/include/nuttx/serial/serial.h deleted file mode 100644 index 4ee2005ef..000000000 --- a/nuttx/include/nuttx/serial/serial.h +++ /dev/null @@ -1,343 +0,0 @@ -/************************************************************************************ - * include/nuttx/serial/serial.h - * - * Copyright (C) 2007-2008, 2012-2013 Gregory Nutt. All rights reserved. - * Author: Gregory Nutt <gnutt@nuttx.org> - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * 3. Neither the name NuttX nor the names of its contributors may be - * used to endorse or promote products derived from this software - * without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED - * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN - * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - * - ************************************************************************************/ - -#ifndef __INCLUDE_NUTTX_SERIAL_SERIAL_H -#define __INCLUDE_NUTTX_SERIAL_SERIAL_H - -/************************************************************************************ - * Included Files - ************************************************************************************/ - -#include <nuttx/config.h> - -#include <sys/types.h> -#include <stdint.h> -#include <stdbool.h> -#include <semaphore.h> -#ifdef CONFIG_SERIAL_TERMIOS -# include <termios.h> -#endif - -#include <nuttx/fs/fs.h> - -/************************************************************************************ - * Definitions - ************************************************************************************/ - -/* Maximum number of threads than can be waiting for POLL events */ - -#ifndef CONFIG_SERIAL_NPOLLWAITERS -# define CONFIG_SERIAL_NPOLLWAITERS 2 -#endif - -/* vtable access helpers */ - -#define uart_setup(dev) dev->ops->setup(dev) -#define uart_shutdown(dev) dev->ops->shutdown(dev) -#define uart_attach(dev) dev->ops->attach(dev) -#define uart_detach(dev) dev->ops->detach(dev) -#define uart_enabletxint(dev) dev->ops->txint(dev, true) -#define uart_disabletxint(dev) dev->ops->txint(dev, false) -#define uart_enablerxint(dev) dev->ops->rxint(dev, true) -#define uart_disablerxint(dev) dev->ops->rxint(dev, false) -#define uart_rxavailable(dev) dev->ops->rxavailable(dev) -#define uart_txready(dev) dev->ops->txready(dev) -#define uart_txempty(dev) dev->ops->txempty(dev) -#define uart_send(dev,ch) dev->ops->send(dev,ch) -#define uart_receive(dev,s) dev->ops->receive(dev,s) - -/************************************************************************************ - * Public Types - ************************************************************************************/ - -/* This structure defines one serial I/O buffer. The serial infrastructure will - * initialize the 'sem' field but all other fields must be initialized by the - * caller of uart_register(). - */ - -struct uart_buffer_s -{ - sem_t sem; /* Used to control exclusive access to the buffer */ - volatile int16_t head; /* Index to the head [IN] index in the buffer */ - volatile int16_t tail; /* Index to the tail [OUT] index in the buffer */ - int16_t size; /* The allocated size of the buffer */ - FAR char *buffer; /* Pointer to the allocated buffer memory */ -}; - -/* This structure defines all of the operations providd by the architecture specific - * logic. All fields must be provided with non-NULL function pointers by the - * caller of uart_register(). - */ - -struct uart_dev_s; -struct uart_ops_s -{ - /* Configure the UART baud, bits, parity, fifos, etc. This method is called - * the first time that the serial port is opened. For the serial console, - * this will occur very early in initialization; for other serial ports this - * will occur when the port is first opened. This setup does not include - * attaching or enabling interrupts. That portion of the UART setup is - * performed when the attach() method is called. - */ - - CODE int (*setup)(FAR struct uart_dev_s *dev); - - /* Disable the UART. This method is called when the serial port is closed. - * This method reverses the operation the setup method. NOTE that the serial - * console is never shutdown. - */ - - CODE void (*shutdown)(FAR struct uart_dev_s *dev); - - /* Configure the UART to operation in interrupt driven mode. This method is - * called when the serial port is opened. Normally, this is just after the - * the setup() method is called, however, the serial console may operate in - * a non-interrupt driven mode during the boot phase. - * - * RX and TX interrupts are not enabled when by the attach method (unless the - * hardware supports multiple levels of interrupt enabling). The RX and TX - * interrupts are not enabled until the txint() and rxint() methods are called. - */ - - CODE int (*attach)(FAR struct uart_dev_s *dev); - - /* Detach UART interrupts. This method is called when the serial port is - * closed normally just before the shutdown method is called. The exception is - * the serial console which is never shutdown. - */ - - CODE void (*detach)(FAR struct uart_dev_s *dev); - - /* All ioctl calls will be routed through this method */ - - CODE int (*ioctl)(FAR struct file *filep, int cmd, unsigned long arg); - - /* Called (usually) from the interrupt level to receive one character from - * the UART. Error bits associated with the receipt are provided in the - * the return 'status'. - */ - - CODE int (*receive)(FAR struct uart_dev_s *dev, FAR unsigned int *status); - - /* Call to enable or disable RX interrupts */ - - CODE void (*rxint)(FAR struct uart_dev_s *dev, bool enable); - - /* Return true if the receive data is available */ - - CODE bool (*rxavailable)(FAR struct uart_dev_s *dev); - - /* This method will send one byte on the UART */ - - CODE void (*send)(FAR struct uart_dev_s *dev, int ch); - - /* Call to enable or disable TX interrupts */ - - CODE void (*txint)(FAR struct uart_dev_s *dev, bool enable); - - /* Return true if the tranmsit hardware is ready to send another byte. This - * is used to determine if send() method can be called. - */ - - CODE bool (*txready)(FAR struct uart_dev_s *dev); - - /* Return true if all characters have been sent. If for example, the UART - * hardware implements FIFOs, then this would mean the transmit FIFO is - * empty. This method is called when the driver needs to make sure that - * all characters are "drained" from the TX hardware. - */ - - CODE bool (*txempty)(FAR struct uart_dev_s *dev); -}; - -/* This is the device structure used by the driver. The caller of - * uart_register() must allocate and initialize this structure. The - * calling logic need only set all fields to zero except: - * - * 'isconsole', 'xmit.buffer', 'rcv.buffer', the elements - * of 'ops', and 'private' - * - * The common logic will initialize all semaphores. - */ - -struct uart_dev_s -{ - uint8_t open_count; /* Number of times the device has been opened */ - volatile bool xmitwaiting; /* true: User waiting for space in xmit.buffer */ - volatile bool recvwaiting; /* true: User waiting for data in recv.buffer */ -#ifdef CONFIG_SERIAL_REMOVABLE - volatile bool disconnected; /* true: Removable device is not connected */ -#endif - bool isconsole; /* true: This is the serial console */ - sem_t closesem; /* Locks out new open while close is in progress */ - sem_t xmitsem; /* Wakeup user waiting for space in xmit.buffer */ - sem_t recvsem; /* Wakeup user waiting for data in recv.buffer */ -#ifndef CONFIG_DISABLE_POLL - sem_t pollsem; /* Manages exclusive access to fds[] */ -#endif - struct uart_buffer_s xmit; /* Describes transmit buffer */ - struct uart_buffer_s recv; /* Describes receive buffer */ - FAR const struct uart_ops_s *ops; /* Arch-specific operations */ - FAR void *priv; /* Used by the arch-specific logic */ - - /* The following is a list if poll structures of threads waiting for - * driver events. The 'struct pollfd' reference for each open is also - * retained in the f_priv field of the 'struct file'. - */ - -#ifndef CONFIG_DISABLE_POLL - struct pollfd *fds[CONFIG_SERIAL_NPOLLWAITERS]; -#endif - - /* Terminal control flags */ - -#ifdef CONFIG_SERIAL_TERMIOS - tcflag_t tc_iflag; /* Input modes */ - tcflag_t tc_oflag; /* Output modes */ - tcflag_t tc_lflag; /* Local modes */ -#endif - -}; - -typedef struct uart_dev_s uart_dev_t; - -/************************************************************************************ - * Public Data - ************************************************************************************/ - -#undef EXTERN -#if defined(__cplusplus) -#define EXTERN extern "C" -extern "C" -{ -#else -#define EXTERN extern -#endif - -/************************************************************************************ - * Public Functions - ************************************************************************************/ - -/************************************************************************************ - * Name: uart_register - * - * Description: - * Register serial console and serial ports. - * - ************************************************************************************/ - -int uart_register(FAR const char *path, FAR uart_dev_t *dev); - -/************************************************************************************ - * Name: uart_xmitchars - * - * Description: - * This function is called from the UART interrupt handler when an interrupt - * is received indicating that there is more space in the transmit FIFO. This - * function will send characters from the tail of the xmit buffer while the driver - * write() logic adds data to the head of the xmit buffer. - * - ************************************************************************************/ - -void uart_xmitchars(FAR uart_dev_t *dev); - -/************************************************************************************ - * Name: uart_receivechars - * - * Description: - * This function is called from the UART interrupt handler when an interrupt - * is received indicating that are bytes available to be received. This - * function will add chars to head of receive buffer. Driver read() logic will take - * characters from the tail of the buffer. - * - ************************************************************************************/ - -void uart_recvchars(FAR uart_dev_t *dev); - -/************************************************************************************ - * Name: uart_datareceived - * - * Description: - * This function is called from uart_recvchars when new serial data is place in - * the driver's circular buffer. This function will wake-up any stalled read() - * operations that are waiting for incoming data. - * - ************************************************************************************/ - -void uart_datareceived(FAR uart_dev_t *dev); - -/************************************************************************************ - * Name: uart_datasent - * - * Description: - * This function is called from uart_xmitchars after serial data has been sent, - * freeing up some space in the driver's circular buffer. This function will - * wake-up any stalled write() operations that was waiting for space to buffer - * outgoing data. - * - ************************************************************************************/ - -void uart_datasent(FAR uart_dev_t *dev); - -/************************************************************************************ - * Name: uart_connected - * - * Description: - * Serial devices (like USB serial) can be removed. In that case, the "upper - * half" serial driver must be informed that there is no longer a valid serial - * channel associated with the driver. - * - * In this case, the driver will terminate all pending transfers wint ENOTCONN and - * will refuse all further transactions while the "lower half" is disconnected. - * The driver will continue to be registered, but will be in an unusable state. - * - * Conversely, the "upper half" serial driver needs to know when the serial - * device is reconnected so that it can resume normal operations. - * - * Assumptions/Limitations: - * This function may be called from an interrupt handler. - * - ************************************************************************************/ - -#ifdef CONFIG_SERIAL_REMOVABLE -void uart_connected(FAR uart_dev_t *dev, bool connected); -#endif - -#undef EXTERN -#if defined(__cplusplus) -} -#endif - -#endif /* __INCLUDE_NUTTX_SERIAL_SERIAL_H */ |