PTYs prototypes hooked into build and configuration system (as EXPERIMENTAL)

This commit is contained in:
Gregory Nutt 2016-07-15 06:48:10 -06:00
parent c9d7ae6f47
commit 7fa5093fff
4 changed files with 131 additions and 59 deletions

View File

@ -2011,3 +2011,39 @@ config SCI1_2STOP
1=Two stop bits 1=Two stop bits
endmenu # SCI1 Configuration endmenu # SCI1 Configuration
config PSEUDOTERM
bool "Pseudo-Terminal (PTY) suppport"
default n
depends on EXPERIMENTAL
---help---
Enable support support for master and slave pseudo-terminal devices.
choice
prompt "PTY model"
default PSEUDOTERM_BSD if DISABLE_PSEUDOFS_OPERATIONS
default PSEUDOTERM_SUSV1 if !DISABLE_PSEUDOFS_OPERATIONS
depends on PSEUDOTERM
config PSEUDOTERM_BSD
bool "BSD style"
---help---
Deprecated BSD style PTYs.
Master: /dev/ptyN
Slave: /dev/ttypN
Where N is the minor number
config PSEUDOTERM_SUSV1
bool "SUSv1 style"
depends on !DISABLE_PSEUDOFS_OPERATIONS
---help---
PTYs as specified in the Single Unix Specification (SUSv1).
Master: /dev/ptmx
Slave: /dev/pts/N
Where N is the minor number
endchoice # PTY model

View File

@ -47,6 +47,15 @@ ifeq ($(CONFIG_16550_UART),y)
CSRCS += uart_16550.c CSRCS += uart_16550.c
endif endif
# Pseudo-terminal support
ifeq ($(CONFIG_PSEUDOTERM),y)
CSRCS += pty.c
ifeq ($(CONFIG_PSEUDOTERM_SUSV1),y)
CSRCS += ptmx.c
endif
endif
# Include serial build support # Include serial build support
DEPPATH += --dep-path serial DEPPATH += --dep-path serial

View File

