1126 lines
30 KiB
C
1126 lines
30 KiB
C
/****************************************************************************
|
|
* drivers/serial/pty.c
|
|
*
|
|
* Copyright (C) 2016 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/ioctl.h>
|
|
#include <stdbool.h>
|
|
#include <unistd.h>
|
|
#include <sched.h>
|
|
#include <semaphore.h>
|
|
#include <termios.h>
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <poll.h>
|
|
#include <assert.h>
|
|
#include <errno.h>
|
|
|
|
#include <nuttx/kmalloc.h>
|
|
#include <nuttx/fs/fs.h>
|
|
#include <nuttx/drivers/drivers.h>
|
|
#include <nuttx/serial/pty.h>
|
|
|
|
#include "pty.h"
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Should never be set... only for comparison to serial.c */
|
|
|
|
#undef CONFIG_PSEUDOTERM_FULLBLOCKS
|
|
|
|
/****************************************************************************
|
|
* Private Types
|
|
****************************************************************************/
|
|
|
|
/* This device structure describes on memory of the PTY device pair */
|
|
|
|
struct pty_devpair_s;
|
|
struct pty_dev_s
|
|
{
|
|
FAR struct pty_devpair_s *pd_devpair;
|
|
struct file pd_src; /* Provides data to read() method (pipe output) */
|
|
struct file pd_sink; /* Accepts data from write() method (pipe input) */
|
|
bool pd_master; /* True: this is the master */
|
|
|
|
#ifdef CONFIG_SERIAL_TERMIOS
|
|
/* Terminal control flags */
|
|
|
|
tcflag_t pd_iflag; /* Terminal nput modes */
|
|
tcflag_t pd_oflag; /* Terminal output modes */
|
|
#endif
|
|
};
|
|
|
|
/* This structure describes the pipe pair */
|
|
|
|
struct pty_devpair_s
|
|
{
|
|
struct pty_dev_s pp_master; /* Maseter device */
|
|
struct pty_dev_s pp_slave; /* Slave device */
|
|
|
|
bool pp_locked; /* Slave is locked */
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
bool pp_unlinked; /* File has been unlinked */
|
|
uint8_t pp_minor; /* Minor device number */
|
|
uint16_t pp_nopen; /* Open file count */
|
|
#endif
|
|
sem_t pp_slavesem; /* Slave lock semaphore */
|
|
sem_t pp_exclsem; /* Mutual exclusion */
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Private Function Prototypes
|
|
****************************************************************************/
|
|
|
|
static void pty_semtake(FAR struct pty_devpair_s *devpair);
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
static void pty_destroy(FAR struct pty_devpair_s *devpair);
|
|
#endif
|
|
|
|
static int pty_open(FAR struct file *filep);
|
|
static int pty_close(FAR struct file *filep);
|
|
static ssize_t pty_read(FAR struct file *filep, FAR char *buffer,
|
|
size_t buflen);
|
|
static ssize_t pty_write(FAR struct file *filep, FAR const char *buffer,
|
|
size_t buflen);
|
|
static int pty_ioctl(FAR struct file *filep, int cmd, unsigned long arg);
|
|
#ifndef CONFIG_DISABLE_POLL
|
|
static int pty_poll(FAR struct file *filep, FAR struct pollfd *fds,
|
|
bool setup);
|
|
#endif
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
static int pty_unlink(FAR struct inode *inode);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Private Data
|
|
****************************************************************************/
|
|
|
|
static const struct file_operations g_pty_fops =
|
|
{
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
pty_open, /* open */
|
|
pty_close, /* close */
|
|
#else
|
|
NULL, /* open */
|
|
NULL, /* close */
|
|
#endif
|
|
pty_read, /* read */
|
|
pty_write, /* write */
|
|
NULL, /* seek */
|
|
pty_ioctl /* ioctl */
|
|
#ifndef CONFIG_DISABLE_POLL
|
|
, pty_poll /* poll */
|
|
#endif
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
, pty_unlink /* unlink */
|
|
#endif
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Private Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: pty_semtake
|
|
****************************************************************************/
|
|
|
|
static void pty_semtake(FAR struct pty_devpair_s *devpair)
|
|
{
|
|
while (sem_wait(&devpair->pp_exclsem) < 0)
|
|
{
|
|
DEBUGASSERT(errno == EINTR);
|
|
}
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: pty_semgive
|
|
****************************************************************************/
|
|
|
|
#define pty_semgive(c) sem_post(&(c)->pp_exclsem)
|
|
|
|
/****************************************************************************
|
|
* Name: pty_destroy
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
static void pty_destroy(FAR struct pty_devpair_s *devpair)
|
|
{
|
|
char devname[16];
|
|
|
|
/* Un-register the slave device */
|
|
|
|
#ifdef CONFIG_PSEUDOTERM_BSD
|
|
snprintf(devname, 16, "/dev/ttyp%d", devpair->pp_minor);
|
|
#else
|
|
snprintf(devname, 16, "/dev/pts/%d", devpair->pp_minor);
|
|
#endif
|
|
(void)unregister_driver(devname);
|
|
|
|
/* Un-register the master device (/dev/ptyN may have already been
|
|
* unlinked).
|
|
*/
|
|
|
|
snprintf(devname, 16, "/dev/pty%d", (int)devpair->pp_minor);
|
|
(void)unregister_driver(devname);
|
|
|
|
/* Close the contained file structures */
|
|
|
|
(void)file_close_detached(&devpair->pp_master.pd_src);
|
|
(void)file_close_detached(&devpair->pp_master.pd_sink);
|
|
(void)file_close_detached(&devpair->pp_slave.pd_src);
|
|
(void)file_close_detached(&devpair->pp_slave.pd_sink);
|
|
|
|
#ifdef CONFIG_PSEUDOTERM_SUSV1
|
|
/* Free this minor number so that it can be reused */
|
|
|
|
ptmx_minor_free(devpair->pp_minor);
|
|
#endif
|
|
|
|
/* And free the device structure */
|
|
|
|
sem_destroy(&devpair->pp_exclsem);
|
|
kmm_free(devpair);
|
|
}
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: pty_open
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
static int pty_open(FAR struct file *filep)
|
|
{
|
|
FAR struct inode *inode;
|
|
FAR struct pty_dev_s *dev;
|
|
FAR struct pty_devpair_s *devpair;
|
|
int ret;
|
|
|
|
DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
|
|
inode = filep->f_inode;
|
|
dev = inode->i_private;
|
|
DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL);
|
|
devpair = dev->pd_devpair;
|
|
|
|
/* Wait if this is an attempt to open the slave device and the slave
|
|
* device is locked.
|
|
*/
|
|
|
|
if (!dev->pd_master)
|
|
{
|
|
/* Slave... Check if the slave driver is locked. We need to lock the
|
|
* scheduler while we are running to prevent asyncrhonous modification
|
|
* of pp_locked by pty_ioctl().
|
|
*/
|
|
|
|
sched_lock();
|
|
while (devpair->pp_locked)
|
|
{
|
|
/* Wait until unlocked. We will also most certainly suspend here. */
|
|
|
|
sem_wait(&devpair->pp_slavesem);
|
|
|
|
/* Get exclusive access to the device structure. This might also
|
|
* cause suspension.
|
|
*/
|
|
|
|
pty_semtake(devpair);
|
|
|
|
/* Check again in case something happened asynchronously while we
|
|
* were suspended.
|
|
*/
|
|
|
|
if (devpair->pp_locked)
|
|
{
|
|
/* This cannot suspend because we have the scheduler locked.
|
|
* So pp_locked cannot change asyncrhonously between this test
|
|
* and the redundant test at the top of the loop.
|
|
*/
|
|
|
|
pty_semgive(devpair);
|
|
}
|
|
}
|
|
|
|
sched_unlock();
|
|
}
|
|
else
|
|
{
|
|
/* Master ... Get exclusive access to the device structure */
|
|
|
|
pty_semtake(devpair);
|
|
}
|
|
|
|
#ifndef CONFIG_PSEUDOTERM_SUSV1
|
|
/* If one side of the driver has been unlinked, then refuse further
|
|
* opens.
|
|
*
|
|
* NOTE: We ignore this case in the SUSv1 case. In the SUSv1 case, the
|
|
* master side is always unlinked.
|
|
*/
|
|
|
|
if (devpair->pp_unlinked)
|
|
{
|
|
ret = -EIDRM;
|
|
}
|
|
else
|
|
#endif
|
|
{
|
|
/* Increment the count of open references on the driver */
|
|
|
|
devpair->pp_nopen++;
|
|
DEBUGASSERT(devpair->pp_nopen > 0);
|
|
|
|
ret = OK;
|
|
}
|
|
|
|
pty_semgive(devpair);
|
|
return ret;
|
|
}
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: pty_open
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
static int pty_close(FAR struct file *filep)
|
|
{
|
|
FAR struct inode *inode;
|
|
FAR struct pty_dev_s *dev;
|
|
FAR struct pty_devpair_s *devpair;
|
|
|
|
DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
|
|
inode = filep->f_inode;
|
|
dev = inode->i_private;
|
|
DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL);
|
|
devpair = dev->pd_devpair;
|
|
|
|
/* Get exclusive access */
|
|
|
|
pty_semtake(devpair);
|
|
|
|
#ifdef CONFIG_PSEUDOTERM_SUSV1
|
|
/* Did the (single) master just close its reference? */
|
|
|
|
if (dev->pd_master)
|
|
{
|
|
/* Yes, then we are essentially unlinked and when all of the
|
|
* slaves close there references, then the PTY should be
|
|
* destroyed.
|
|
*/
|
|
|
|
devpair->pp_unlinked = true;
|
|
}
|
|
#endif
|
|
|
|
/* Is this the last open reference? If so, was the driver previously
|
|
* unlinked?
|
|
*/
|
|
|
|
DEBUGASSERT(devpair->pp_nopen > 0);
|
|
if (devpair->pp_nopen <= 1 && devpair->pp_unlinked)
|
|
{
|
|
/* Yes.. Free the device pair now (without freeing the semaphore) */
|
|
|
|
pty_destroy(devpair);
|
|
return OK;
|
|
}
|
|
else
|
|
{
|
|
/* Otherwise just decrement the open count */
|
|
|
|
devpair->pp_nopen--;
|
|
}
|
|
|
|
pty_semgive(devpair);
|
|
return OK;
|
|
}
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: pty_read
|
|
****************************************************************************/
|
|
|
|
static ssize_t pty_read(FAR struct file *filep, FAR char *buffer, size_t len)
|
|
{
|
|
FAR struct inode *inode;
|
|
FAR struct pty_dev_s *dev;
|
|
ssize_t ntotal;
|
|
#ifdef CONFIG_SERIAL_TERMIOS
|
|
ssize_t nread;
|
|
size_t i;
|
|
char ch;
|
|
int ret;
|
|
#endif
|
|
|
|
DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
|
|
inode = filep->f_inode;
|
|
dev = inode->i_private;
|
|
DEBUGASSERT(dev != NULL);
|
|
|
|
#ifdef CONFIG_SERIAL_TERMIOS
|
|
/* Do input processing if any is enabled
|
|
*
|
|
* Specifically not handled:
|
|
*
|
|
* All of the local modes; echo, line editing, etc.
|
|
* Anything to do with break or parity errors.
|
|
* ISTRIP - We should be 8-bit clean.
|
|
* IUCLC - Not Posix
|
|
* IXON/OXOFF - No xon/xoff flow control.
|
|
*/
|
|
|
|
if (dev->pd_iflag & (INLCR | IGNCR | ICRNL))
|
|
{
|
|
/* We will transfer one byte at a time, making the appropriate
|
|
* translations.
|
|
*/
|
|
|
|
ntotal = 0;
|
|
for (i = 0; i < len; i++)
|
|
{
|
|
#ifndef CONFIG_PSEUDOTERM_FULLBLOCKS
|
|
/* This logic should return if the pipe becomes empty after some
|
|
* bytes were read from the pipe. If we have already read some
|
|
* data, we use the FIONREAD ioctl to test if there are more bytes
|
|
* in the pipe.
|
|
*
|
|
* REVISIT: An alternative design might be to (1) configure the
|
|
* source file as non-blocking, then (2) wait using poll() for the
|
|
* first byte to be received. (3) Subsequent bytes would
|
|
* use file_read() without polling and would (4) terminate when no
|
|
* data is returned.
|
|
*/
|
|
|
|
if (ntotal > 0)
|
|
{
|
|
int nsrc;
|
|
|
|
/* There are inherent race conditions in this test. We lock
|
|
* the scheduler before the test and after the file_read()
|
|
* below to eliminate one race: (a) We detect that there is
|
|
* data in the source file, (b) we are suspended and another
|
|
* thread reads the data, emptying the fifo, then (c) we
|
|
* resume and call file_read(), blocking indefinitely.
|
|
*/
|
|
|
|
sched_lock();
|
|
|
|
/* Check how many bytes are waiting in the pipe */
|
|
|
|
ret = file_ioctl(&dev->pd_src, FIONREAD,
|
|
(unsigned long)((uintptr_t)&nsrc));
|
|
if (ret < 0)
|
|
{
|
|
sched_unlock();
|
|
ntotal = ret;
|
|
break;
|
|
}
|
|
|
|
/* Break out of the loop and return ntotal if the pipe is
|
|
* empty. This is another race: There fifo was empty when we
|
|
* called file_ioctl() above, but it might not be empty right
|
|
* now. Losing that race should not lead to any bad behaviors,
|
|
* however, we the caller will get those bytes on the next
|
|
* read.
|
|
*/
|
|
|
|
if (nsrc < 1)
|
|
{
|
|
sched_unlock();
|
|
break;
|
|
}
|
|
|
|
/* Read one byte from the source the byte. This should not
|
|
* block.
|
|
*/
|
|
|
|
nread = file_read(&dev->pd_src, &ch, 1);
|
|
sched_unlock();
|
|
}
|
|
else
|
|
#else
|
|
/* If we wanted to return full blocks of data, then file_read()
|
|
* may need to be called repeatedly. That is because the pipe
|
|
* read() method will return early if the fifo becomes empty
|
|
* after any data has been read.
|
|
*/
|
|
|
|
# error Missing logic
|
|
#endif
|
|
{
|
|
/* Read one byte from the source the byte. This call will
|
|
* block if the source pipe is empty.
|
|
*
|
|
* REVISIT: Should not block if the oflags include O_NONBLOCK.
|
|
* How would we ripple the O_NONBLOCK characteristic to the
|
|
* contained soruce pipe? file_fcntl()?
|
|
*/
|
|
|
|
nread = file_read(&dev->pd_src, &ch, 1);
|
|
}
|
|
|
|
/* Check if file_read was successful */
|
|
|
|
if (nread < 0)
|
|
{
|
|
ntotal = nread;
|
|
break;
|
|
}
|
|
|
|
/* Perform input processing */
|
|
/* \n -> \r or \r -> \n translation? */
|
|
|
|
if (ch == '\n' && (dev->pd_iflag & INLCR) != 0)
|
|
{
|
|
ch = '\r';
|
|
}
|
|
else if (ch == '\r' && (dev->pd_iflag & ICRNL) != 0)
|
|
{
|
|
ch = '\n';
|
|
}
|
|
|
|
/* Discarding \r ? Print character if (1) character is not \r or
|
|
* if (2) we were not asked to ignore \r.
|
|
*/
|
|
|
|
if (ch != '\r' || (dev->pd_iflag & IGNCR) == 0)
|
|
{
|
|
|
|
/* Transfer the (possibly translated) character and update the
|
|
* count of bytes transferred.
|
|
*/
|
|
|
|
*buffer++ = ch;
|
|
ntotal++;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
#endif
|
|
{
|
|
/* NOTE: the source pipe will block if no data is available in
|
|
* the pipe. Otherwise, it will return data from the pipe. If
|
|
* there are fewer than 'len' bytes in the, it will return with
|
|
* ntotal < len.
|
|
*
|
|
* REVISIT: Should not block if the oflags include O_NONBLOCK.
|
|
* How would we ripple the O_NONBLOCK characteristic to the
|
|
* contained source pipe? file_fcntl()?
|
|
*/
|
|
|
|
ntotal = file_read(&dev->pd_src, buffer, len);
|
|
}
|
|
|
|
return ntotal;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: pty_write
|
|
****************************************************************************/
|
|
|
|
static ssize_t pty_write(FAR struct file *filep, FAR const char *buffer, size_t len)
|
|
{
|
|
FAR struct inode *inode;
|
|
FAR struct pty_dev_s *dev;
|
|
ssize_t ntotal;
|
|
#ifdef CONFIG_SERIAL_TERMIOS
|
|
ssize_t nwritten;
|
|
size_t i;
|
|
char ch;
|
|
#endif
|
|
|
|
DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
|
|
inode = filep->f_inode;
|
|
dev = inode->i_private;
|
|
DEBUGASSERT(dev != NULL);
|
|
|
|
#ifdef CONFIG_SERIAL_TERMIOS
|
|
/* Do output post-processing */
|
|
|
|
if ((dev->pd_oflag & OPOST) != 0)
|
|
{
|
|
/* We will transfer one byte at a time, making the appropriae
|
|
* translations. Specifically not handled:
|
|
*
|
|
* OXTABS - primarily a full-screen terminal optimisation
|
|
* ONOEOT - Unix interoperability hack
|
|
* OLCUC - Not specified by POSIX
|
|
* ONOCR - low-speed interactive optimisation
|
|
*/
|
|
|
|
ntotal = 0;
|
|
for (i = 0; i < len; i++)
|
|
{
|
|
ch = *buffer++;
|
|
|
|
/* Mapping CR to NL? */
|
|
|
|
if (ch == '\r' && (dev->pd_oflag & OCRNL) != 0)
|
|
{
|
|
ch = '\n';
|
|
}
|
|
|
|
/* Are we interested in newline processing? */
|
|
|
|
if ((ch == '\n') && (dev->pd_oflag & (ONLCR | ONLRET)) != 0)
|
|
{
|
|
char cr = '\r';
|
|
|
|
/* Transfer the carriage return. This will block if the
|
|
* sink pipe is full.
|
|
*
|
|
* REVISIT: Should not block if the oflags include O_NONBLOCK.
|
|
* How would we ripple the O_NONBLOCK characteristic to the
|
|
* contained sink pipe? file_fcntl()?
|
|
*/
|
|
|
|
nwritten = file_write(&dev->pd_sink, &cr, 1);
|
|
if (nwritten < 0)
|
|
{
|
|
ntotal = nwritten;
|
|
break;
|
|
}
|
|
|
|
/* Update the count of bytes transferred */
|
|
|
|
ntotal++;
|
|
}
|
|
|
|
/* Transfer the (possibly translated) character.. This will block
|
|
* if the sink pipe is full
|
|
*
|
|
* REVISIT: Should not block if the oflags include O_NONBLOCK.
|
|
* How would we ripple the O_NONBLOCK characteristic to the
|
|
* contained sink pipe? file_fcntl()?
|
|
*/
|
|
|
|
nwritten = file_write(&dev->pd_sink, &ch, 1);
|
|
if (nwritten < 0)
|
|
{
|
|
ntotal = nwritten;
|
|
break;
|
|
}
|
|
|
|
/* Update the count of bytes transferred */
|
|
|
|
ntotal++;
|
|
}
|
|
}
|
|
else
|
|
#endif
|
|
{
|
|
/* Write the 'len' bytes to the sink pipe. This will block until all
|
|
* 'len' bytes have been written to the pipe.
|
|
*
|
|
* REVISIT: Should not block if the oflags include O_NONBLOCK.
|
|
* How would we ripple the O_NONBLOCK characteristic to the
|
|
* contained sink pipe? file_fcntl()?
|
|
*/
|
|
|
|
ntotal = file_write(&dev->pd_sink, buffer, len);
|
|
}
|
|
|
|
return ntotal;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: pty_ioctl
|
|
*
|
|
* Description:
|
|
* The standard ioctl method. This is where ALL of the PWM work is done.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int pty_ioctl(FAR struct file *filep, int cmd, unsigned long arg)
|
|
{
|
|
FAR struct inode *inode;
|
|
FAR struct pty_dev_s *dev;
|
|
FAR struct pty_devpair_s *devpair;
|
|
int ret;
|
|
|
|
DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
|
|
inode = filep->f_inode;
|
|
dev = inode->i_private;
|
|
DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL);
|
|
devpair = dev->pd_devpair;
|
|
|
|
/* Get exclusive access */
|
|
|
|
pty_semtake(devpair);
|
|
|
|
/* Handle IOCTL commands */
|
|
|
|
switch (cmd)
|
|
{
|
|
/* PTY IOCTL commands would be handled here */
|
|
|
|
case TIOCGPTN: /* Get Pty Number (of pty-mux device): FAR int* */
|
|
{
|
|
#ifdef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
ret = -ENOSYS;
|
|
#else
|
|
FAR int *ptyno = (FAR int *)((uintptr_t)arg);
|
|
if (ptyno == NULL)
|
|
{
|
|
ret = -EINVAL;
|
|
}
|
|
else
|
|
{
|
|
*ptyno = (int)devpair->pp_minor;
|
|
ret = OK;
|
|
}
|
|
#endif
|
|
}
|
|
break;
|
|
|
|
case TIOCSPTLCK: /* Lock/unlock Pty: int */
|
|
{
|
|
if (arg == 0)
|
|
{
|
|
int sval;
|
|
|
|
/* Unlocking */
|
|
|
|
sched_lock();
|
|
devpair->pp_locked = false;
|
|
|
|
/* Release any waiting threads */
|
|
|
|
do
|
|
{
|
|
DEBUGVERIFY(sem_getvalue(&devpair->pp_slavesem, &sval));
|
|
if (sval < 0)
|
|
{
|
|
sem_post(&devpair->pp_slavesem);
|
|
}
|
|
}
|
|
while (sval < 0);
|
|
|
|
sched_unlock();
|
|
ret = OK;
|
|
}
|
|
else
|
|
{
|
|
/* Locking */
|
|
|
|
devpair->pp_locked = true;
|
|
ret = OK;
|
|
}
|
|
}
|
|
break;
|
|
|
|
case TIOCGPTLCK: /* Get Pty lock state: FAR int* */
|
|
{
|
|
FAR int *ptr = (FAR int *)((uintptr_t)arg);
|
|
if (ptr == NULL)
|
|
{
|
|
ret = -EINVAL;
|
|
}
|
|
else
|
|
{
|
|
*ptr = (int)devpair->pp_locked;
|
|
ret = OK;
|
|
}
|
|
}
|
|
break;
|
|
|
|
#ifdef CONFIG_SERIAL_TERMIOS
|
|
case TCGETS:
|
|
{
|
|
FAR struct termios *termiosp = (FAR struct termios *)arg;
|
|
|
|
if (!termiosp)
|
|
{
|
|
ret = -EINVAL;
|
|
break;
|
|
}
|
|
|
|
/* And update with flags from this layer */
|
|
|
|
termiosp->c_iflag = dev->pd_iflag;
|
|
termiosp->c_oflag = dev->pd_oflag;
|
|
termiosp->c_lflag = 0;
|
|
ret = OK;
|
|
}
|
|
break;
|
|
|
|
case TCSETS:
|
|
{
|
|
FAR struct termios *termiosp = (FAR struct termios *)arg;
|
|
|
|
if (!termiosp)
|
|
{
|
|
ret = -EINVAL;
|
|
break;
|
|
}
|
|
|
|
/* Update the flags we keep at this layer */
|
|
|
|
dev->pd_iflag = termiosp->c_iflag;
|
|
dev->pd_oflag = termiosp->c_oflag;
|
|
ret = OK;
|
|
}
|
|
break;
|
|
#endif
|
|
|
|
/* Get the number of bytes that are immediately available for reading
|
|
* from the source pipe.
|
|
*/
|
|
|
|
case FIONREAD:
|
|
{
|
|
ret = file_ioctl(&dev->pd_src, cmd, arg);
|
|
}
|
|
break;
|
|
|
|
/* Get the number of bytes waiting in the sink pipe (FIONWRITE) or the
|
|
* number of unused bytes in the sink pipe (FIONSPACE).
|
|
*/
|
|
|
|
case FIONWRITE:
|
|
case FIONSPACE:
|
|
{
|
|
ret = file_ioctl(&dev->pd_sink, cmd, arg);
|
|
}
|
|
break;
|
|
|
|
/* Any unrecognized IOCTL commands will be passed to the contained
|
|
* pipe driver.
|
|
*
|
|
* REVISIT: We know for a fact that the pipe driver only supports
|
|
* FIONREAD, FIONWRITE, FIONSPACE and PIPEIOC_POLICY. The first two
|
|
* are handled above and PIPEIOC_POLICY should not be managed by
|
|
* applications -- it can break the PTY!
|
|
*/
|
|
|
|
default:
|
|
{
|
|
#if 0
|
|
ret = file_ioctl(&dev->pd_src, cmd, arg);
|
|
if (ret >= 0 || ret == -ENOTTY)
|
|
{
|
|
ret = file_ioctl(&dev->pd_sink, cmd, arg);
|
|
}
|
|
#else
|
|
ret = ENOTTY;
|
|
#endif
|
|
}
|
|
break;
|
|
}
|
|
|
|
pty_semgive(devpair);
|
|
return ret;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: pty_poll
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_DISABLE_POLL
|
|
static int pty_poll(FAR struct file *filep, FAR struct pollfd *fds,
|
|
bool setup)
|
|
{
|
|
FAR struct inode *inode;
|
|
FAR struct pty_dev_s *dev;
|
|
int ret = -ENOSYS;
|
|
|
|
DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
|
|
inode = filep->f_inode;
|
|
dev = inode->i_private;
|
|
|
|
/* REVISIT: If both POLLIN and POLLOUT are set, might the following logic
|
|
* fail? Could we not get POLLIN on the sink file and POLLOUT on the source
|
|
* file?
|
|
*/
|
|
|
|
/* POLLIN: Data other than high-priority data may be read without blocking. */
|
|
|
|
if ((fds->events & POLLIN) != 0)
|
|
{
|
|
ret = file_poll(&dev->pd_src, fds, setup);
|
|
}
|
|
|
|
if (ret >= OK || ret == -ENOTTY)
|
|
{
|
|
/* POLLOUT: Normal data may be written without blocking. */
|
|
|
|
if ((fds->events & POLLOUT) != 0)
|
|
{
|
|
ret = file_poll(&dev->pd_sink, fds, setup);
|
|
}
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: pty_unlink
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
static int pty_unlink(FAR struct inode *inode)
|
|
{
|
|
FAR struct pty_dev_s *dev;
|
|
FAR struct pty_devpair_s *devpair;
|
|
|
|
DEBUGASSERT(inode != NULL && inode->i_private != NULL);
|
|
dev = inode->i_private;
|
|
devpair = dev->pd_devpair;
|
|
DEBUGASSERT(dev->pd_devpair != NULL);
|
|
|
|
/* Get exclusive access */
|
|
|
|
pty_semtake(devpair);
|
|
|
|
/* Indicate that the driver has been unlinked */
|
|
|
|
devpair->pp_unlinked = true;
|
|
|
|
/* If there are no further open references to the driver, then commit
|
|
* Hara-Kiri now.
|
|
*/
|
|
|
|
if (devpair->pp_nopen == 0)
|
|
{
|
|
pty_destroy(devpair);
|
|
return OK;
|
|
}
|
|
|
|
pty_semgive(devpair);
|
|
return OK;
|
|
}
|
|
#endif
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: pty_register
|
|
*
|
|
* Description:
|
|
* Create and register PTY master and slave devices. The slave side of
|
|
* the interface is always locked initially. The master must call
|
|
* unlockpt() before the slave device can be opened.
|
|
*
|
|
* Input Parameters:
|
|
* minor - The number that qualifies the naming of the created devices.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success; a negated errno value is returned on
|
|
* any failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int pty_register(int minor)
|
|
{
|
|
FAR struct pty_devpair_s *devpair;
|
|
int pipe_a[2];
|
|
int pipe_b[2];
|
|
char devname[16];
|
|
int ret;
|
|
|
|
/* Allocate a device instance */
|
|
|
|
devpair = kmm_zalloc(sizeof(struct pty_devpair_s));
|
|
if (devpair == NULL)
|
|
{
|
|
return -ENOMEM;
|
|
}
|
|
|
|
sem_init(&devpair->pp_slavesem, 0, 0);
|
|
sem_init(&devpair->pp_exclsem, 0, 1);
|
|
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
|
|
devpair->pp_minor = minor;
|
|
#endif
|
|
devpair->pp_locked = true;
|
|
devpair->pp_master.pd_devpair = devpair;
|
|
devpair->pp_master.pd_master = true;
|
|
devpair->pp_slave.pd_devpair = devpair;
|
|
|
|
/* Create two pipes:
|
|
*
|
|
* pipe_a: Master source, slave sink (TX, slave-to-master)
|
|
* pipe_b: Master sink, slave source (RX, master-to-slave)
|
|
*/
|
|
|
|
ret = pipe2(pipe_a, CONFIG_PSEUDOTERM_TXBUFSIZE);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_devpair;
|
|
}
|
|
|
|
ret = pipe2(pipe_b, CONFIG_PSEUDOTERM_RXBUFSIZE);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_pipea;
|
|
}
|
|
|
|
/* Detach the pipe file descriptors (closing them in the process)
|
|
*
|
|
* fd[0] is for reading;
|
|
* fd[1] is for writing.
|
|
*/
|
|
|
|
ret = file_detach(pipe_a[0], &devpair->pp_master.pd_src);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_pipeb;
|
|
}
|
|
|
|
pipe_a[0] = -1;
|
|
|
|
ret = file_detach(pipe_a[1], &devpair->pp_slave.pd_sink);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_pipeb;
|
|
}
|
|
|
|
pipe_a[1] = -1;
|
|
|
|
ret = file_detach(pipe_b[0], &devpair->pp_slave.pd_src);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_pipeb;
|
|
}
|
|
|
|
pipe_b[0] = -1;
|
|
|
|
ret = file_detach(pipe_b[1], &devpair->pp_master.pd_sink);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_pipeb;
|
|
}
|
|
|
|
pipe_b[1] = -1;
|
|
|
|
/* Register the slave device
|
|
*
|
|
* BSD style (deprecated): /dev/ttypN
|
|
* SUSv1 style: /dev/pts/N
|
|
*
|
|
* Where N is the minor number
|
|
*/
|
|
|
|
#ifdef CONFIG_PSEUDOTERM_BSD
|
|
snprintf(devname, 16, "/dev/ttyp%d", minor);
|
|
#else
|
|
snprintf(devname, 16, "/dev/pts/%d", minor);
|
|
#endif
|
|
|
|
ret = register_driver(devname, &g_pty_fops, 0666, &devpair->pp_slave);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_pipeb;
|
|
}
|
|
|
|
/* Register the master device
|
|
*
|
|
* BSD style (deprecated): /dev/ptyN
|
|
* SUSv1 style: Master: /dev/ptmx (multiplexor, see ptmx.c)
|
|
*
|
|
* Where N is the minor number
|
|
*/
|
|
|
|
snprintf(devname, 16, "/dev/pty%d", minor);
|
|
|
|
ret = register_driver(devname, &g_pty_fops, 0666, &devpair->pp_master);
|
|
if (ret < 0)
|
|
{
|
|
goto errout_with_slave;
|
|
}
|
|
|
|
return OK;
|
|
|
|
errout_with_slave:
|
|
#ifdef CONFIG_PSEUDOTERM_BSD
|
|
snprintf(devname, 16, "/dev/ttyp%d", minor);
|
|
#else
|
|
snprintf(devname, 16, "/dev/pts/%d", minor);
|
|
#endif
|
|
(void)unregister_driver(devname);
|
|
|
|
errout_with_pipeb:
|
|
if (pipe_b[0] >= 0)
|
|
{
|
|
close(pipe_b[0]);
|
|
}
|
|
else
|
|
{
|
|
(void)file_close_detached(&devpair->pp_master.pd_src);
|
|
}
|
|
|
|
if (pipe_b[1] >= 0)
|
|
{
|
|
close(pipe_b[1]);
|
|
}
|
|
else
|
|
{
|
|
(void)file_close_detached(&devpair->pp_slave.pd_sink);
|
|
}
|
|
|
|
errout_with_pipea:
|
|
if (pipe_a[0] >= 0)
|
|
{
|
|
close(pipe_a[0]);
|
|
}
|
|
else
|
|
{
|
|
(void)file_close_detached(&devpair->pp_slave.pd_src);
|
|
}
|
|
|
|
if (pipe_a[1] >= 0)
|
|
{
|
|
close(pipe_a[1]);
|
|
}
|
|
else
|
|
{
|
|
(void)file_close_detached(&devpair->pp_master.pd_sink);
|
|
}
|
|
|
|
errout_with_devpair:
|
|
sem_destroy(&devpair->pp_exclsem);
|
|
sem_destroy(&devpair->pp_slavesem);
|
|
kmm_free(devpair);
|
|
return ret;
|
|
}
|