@ -41,9 +41,14 @@
#include <sys/types.h> #include <sys/types.h>
#include <stdbool.h> #include <stdbool.h>
#include <unistd.h>
#include <fcntl.h>
#include <stdio.h>
#include <string.h> #include <string.h>
#include <poll.h> #include <poll.h>
#include <assert.h>
#include <errno.h> #include <errno.h>
#include <nuttx/fs/fs.h> #include <nuttx/fs/fs.h>
/**************************************************************************** /****************************************************************************
@ -146,7 +151,7 @@ static void ptmx_semtake(void)
* *
****************************************************************************/ ****************************************************************************/
static int ptmx_minor_allocate(FAR struct ptmx_dev_s *ptmx) static int ptmx_minor_allocate(void)
{ {
uint8_t startaddr = g_ptmx.px_next; uint8_t startaddr = g_ptmx.px_next;
uint8_t minor; uint8_t minor;
@ -318,8 +323,6 @@ static ssize_t ptmx_write(FAR struct file *filep, FAR const char *buffer, size_t
void ptmx_register(void) void ptmx_register(void)
{ {
FAR struct ptmx_dev_s *ptmx;
/* Initialize driver state */ /* Initialize driver state */
sem_init(&g_ptmx.px_exclsem, 0, 1); sem_init(&g_ptmx.px_exclsem, 0, 1);

View File

@ -43,11 +43,13 @@
#include <stdbool.h> #include <stdbool.h>
#include <unistd.h> #include <unistd.h>
#include <semaphore.h> #include <semaphore.h>
#include <stdio.h>
#include <string.h> #include <string.h>
#include <poll.h> #include <poll.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <nuttx/kmalloc.h>
#include <nuttx/fs/fs.h> #include <nuttx/fs/fs.h>
/**************************************************************************** /****************************************************************************
@ -78,7 +80,7 @@ static int pty_unlink(FAR struct inode *inode);
struct pty_devpair_s; struct pty_devpair_s;
struct pty_dev_s struct pty_dev_s
{ {
FAR struct pty_common_s *pd_devpair; FAR struct pty_devpair_s *pd_devpair;
struct file pd_src; /* Provides data to read() method (pipe output) */ struct file pd_src; /* Provides data to read() method (pipe output) */
struct file pd_sink; /* Accepts data from write() method (pipe input) */ struct file pd_sink; /* Accepts data from write() method (pipe input) */
}; };
@ -87,8 +89,8 @@ struct pty_dev_s
struct pty_devpair_s struct pty_devpair_s
{ {
struct pty_dev_s pp_ptyp; /* /dev/ptypN device */ struct pty_dev_s pp_master; /* Maseter device */
struct pty_dev_s pp_ttyp; /* /dev/ttypN device */ struct pty_dev_s pp_slave; /* Slave device */
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS #ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
uint8_t pp_minor; /* Minor device number */ uint8_t pp_minor; /* Minor device number */
@ -132,7 +134,7 @@ static const struct file_operations pty_fops =
****************************************************************************/ ****************************************************************************/
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS #ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
static void pty_semtake(FAR struct pty_common_s *devpair) static void pty_semtake(FAR struct pty_devpair_s *devpair)
{ {
while (sem_wait(&devpair->pp_exclsem) < 0) while (sem_wait(&devpair->pp_exclsem) < 0)
{ {
@ -152,31 +154,35 @@ static void pty_semtake(FAR struct pty_common_s *devpair)
****************************************************************************/ ****************************************************************************/
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS #ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
static void pty_destroy(FAR struct pty_common_s *devpair) static void pty_destroy(FAR struct pty_devpair_s *devpair)
{ {
char devname[16]; char devname[16];
/* Un-register /dev/ptypN */ /* Un-register the slave device */
snprintf(devname, 16, "/dev/pp_ptyp%d", (int)devpair->pp_minor); #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); (void)unregister_driver(devname);
/* Un-register /dev/ptypN */
snprintf(devname, 16, "/dev/ttyp%d", (int)devpair->pp_minor); /* 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); (void)unregister_driver(devname);
/* Close the contained file structures */ /* Close the contained file structures */
(void)file_close_detached(&devpair->pp_ptyp.pd_src); (void)file_close_detached(&devpair->pp_master.pd_src);
(void)file_close_detached(&devpair->pp_ptyp.pd_sink); (void)file_close_detached(&devpair->pp_master.pd_sink);
(void)file_close_detached(&devpair->pp_ttyp.pd_src); (void)file_close_detached(&devpair->pp_slave.pd_src);
(void)file_close_detached(&devpair->pp_ttyp.pd_sink); (void)file_close_detached(&devpair->pp_slave.pd_sink);
/* And free the device structure */ /* And free the device structure */
sem_destroy(&devpair->pp_exclsem); sem_destroy(&devpair->pp_exclsem);
kmm_free(upper); kmm_free(devpair);
} }
#endif #endif
@ -189,10 +195,10 @@ static int pty_open(FAR struct file *filep)
{ {
FAR struct inode *inode; FAR struct inode *inode;
FAR struct pty_dev_s *dev; FAR struct pty_dev_s *dev;
FAR struct pty_common_s *devpair; FAR struct pty_devpair_s *devpair;
int ret; int ret;
DEBUGASSERT(filep != NULL && file->f_inode != NULL); DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
inode = filep->f_inode; inode = filep->f_inode;
dev = inode->i_private; dev = inode->i_private;
DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL); DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL);
@ -206,9 +212,9 @@ static int pty_open(FAR struct file *filep)
* opens. * opens.
*/ */
if (cmd->pp_unlinked) if (devpair->pp_unlinked)
{ {
ret = -EIDRAM ret = -EIDRM;
} }
else else
{ {
@ -234,9 +240,9 @@ static int pty_close(FAR struct file *filep)
{ {
FAR struct inode *inode; FAR struct inode *inode;
FAR struct pty_dev_s *dev; FAR struct pty_dev_s *dev;
FAR struct pty_common_s *devpair; FAR struct pty_devpair_s *devpair;
DEBUGASSERT(filep != NULL && file->f_inode != NULL); DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
inode = filep->f_inode; inode = filep->f_inode;
dev = inode->i_private; dev = inode->i_private;
DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL); DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL);
@ -277,12 +283,12 @@ static ssize_t pty_read(FAR struct file *filep, FAR char *buffer, size_t len)
FAR struct inode *inode; FAR struct inode *inode;
FAR struct pty_dev_s *dev; FAR struct pty_dev_s *dev;
DEBUGASSERT(filep != NULL && file->f_inode != NULL); DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
inode = filep->f_inode; inode = filep->f_inode;
dev = inode->i_private; dev = inode->i_private;
DEBUGASSERT(dev != NULL); DEBUGASSERT(dev != NULL);
return file_read(&dev->src, buffer, len); return file_read(&dev->pd_src, buffer, len);
} }
/**************************************************************************** /****************************************************************************
@ -294,12 +300,12 @@ static ssize_t pty_write(FAR struct file *filep, FAR const char *buffer, size_t
FAR struct inode *inode; FAR struct inode *inode;
FAR struct pty_dev_s *dev; FAR struct pty_dev_s *dev;
DEBUGASSERT(filep != NULL && file->f_inode != NULL); DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
inode = filep->f_inode; inode = filep->f_inode;
dev = inode->i_private; dev = inode->i_private;
DEBUGASSERT(dev != NULL); DEBUGASSERT(dev != NULL);
return file_write(&dev->src, buffer, len); return file_write(&dev->pd_sink, buffer, len);
} }
/**************************************************************************** /****************************************************************************
@ -316,7 +322,7 @@ static int pty_ioctl(FAR struct file *filep, int cmd, unsigned long arg)
FAR struct pty_dev_s *dev; FAR struct pty_dev_s *dev;
int ret; int ret;
DEBUGASSERT(filep != NULL && file->f_inode != NULL); DEBUGASSERT(filep != NULL && filep->f_inode != NULL);
inode = filep->f_inode; inode = filep->f_inode;
dev = inode->i_private; dev = inode->i_private;
DEBUGASSERT(dev != NULL); DEBUGASSERT(dev != NULL);
@ -334,16 +340,15 @@ static int pty_ioctl(FAR struct file *filep, int cmd, unsigned long arg)
default: default:
{ {
ret = file_ioctl(dev->pd_src, cmd, arg); ret = file_ioctl(&dev->pd_src, cmd, arg);
if (ret >= 0 || ret == -ENOTTY) if (ret >= 0 || ret == -ENOTTY)
{ {
ret = file_ioctl(dev->pd_sink, cmd, arg); ret = file_ioctl(&dev->pd_sink, cmd, arg);
} }
} }
break; break;
} }
sem_post(&upper->exclsem);
return ret; return ret;
} }
@ -366,15 +371,13 @@ static int pty_poll(FAR struct file *filep, FAR struct pollfd *fds,
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS #ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
static int pty_unlink(FAR struct inode *inode) static int pty_unlink(FAR struct inode *inode)
{ {
FAR struct inode *inode;
FAR struct pty_dev_s *dev; FAR struct pty_dev_s *dev;
FAR struct pty_common_s *devpair; FAR struct pty_devpair_s *devpair;
DEBUGASSERT(filep != NULL && file->f_inode != NULL); DEBUGASSERT(inode != NULL && inode->i_private != NULL);
inode = filep->f_inode;
dev = inode->i_private; dev = inode->i_private;
DEBUGASSERT(dev != NULL && dev->pd_devpair != NULL);
devpair = dev->pd_devpair; devpair = dev->pd_devpair;
DEBUGASSERT(dev->pd_devpair != NULL);
/* Get exclusive access */ /* Get exclusive access */
@ -406,9 +409,9 @@ static int pty_unlink(FAR struct inode *inode)
* Name: pty_register * Name: pty_register
* *
* Input Parameters: * Input Parameters:
* *
* Description: * Description:
* Register /dev/ttypN and /dev/ptpN where N=minor number * Create and register PTY master and slave devices
* *
****************************************************************************/ ****************************************************************************/
@ -418,6 +421,7 @@ int pty_register(int minor)
int pipe_a[2]; int pipe_a[2];
int pipe_b[2]; int pipe_b[2];
char devname[16]; char devname[16];
int ret;
/* Allocate a device instance */ /* Allocate a device instance */
@ -431,8 +435,8 @@ int pty_register(int minor)
sem_init(&devpair->pp_exclsem, 0, 1); sem_init(&devpair->pp_exclsem, 0, 1);
devpair->pp_minor = minor; devpair->pp_minor = minor;
#endif #endif
devpair->pp_ptyp.pd_devpair = devpair; devpair->pp_master.pd_devpair = devpair;
devpair->pp_ttyp.pd_devpair = devpair; devpair->pp_slave.pd_devpair = devpair;
/* Create two pipes */ /* Create two pipes */
@ -454,7 +458,7 @@ int pty_register(int minor)
* fd[1] is for writing. * fd[1] is for writing.
*/ */
ret = file_detach(pipe_a[0], &devpair->pp_ptyp.pd_src); ret = file_detach(pipe_a[0], &devpair->pp_master.pd_src);
if (ret < 0) if (ret < 0)
{ {
goto errout_with_pipeb; goto errout_with_pipeb;
@ -462,7 +466,7 @@ int pty_register(int minor)
pipe_a[0] = -1; pipe_a[0] = -1;
ret = file_detach(pipe_a[1], &devpair->pp_ttyp.pd_sink); ret = file_detach(pipe_a[1], &devpair->pp_slave.pd_sink);
if (ret < 0) if (ret < 0)
{ {
goto errout_with_pipeb; goto errout_with_pipeb;
@ -470,7 +474,7 @@ int pty_register(int minor)
pipe_a[1] = -1; pipe_a[1] = -1;
ret = file_detach(pipe_b[0], &devpair->pp_ttyp.pd_src); ret = file_detach(pipe_b[0], &devpair->pp_slave.pd_src);
if (ret < 0) if (ret < 0)
{ {
goto errout_with_pipeb; goto errout_with_pipeb;
@ -478,7 +482,7 @@ int pty_register(int minor)
pipe_b[0] = -1; pipe_b[0] = -1;
ret = file_detach(pipe_b[1], &devpair->pp_ptyp.pd_sink); ret = file_detach(pipe_b[1], &devpair->pp_master.pd_sink);
if (ret < 0) if (ret < 0)
{ {
goto errout_with_pipeb; goto errout_with_pipeb;
@ -486,31 +490,51 @@ int pty_register(int minor)
pipe_b[1] = -1; pipe_b[1] = -1;
/* Register /dev/ptypN */ /* 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); snprintf(devname, 16, "/dev/pts/%d", minor);
#endif
ret = register_driver(devname, &pty_fops, 0666, &devpair->pp_ptyp); ret = register_driver(devname, &pty_fops, 0666, &devpair->pp_slave);
if (ret < 0) if (ret < 0)
{ {
goto errout_with_pipeb; goto errout_with_pipeb;
} }
/* Register /dev/ptypN */
snprintf(devname, 16, "/dev/ttyp%d", minor); /* Register the master device
*
* BSD style (deprecated): /dev/ptyN
* SUSv1 style: Master: /dev/ptmx (see ptmx.c)
*
* Where N is the minor number
*/
ret = register_driver(devname, &pty_fops, 0666, &devpair->pp_ttyp); snprintf(devname, 16, "/dev/pty%d", minor);
ret = register_driver(devname, &pty_fops, 0666, &devpair->pp_master);
if (ret < 0) if (ret < 0)
{ {
goto errout_with_ptyp; goto errout_with_slave;
} }
return OK; return OK;
errout_with_ptyp: errout_with_slave:
snprintf(devname, 16, "/dev/ptyp%d", minor); #ifdef CONFIG_PSEUDOTERM_BSD
(void)unregister_driver(devname) snprintf(devname, 16, "/dev/ttyp%d", minor);
#else
snprintf(devname, 16, "/dev/pts/%d", minor);
#endif
(void)unregister_driver(devname);
errout_with_pipeb: errout_with_pipeb:
if (pipe_b[0] >= 0) if (pipe_b[0] >= 0)
@ -519,7 +543,7 @@ errout_with_pipeb:
} }
else else
{ {
(void)file_close_detached(&devpair->pp_ptyp.pd_src); (void)file_close_detached(&devpair->pp_master.pd_src);
} }
if (pipe_b[1] >= 0) if (pipe_b[1] >= 0)
@ -528,7 +552,7 @@ errout_with_pipeb:
} }
else else
{ {
(void)file_close_detached(&devpair->pp_ttyp.pd_sink); (void)file_close_detached(&devpair->pp_slave.pd_sink);
} }
errout_with_pipea: errout_with_pipea:
@ -538,7 +562,7 @@ errout_with_pipea:
} }
else else
{ {
(void)file_close_detached(&devpair->pp_ttyp.pd_src); (void)file_close_detached(&devpair->pp_slave.pd_src);
} }
if (pipe_a[1] >= 0) if (pipe_a[1] >= 0)
@ -547,7 +571,7 @@ errout_with_pipea:
} }
else else
{ {
(void)file_close_detached(&devpair->pp_ptyp.pd_sink); (void)file_close_detached(&devpair->pp_master.pd_sink);
} }
errout_with_devpair: errout_with_devpair: