LinuxPPS new functionalities
This patchset adds several PPS functionalities.
All patches have a specific comment but I prefer say something more:
* Patches 01-02 are just documentation about PPS support.
* Patch 03 adds PPS client support skeleton.
* Patches 04-06 add generic PPS serial support (with specific modifications requested by Alan Cox).
* Patches 07-08 add PPS serial support for specific hardware.
Ciao,
Rodolfo
PATCH 1/8 pps: userland header file for PPS API.
This patch adds into the PPS's documentation directory a possible implementation of the PPS API (RFC 2783) by using the LinuxPPS's char devices.
This file is not just an example but it can be used into real systems. :)
--- Documentation/pps/timepps.h | 198 +++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 198 insertions(+), 0 deletions(-) create mode 100644 Documentation/pps/timepps.h
Documentation/pps/timepps.h new file +198 -0
@@ -0,0 +1,198 @@ +/* +* timepps.h -- PPS API main header +* +* Copyright (C) 2005-2007 Rodolfo Giometti <[email protected]> +* +* 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., 675 Mass Ave, Cambridge, MA 02139, USA. +*/ + +#ifndef _SYS_TIMEPPS_H_ +#define _SYS_TIMEPPS_H_ + +#include <errno.h> +#include <sys/time.h> +#include <sys/ioctl.h> +#include <linux/types.h> +#include <linux/pps.h> + +#define LINUXPPS 1/* signal we are using LinuxPPS */ + +/* +* New data structures +*/ + +struct ntp_fp { +unsigned int integral; +unsigned int fractional; +}; + +union pps_timeu { +struct timespec tspec; +struct ntp_fp ntpfp; +unsigned long longpad[3 ]; +}; + +struct pps_info { +unsigned long assert_sequence;/* seq. num. of assert event */ +unsigned long clear_sequence;/* seq. num. of clear event */ +union pps_timeu assert_tu;/* time of assert event */ +union pps_timeu clear_tu;/* time of clear event */ +int current_mode;/* current mode bits */ +}; + +struct pps_params { +int api_version;/* API version # */ +int mode;/* mode bits */ +union pps_timeu assert_off_tu;/* offset compensation for assert */ +union pps_timeu clear_off_tu;/* offset compensation for clear */ +}; + +typedef int pps_handle_t ;/* represents a PPS source */ +typedef unsigned long pps_seq_t ;/* sequence number */ +typedef struct ntp_fp ntp_fp_t ;/* NTP-compatible time stamp */ +typedef union pps_timeu pps_timeu_t ;/* generic data type for time stamps */ +typedef struct pps_info pps_info_t ; +typedef struct pps_params pps_params_t ; + +#define assert_timestamp assert_tu.tspec +#define clear_timestamp clear_tu.tspec + +#define assert_timestamp_ntpfp assert_tu.ntpfp +#define clear_timestamp_ntpfp clear_tu.ntpfp + +#define assert_offset assert_off_tu.tspec +#define clear_offset clear_off_tu.tspec + +#define assert_offset_ntpfp assert_off_tu.ntpfp +#define clear_offset_ntpfp clear_off_tu.ntpfp + +/* +* The PPS API +*/ + +static __inlineint time_pps_create (int source,pps_handle_t *handle) +{ +int ret; +struct pps_kparams dummy; + +if (!handle) { + errno =EINVAL ; +return -1 ; + } + +/* First we check if current device is a valid PPS one by +* doing a dummy PPS_GETPARAMS... +*/ + ret =ioctl (source,PPS_GETPARAMS , &dummy); +if (ret) { + errno =EOPNOTSUPP ; +return -1 ; + } + +/* ... then since in LinuxPPS there are no differences between a +* "PPS source" and a "PPS handle", we simply return the same value. +*/ + *handle = source; + +return 0 ; +} + +static __inlineint time_pps_destroy (pps_handle_t handle) +{ +return close (handle); +} + +static __inlineint time_pps_getparams (pps_handle_t handle, +pps_params_t *ppsparams) +{ +int ret; +struct pps_kparams __ppsparams; + + ret =ioctl (handle,PPS_GETPARAMS , &__ppsparams); + + ppsparams->api_version = __ppsparams.api_version; + ppsparams->mode = __ppsparams.mode; + ppsparams->assert_off_tu.tspec.tv_sec = __ppsparams.assert_off_tu.sec; + ppsparams->assert_off_tu.tspec.tv_nsec = __ppsparams.assert_off_tu.nsec; + ppsparams->clear_off_tu.tspec.tv_sec = __ppsparams.clear_off_tu.sec; + ppsparams->clear_off_tu.tspec.tv_nsec = __ppsparams.clear_off_tu.nsec; + +return ret; +} + +static __inlineint time_pps_setparams (pps_handle_t handle, +const pps_params_t *ppsparams) +{ +struct pps_kparams __ppsparams; + + __ppsparams.api_version = ppsparams->api_version; + __ppsparams.mode = ppsparams->mode; + __ppsparams.assert_off_tu.sec = ppsparams->assert_off_tu.tspec.tv_sec; + __ppsparams.assert_off_tu.nsec = ppsparams->assert_off_tu.tspec.tv_nsec; + __ppsparams.clear_off_tu.sec = ppsparams->clear_off_tu.tspec.tv_sec; + __ppsparams.clear_off_tu.nsec = ppsparams->clear_off_tu.tspec.tv_nsec; + +return ioctl (handle,PPS_SETPARAMS , &__ppsparams); +} + +/* Get capabilities for handle */ +static __inlineint time_pps_getcap (pps_handle_t handle,int *mode) +{ +return ioctl (handle,PPS_GETCAP , mode); +} + +static __inlineint time_pps_fetch (pps_handle_t handle,const int tsformat, +pps_info_t *ppsinfobuf, +const struct timespec *timeout) +{ +struct pps_fdata __fdata; +int ret; + +/* Sanity checks */ +if (tsformat !=PPS_TSFMT_TSPEC ) { + errno =EINVAL ; +return -1 ; + } + +if (timeout) { + __fdata.timeout.sec = timeout->tv_sec; + __fdata.timeout.nsec = timeout->tv_nsec; + __fdata.timeout.flags = ~PPS_TIME_INVALID ; + }else + __fdata.timeout.flags =PPS_TIME_INVALID ; + + ret =ioctl (handle,PPS_FETCH , &__fdata); + + ppsinfobuf->assert_sequence = __fdata.info.assert_sequence; + ppsinfobuf->clear_sequence = __fdata.info.clear_sequence; + ppsinfobuf->assert_tu.tspec.tv_sec = __fdata.info.assert_tu.sec; + ppsinfobuf->assert_tu.tspec.tv_nsec = __fdata.info.assert_tu.nsec; + ppsinfobuf->clear_tu.tspec.tv_sec = __fdata.info.clear_tu.sec; + ppsinfobuf->clear_tu.tspec.tv_nsec = __fdata.info.clear_tu.nsec; + ppsinfobuf->current_mode = __fdata.info.current_mode; + +return ret; +} + +static __inlineint time_pps_kcbind (pps_handle_t handle, +const int kernel_consumer, +const int edge,const int tsformat) +{ +/* LinuxPPS doesn't implement kernel consumer feature */ + errno =EOPNOTSUPP ; +return -1 ; +} + +#endif /* _SYS_TIMEPPS_H_ */
Signature · 1 line
1.6.3.3
PATCH 2/8 pps: documentation programs and examples.
Here some utilities and examples about the PPS API and the LinuxPPS support.
* ppstest.c implements an useful testing program, while
* ppsfind tries to help the user into finding a specific PPS source by using its name or path.
--- Documentation/pps/Makefile | 27 ++++++++ Documentation/pps/ppsfind | 17 +++++ Documentation/pps/ppstest.c | 150 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 194 insertions(+), 0 deletions(-) create mode 100644 Documentation/pps/Makefile create mode 100644 Documentation/pps/ppsfind create mode 100644 Documentation/pps/ppstest.c
Documentation/pps/Makefile new file +27 -0
@@ -0,0 +1,27 @@ +TARGETS = ppstest + +CFLAGS += -Wall -O2 -D_GNU_SOURCE +CFLAGS += -I . -I ../../include/ +CFLAGS += -ggdb + +# -- Actions section -- + +.PHONY : all depend dep + +all : .depend $(TARGETS) + +.depend depend dep : + $(CC) $(CFLAGS) -M $(TARGETS:=.c) > .depend + +ifeq (.depend,$(wildcard .depend)) +include .depend +endif + + +# -- Clean section -- + +.PHONY : clean + +clean : + rm -f *.o *~ core .depend + rm -f ${TARGETS}
Documentation/pps/ppsfind new file +17 -0
@@ -0,0 +1,17 @@ +#!/bin/sh + +SYS="/sys/class/pps/" + +if [ $# -lt 1 ] ; then + echo "usage: ppsfind <name>" >&2 + exit 1 +fi + +for d in $(ls $SYS) ; do + if grep $1 $SYS/$d/name >& /dev/null || \ + grep $1 $SYS/$d/path >& /dev/null ; then + echo "$d: name=$(cat $SYS/$d/name) path=$(cat $SYS/$d/path)" + fi +done + +exit 0
Documentation/pps/ppstest.c new file +150 -0
150 lines not on this page · raw message
Signature · 1 line
1.6.3.3
PATCH 3/8 pps: LinuxPPS clients support.
Each PPS source can be registered/deregistered into the system by using special modules called "clients". They simply define the PPS sources' attributes and implement the time signal registartion mechanism.
This patch adds a special directory for such clients and adds a dummy client that can be useful to test system integrity on real systems.
--- drivers/pps/Kconfig | 2 + drivers/pps/Makefile | 1 + drivers/pps/clients/Kconfig | 18 ++++++ drivers/pps/clients/Makefile | 9 +++ drivers/pps/clients/ktimer.c | 123 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 153 insertions(+), 0 deletions(-) create mode 100644 drivers/pps/clients/Kconfig create mode 100644 drivers/pps/clients/Makefile create mode 100644 drivers/pps/clients/ktimer.c
drivers/pps/Kconfig +2 -0
@@ -30,4 +30,6 @@ config PPS_DEBUG messages to the system log. Select this if you are having a problem with PPS support and want to see more of what is going on. +source drivers/pps/clients/Kconfig + endmenu
drivers/pps/Makefile +1 -0
@@ -4,5 +4,6 @@ pps_core-y := pps.o kapi.o sysfs.o obj-$(CONFIG_PPS) := pps_core.o +obj-y += clients/ ccflags-$(CONFIG_PPS_DEBUG) := -DDEBUG
drivers/pps/clients/Kconfig new file +18 -0
@@ -0,0 +1,18 @@ +# +# PPS clients configuration +# + +if PPS + +comment "PPS clients support" + +config PPS_CLIENT_KTIMER + tristate "Kernel timer client (Testing client, use for debug)" + help + If you say yes here you get support for a PPS debugging client + which uses a kernel timer to generate the PPS signal. + + This driver can also be built as a module. If so, the module + will be called ktimer.ko. + +endif
drivers/pps/clients/Makefile new file +9 -0
@@ -0,0 +1,9 @@ +# +# Makefile for PPS clients. +# + +obj-$(CONFIG_PPS_CLIENT_KTIMER) += ktimer.o + +ifeq ($(CONFIG_PPS_DEBUG),y) +EXTRA_CFLAGS += -DDEBUG +endif
drivers/pps/clients/ktimer.c new file +123 -0
123 lines not on this page · raw message
Signature · 1 line
1.6.3.3
PATCH 4/8 ldisc: new dcd_change() method for line disciplines.
--- Documentation/serial/tty.txt | 4 ++++ include/linux/tty_ldisc.h | 8 ++++++++ 2 files changed, 12 insertions(+), 0 deletions(-)
Documentation/serial/tty.txt +4 -0
@@ -100,6 +100,10 @@ write_wakeup() - May be called at any point between open and close. is permitted to call the driver write method from this function. In such a situation defer it. +dcd_change() - Report to the tty line the current DCD pin status + changes and the relative timestamp. The timestamp + can be NULL. + Driver Access
include/linux/tty_ldisc.h +8 -0
@@ -99,6 +99,12 @@* cease I/O to the tty driver. Can sleep. The driver should * seek to perform this action quickly but should wait until * any pending driver I/O is completed. +* +* void (*dcd_change)(struct tty_struct *tty, unsigned int status, +* struct timespec *ts) +* +* Tells the discipline that the DCD pin has changed its status and +* the relative timestamp. Pointer ts can be NULL. */ #include <linux/fs.h>
@@ -136,6 +142,8 @@ struct tty_ldisc_ops {void (*receive_buf)(struct tty_struct *,const unsigned char *cp,char *fp,int count);void (*write_wakeup)(struct tty_struct *); +void (*dcd_change)(struct tty_struct *,unsigned int , +struct timespec *);struct module *owner;
Signature · 1 line
1.6.3.3
PATCH 5/8 ldisc n_tty: add new method n_tty_inherit_ops()
This new method can be used to init a new struct tty_ldisc_ops as the default tty_ldisc_N_TTY struct.
--- drivers/char/n_tty.c | 9 +++++++++ include/linux/tty.h | 1 + 2 files changed, 10 insertions(+), 0 deletions(-)
drivers/char/n_tty.c +9 -0
@@ -48,6 +48,7 @@#include <linux/audit.h> #include <linux/file.h> #include <linux/uaccess.h> +#include <linux/module.h> #include <asm/system.h>
@@ -2091,3 +2092,11 @@ struct tty_ldisc_ops tty_ldisc_N_TTY = { .receive_buf = n_tty_receive_buf, .write_wakeup = n_tty_write_wakeup }; + +void n_tty_inherit_ops (struct tty_ldisc_ops *ops) +{ + *ops = tty_ldisc_N_TTY; + ops->owner =NULL ; + ops->refcount = ops->flags =0 ; +} +EXPORT_SYMBOL_GPL (n_tty_inherit_ops);
include/linux/tty.h +1 -0
@@ -485,6 +485,7 @@ extern void tty_ldisc_enable(struct tty_struct *tty);/* n_tty.c */ extern struct tty_ldisc_ops tty_ldisc_N_TTY; +extern void n_tty_inherit_ops (struct tty_ldisc_ops *ops);/* tty_audit.c */ #ifdef CONFIG_AUDIT
Signature · 1 line
1.6.3.3
PATCH 6/8 pps: serial clients support.
Adds support, by using the PPS line discipline, for the PPS sources connected with the CD (Carrier Detect) pin of a serial port.
--- drivers/pps/clients/Kconfig | 7 ++ drivers/pps/clients/Makefile | 1 + drivers/pps/clients/pps-ldisc.c | 154 +++++++++++++++++++++++++++++++++++++++ include/linux/serial_core.h | 11 +++- 4 files changed, 172 insertions(+), 1 deletions(-) create mode 100644 drivers/pps/clients/pps-ldisc.c
drivers/pps/clients/Kconfig +7 -0
@@ -15,4 +15,11 @@ config PPS_CLIENT_KTIMER This driver can also be built as a module. If so, the module will be called ktimer.ko. +config PPS_CLIENT_LDISC + tristate "PPS line discipline" + depends on PPS + help + If you say yes here you get support for a PPS source connected + with the CD (Carrier Detect) pin of your serial port. + endif
drivers/pps/clients/Makefile +1 -0
@@ -3,6 +3,7 @@ # obj-$(CONFIG_PPS_CLIENT_KTIMER) += ktimer.o +obj-$(CONFIG_PPS_CLIENT_LDISC) += pps-ldisc.o ifeq ($(CONFIG_PPS_DEBUG),y) EXTRA_CFLAGS += -DDEBUG
drivers/pps/clients/pps-ldisc.c new file +154 -0
154 lines not on this page · raw message
include/linux/serial_core.h +10 -1
@@ -488,9 +488,13 @@ uart_handle_dcd_change(struct uart_port *uport, unsigned int status) {struct uart_state *state = uport->state;struct tty_port *port = &state->port; +struct tty_ldisc *ld =tty_ldisc_ref (port->tty); +struct timespec ts; - uport->icount.dcd++; +if (ld && ld->ops->dcd_change) +getnstimeofday (&ts); + uport->icount.dcd++;#ifdef CONFIG_HARD_PPS if ((uport->flags &UPF_HARDPPS_CD ) && status)hardpps ();
@@ -502,6 +506,11 @@ uart_handle_dcd_change(struct uart_port *uport, unsigned int status)else if (port->tty)tty_hangup (port->tty); } + +if (ld && ld->ops->dcd_change) + ld->ops->dcd_change (port->tty, status, &ts); +if (ld) +tty_ldisc_deref (ld); }/**
Signature · 1 line
1.6.3.3
PATCH 7/8 serial 8250: enable PPS support.
Automagically function serial8250_enable_ms() is called when PPS ldisc is selected.
--- drivers/serial/8250.c | 16 ++++++++++++++++ 1 files changed, 16 insertions(+), 0 deletions(-)
drivers/serial/8250.c +16 -0
@@ -2415,6 +2415,21 @@ serial8250_set_termios(struct uart_port *port, struct ktermios *termios, }static void +serial8250_set_ldisc (struct uart_port *port) +{ +int line = port->line; + +if (line >= port->state->port.tty->driver->num) +return ; + +if (port->state->port.tty->ldisc->ops->num ==N_PPS ) { + port->flags |=UPF_HARDPPS_CD ; +serial8250_enable_ms (port); + }else + port->flags &= ~UPF_HARDPPS_CD ; +} + +static void serial8250_pm (struct uart_port *port,unsigned int state,unsigned int oldstate) {
@@ -2628,6 +2643,7 @@ static struct uart_ops serial8250_pops = { .startup = serial8250_startup, .shutdown = serial8250_shutdown, .set_termios = serial8250_set_termios, + .set_ldisc = serial8250_set_ldisc, .pm = serial8250_pm, .type = serial8250_type, .release_port = serial8250_release_port,
Signature · 1 line
1.6.3.3
PATCH 8/8 serial amba-pl010: enable PPS support.
Function pl010_enable_ms() is automagically called when PPS ldisc is selected.
--- drivers/serial/amba-pl010.c | 15 +++++++++++++++ 1 files changed, 15 insertions(+), 0 deletions(-)
drivers/serial/amba-pl010.c +15 -0
@@ -471,6 +471,20 @@ pl010_set_termios(struct uart_port *port, struct ktermios *termios,spin_unlock_irqrestore (&uap->port.lock, flags); } +static void pl010_set_ldisc (struct uart_port *port) +{ +int line = port->line; + +if (line >= port->state->port.tty->driver->num) +return ; + +if (port->state->port.tty->ldisc->ops->num ==N_PPS ) { + port->flags |=UPF_HARDPPS_CD ; +pl010_enable_ms (port); + }else + port->flags &= ~UPF_HARDPPS_CD ; +} +static const char *pl010_type (struct uart_port *port) {return port->type ==PORT_AMBA ?"AMBA" :NULL ;
@@ -531,6 +545,7 @@ static struct uart_ops amba_pl010_pops = { .startup = pl010_startup, .shutdown = pl010_shutdown, .set_termios = pl010_set_termios, + .set_ldisc = pl010_set_ldisc, .type = pl010_type, .release_port = pl010_release_port, .request_port = pl010_request_port,
Signature · 1 line
1.6.3.3
Re: [PATCH 6/8] pps: serial clients support.
In reply to Rodolfo GiomettiQuoted 29 lines · On Tue, 16 Feb 2010 10:51:23 +0100 Rodolfo Giometti <[email protected]> wrote:
Adds support, by using the PPS line discipline, for the PPS sources connected with the CD (Carrier Detect) pin of a serial port.
...
drivers/pps/clients/pps-ldisc.c new file +24
-0+static int (*n_tty_open)(struct tty_struct *tty); + +static int pps_tty_open (struct tty_struct *tty) +{ +struct pps_source_info info; +struct tty_driver *drv = tty->driver; +int index = tty->index + drv->name_base; +int ret; + + info.owner =THIS_MODULE ; + info.dev =NULL ; +snprintf (info.name,PPS_MAX_NAME_LEN ,"%s%d" , drv->driver_name, index); +snprintf (info.path,PPS_MAX_NAME_LEN ,"/dev/%s%d" , drv->name, index); + info.mode =PPS_CAPTUREBOTH | \ +PPS_OFFSETASSERT |PPS_OFFSETCLEAR | \ +PPS_CANWAIT |PPS_TSFMT_TSPEC ; + + ret =pps_register_source (&info,PPS_CAPTUREBOTH | \ +PPS_OFFSETASSERT |PPS_OFFSETCLEAR ); +if (ret <0 ) { +pr_err ("cannot register PPS source \"%s\"\n" , info.path); +return ret; + } + tty->disc_data = (void *) ret;
drivers/pps/clients/pps-ldisc.c line 89
Quoted 10 lines
drivers/pps/clients/pps-ldisc.c new file +10
-0+ +/* Should open N_TTY ldisc too */ + ret =n_tty_open (tty); +if (ret <0 ) +pps_unregister_source ((int ) tty->disc_data); + +pr_info ("PPS source #%d \"%s\" added\n" , ret, info.path); + +return 0 ; +}
hm. The n_tty_open/close layering is a bit grubby but I guess we don't have a need to create anything more comprehensive at this stage.
A small stylistic thing: the code's a bit confusing at present because the names n_tty_open/n_tty_close are identical to the global functions over in n_tty.c. A user of ctags will be tricked. Also, the _way_ in which these function pointers are called:
ret = n_tty_open(tty);
make it look like the code is calling drivers/char/n_tty.c:n_tty_open(). Except it isn't.
So I think it's better to do it with
ret = (*n_tty_open)(tty);
to avoid misleading the reader.
And perhaps to rename these variables to avoid the duplication with the global functions.
Rodolfo Giometti
maintainerRe: [PATCH 6/8] pps: serial clients support.
Quoted 14 lines · Andrew Morton
hm. The n_tty_open/close layering is a bit grubby but I guess we don't have a need to create anything more comprehensive at this stage.
A small stylistic thing: the code's a bit confusing at present because the names n_tty_open/n_tty_close are identical to the global functions over in
n_tty.c. A user of ctags will be tricked. Also, the _way_ in which these function pointers are called:ret = n_tty_open(tty);make it look like the code is calling drivers/char/n_tty.c:n_tty_open(). Except it isn't.
Quoted 8 lines
So I think it's better to do it with
ret = (*n_tty_open)(tty);to avoid misleading the reader.
And perhaps to rename these variables to avoid the duplication with the global functions.
It could be acceptable using functions alias_n_tty_open()/alias_n_tty_close() modifying the code as follow?
(quoted diff) +0 -0
b/drivers/pps/clients/pps-ldisc.c
index 59e6301..15c4622 100644
drivers/pps/clients/pps-ldisc.c +0 -0
@@ -53,7 +53,7 @@ static void pps_tty_dcd_change(struct tty_struct
*tty, unsigne
status ? "assert" : "clear", jiffies, id);
}
-static int (*n_tty_open)(struct tty_struct *tty); +static int (*alias_n_tty_open)(struct tty_struct *tty);
static int pps_tty_open(struct tty_struct *tty)
{
@@ -79,7 +79,7 @@ static int pps_tty_open(struct tty_struct *tty)
tty->disc_data = (void *) ret;
/* Should open N_TTY ldisc too */
- ret = n_tty_open(tty);
+ ret = alias_n_tty_open(tty);
if (ret < 0)
pps_unregister_source((int) tty->disc_data);@@ -88,14 +88,14 @@ static int pps_tty_open(struct tty_struct *tty)
return 0;
}
-static void (*n_tty_close)(struct tty_struct *tty); +static void (*alias_n_tty_close)(struct tty_struct *tty);
static void pps_tty_close(struct tty_struct *tty)
{
int id = (int) tty->disc_data;
pps_unregister_source(id);- n_tty_close(tty);
+ alias_n_tty_close(tty);
pr_info("PPS source #%d removed\n", id);}
Ciao,
Rodolfo
Signature · 5 lines
GNU/Linux Solutions e-mail: [email protected] Linux Device Driver [email protected] Embedded Systems phone: +39 349 2432127 UNIX programming skype: rodolfo.giometti Freelance ICT Italia - Consulente ICT Italia - www.consulenti-ict.it
Re: [PATCH 5/8] ldisc n_tty: add new method n_tty_inherit_ops()
In reply to Rodolfo Giomettidrivers/char/n_tty.c struct tty_ldisc_ops tty_ldisc_N_TTY = { · line 2102
Quoted 9 lines · On Tue, 16 Feb 2010 10:51:22 +0100 Rodolfo Giometti <[email protected]> wrote:
};
drivers/char/n_tty.c +8
-0+ +void n_tty_inherit_ops (struct tty_ldisc_ops *ops) +{ + *ops = tty_ldisc_N_TTY; + ops->owner =NULL ; + ops->refcount = ops->flags =0 ; +} +EXPORT_SYMBOL_GPL (n_tty_inherit_ops);
Most (nearly all) functions in n_tty.c have been documented in kerneldoc form. Let's continue that please.
n_tty_inherit_ops() is of course pretty simple, but OTOH it's a global, export-to-modules interface.
Re: [PATCH 2/8] pps: documentation programs and examples.
In reply to Rodolfo GiomettiQuoted 7 lines · On Tue, 16 Feb 2010 10:51:19 +0100 Rodolfo Giometti <[email protected]> wrote:
Here some utilities and examples about the PPS API and the LinuxPPS support.
*
ppstest.cimplements an useful testing program, while* ppsfind tries to help the user into finding a specific PPS source by using its name or path.
Maybe these tools should be in a separate package (say pps-tools)? I've written several tools too. They are based on your code. I think there should be at least two of them:
* ppsctl to get/set params, get capabilities and bind/unbind kernel
consumer
* ppstest to fetch data and provide several representations for it
I can assist in this task too.
Quoted 234 lines
Signed-off-by Rodolfo Giometti <[email protected]>--- Documentation/pps/Makefile | 27 ++++++++ Documentation/pps/ppsfind | 17 +++++ Documentation/pps/ppstest.c | 150+++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 194 insertions(+), 0 deletions(-) create mode 100644
Documentation/pps/Makefilecreate mode 100644Documentation/pps/ppsfindcreate mode 100644Documentation/pps/ppstest.cDocumentation/pps/Makefile new file +27
-0@@ -0,0 +1,27 @@ +TARGETS = ppstest + +CFLAGS += -Wall -O2 -D_GNU_SOURCE +CFLAGS += -I . -I ../../include/ +CFLAGS += -ggdb + +# -- Actions section -- + +.PHONY : all depend dep + +all : .depend $(TARGETS) + +.depend depend dep : + $(CC) $(CFLAGS) -M $(TARGETS:=.c) > .depend + +ifeq (.depend,$(wildcard .depend)) +include .depend +endif + + +# -- Clean section -- + +.PHONY : clean + +clean : + rm -f *.o *~ core .depend + rm -f ${TARGETS}Documentation/pps/ppsfind new file +13
-0@@ -0,0 +1,17 @@ +#!/bin/sh + +SYS="/sys/class/pps/" + +if [ $# -lt 1 ] ; then + echo "usage: ppsfind <name>" >&2 + exit 1 +fi + +for d in $(ls $SYS) ; do + if grep $1 $SYS/$d/name >& /dev/null || \ + grep $1 $SYS/$d/path >& /dev/null ; then + echo "$d: name=$(cat $SYS/$d/name) path=$(cat$SYS/$d/path)"
Documentation/pps/ppsfind new file +4
-0+ fi +done + +exit 0Documentation/pps/ppstest.c new file +17
-0@@ -0,0 +1,150 @@ +#include <stdio.h> +#include <stdlib.h> +#include <unistd.h> +#include <fcntl.h> +#include <sys/types.h> +#include <sys/stat.h> + +#include <timepps.h> + +int find_source (char *path,pps_handle_t *handle,int *avail_mode) +{ +pps_params_t params; +int ret; + +printf ("trying PPS source \"%s\"\n" , path); + +/* Try to find the source by using the supplied "path" name */
Documentation/pps/ppstest.c new file +3
-0+ ret =open (path,O_RDWR ); +if (ret <0 ) { + fprintf(stderr, "unable to open device\"%s\" (%m)\n", path);
Documentation/pps/ppstest.c new file +7
-0+return ret; + } + +/* Open the PPS source (and check the file descriptor) */ + ret =time_pps_create (ret, handle); +if (ret <0 ) { + fprintf(stderr, "cannot create a PPS source fromdevice "
Documentation/pps/ppstest.c new file +53
-0+ "\"%s\" (%m)\n", path); +return -1 ; + } +printf ("found PPS source \"%s\"\n" , path); + +/* Find out what features are supported */ + ret =time_pps_getcap (*handle, avail_mode); +if (ret <0 ) { +fprintf (stderr,"cannot get capabilities (%m)\n" ); +return -1 ; + } +if ((*avail_mode &PPS_CAPTUREASSERT ) ==0 ) { +fprintf (stderr,"cannot CAPTUREASSERT\n" ); +return -1 ; + } +if ((*avail_mode &PPS_OFFSETASSERT ) ==0 ) { +fprintf (stderr,"cannot OFFSETASSERT\n" ); +return -1 ; + } + +/* Capture assert timestamps, and compensate for a 675 nsec +* propagation delay */ + ret =time_pps_getparams (*handle, ¶ms); +if (ret <0 ) { +fprintf (stderr,"cannot get parameters (%m)\n" ); +return -1 ; + } + params.assert_offset.tv_sec =0 ; + params.assert_offset.tv_nsec =675 ; + params.mode |=PPS_CAPTUREASSERT |PPS_OFFSETASSERT ; + params.mode &= ~(PPS_CAPTURECLEAR |PPS_OFFSETCLEAR ); + ret =time_pps_setparams (*handle, ¶ms); +if (ret <0 ) { +fprintf (stderr,"cannot set parameters (%m)\n" ); +return -1 ; + } + +return 0 ; +} + +int fetch_source (int i,pps_handle_t *handle,int *avail_mode) +{ +struct timespec timeout; +pps_info_t infobuf; +int ret; + +/* create a zero-valued timeout */ + timeout.tv_sec =3 ; + timeout.tv_nsec =0 ; + +retry: +if (*avail_mode &PPS_CANWAIT )/* waits for the next event */ + ret = time_pps_fetch(*handle, PPS_TSFMT_TSPEC,&infobuf,
Documentation/pps/ppstest.c new file +4
-0+ &timeout); + else { +sleep (1 ); + ret = time_pps_fetch(*handle, PPS_TSFMT_TSPEC,&infobuf,
Documentation/pps/ppstest.c new file +5
-0+ &timeout); + } +if (ret <0 ) { +if (ret == -EINTR ) { + fprintf(stderr, "time_pps_fetch() got asignal!\n");
Documentation/pps/ppstest.c new file +4
-0+ goto retry; + } + + fprintf(stderr, "time_pps_fetch() error %d (%m)\n",ret);
Documentation/pps/ppstest.c new file +12
-0+return -1 ; + } + + printf("source %d - " + "assert %ld.%09ld, sequence: %ld - " + "clear %ld.%09ld, sequence: %ld\n", + i, + infobuf.assert_timestamp.tv_sec, + infobuf.assert_timestamp.tv_nsec, + infobuf.assert_sequence, + infobuf.clear_timestamp.tv_sec, + infobuf.clear_timestamp.tv_nsec,infobuf.clear_sequence); +
Documentation/pps/ppstest.c new file +23
-0+return 0 ; +} + +void usage (char *name) +{ +fprintf (stderr,"usage: %s <ppsdev> [<ppsdev> ...]\n" , name); +exit (EXIT_FAILURE ); +} + +int main (int argc,char *argv[]) +{ +int num; +pps_handle_t handle[4 ]; +int avail_mode[4 ]; +int i =0 ; +int ret; + +/* Check the command line */ +if (argc <2 ) +usage (argv[0 ]); + +for (i =1 ; i < argc && i <=4 ; i++) { + ret = find_source(argv[i], &handle[i - 1],&avail_mode[i - 1]);
Documentation/pps/ppstest.c new file +6
-0+if (ret <0 ) +exit (EXIT_FAILURE ); + } + + num = i -1 ; + printf("ok, found %d source(s), now start fetchingdata...\n", num); +
Documentation/pps/ppstest.c new file +1
-0+/* loop, printing the most recent timestamp every second or so */
Documentation/pps/ppstest.c new file +3
-0+while (1 ) { +for (i =0 ; i < num; i++) { + ret = fetch_source(i, &handle[i],&avail_mode[i]);
Documentation/pps/ppstest.c new file +10
-0+if (ret <0 && errno !=ETIMEDOUT ) +exit (EXIT_FAILURE ); + } + } + +for (; i >=0 ; i--) +time_pps_destroy (handle[i]); + +return 0 ; +}
Signature · 1 line
Alexander
Rodolfo Giometti
maintainerRe: [PATCH 2/8] pps: documentation programs and examples.
Quoted 15 lines · Alexander Gordeev
Quoted 7 lines · On Tue, 16 Feb 2010 10:51:19 +0100 Rodolfo Giometti <[email protected]> wrote:
Here some utilities and examples about the PPS API and the LinuxPPS support.
*
ppstest.cimplements an useful testing program, while* ppsfind tries to help the user into finding a specific PPS source by using its name or path.
Maybe these tools should be in a separate package (say pps-tools)? I've written several tools too. They are based on your code. I think there should be at least two of them:
Quoted 6 lines
* ppsctl to get/set params, get capabilities and bind/unbind kernel
consumer* ppstest to fetch data and provide several representations for it
I can assist in this task too.
Great! It's ok for me. Please, let me know how we can proceed.
Thanks a lot,
Rodolfo
Signature · 5 lines
GNU/Linux Solutions e-mail: [email protected] Linux Device Driver [email protected] Embedded Systems phone: +39 349 2432127 UNIX programming skype: rodolfo.giometti Freelance ICT Italia - Consulente ICT Italia - www.consulenti-ict.it
Re: [PATCH 1/8] pps: userland header file for PPS API.
In reply to Rodolfo GiomettiHi Rodolfo,
Quoted 6 lines · On Tue, 16 Feb 2010 10:51:18 +0100 Rodolfo Giometti <[email protected]> wrote:
This patch adds into the PPS's documentation directory a possible implementation of the PPS API (RFC 2783) by using the LinuxPPS's char devices.
This file is not just an example but it can be used into real systems. :)
Isn't libc a proper place for this file? This header file provides a generic standardized interface (PPSAPI) to the custom Linux implementation (linux/pps.h). I think this is just what libc is for.
I wanted to file a bug in Debian BTS last week to add this header to libc6-dev package and also push it upstream but something distracted me. If you agree that the header should be in libc then I can do it now.
Quoted 231 lines
Signed-off-by Rodolfo Giometti <[email protected]>--- Documentation/pps/timepps.h | 198+++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 198 insertions(+), 0 deletions(-) create mode 100644
Documentation/pps/timepps.hDocumentation/pps/timepps.h new file +6
-0@@ -0,0 +1,198 @@ +/* +* timepps.h -- PPS API main header +* +* Copyright (C) 2005-2007 Rodolfo Giometti <[email protected]> +* +* 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */Documentation/pps/timepps.h new file +11
-0+ +#ifndef _SYS_TIMEPPS_H_ +#define _SYS_TIMEPPS_H_ + +#include <errno.h> +#include <sys/time.h> +#include <sys/ioctl.h> +#include <linux/types.h> +#include <linux/pps.h> + +#define LINUXPPS 1/* signal we are using LinuxPPS */ +
Documentation/pps/timepps.h new file +17
-0+/* +* New data structures +*/ + +struct ntp_fp { +unsigned int integral; +unsigned int fractional; +}; + +union pps_timeu { +struct timespec tspec; +struct ntp_fp ntpfp; +unsigned long longpad[3 ]; +}; + +struct pps_info { +unsigned long assert_sequence;/* seq. num. of assert event */
Documentation/pps/timepps.h new file +1
-0+unsigned long clear_sequence;/* seq. num. of clear event */
Documentation/pps/timepps.h new file +9
-0+union pps_timeu assert_tu;/* time of assert event */ +union pps_timeu clear_tu;/* time of clear event */ +int current_mode;/* current mode bits */ +}; + +struct pps_params { +int api_version;/* API version # */ +int mode;/* mode bits */ +union pps_timeu assert_off_tu;/* offset compensation for assert */
Documentation/pps/timepps.h new file +1
-0+union pps_timeu clear_off_tu;/* offset compensation for clear */ +};
Documentation/pps/timepps.h new file +2
-0+ +typedef int pps_handle_t ;/* represents a PPS source */ +typedef unsigned long
pps_seq_t; /* sequence number */
+typedef structntp_fpntp_fp_t; /* NTP-compatible
time stamp */ +typedef unionpps_timeupps_timeu_t; /* generic
data type for time stamps */ +typedef structpps_infopps_info_t;Documentation/pps/timepps.h new file +38
-0+typedef struct pps_params pps_params_t ; + +#define assert_timestamp assert_tu.tspec +#define clear_timestamp clear_tu.tspec + +#define assert_timestamp_ntpfp assert_tu.ntpfp +#define clear_timestamp_ntpfp clear_tu.ntpfp + +#define assert_offset assert_off_tu.tspec +#define clear_offset clear_off_tu.tspec + +#define assert_offset_ntpfp assert_off_tu.ntpfp +#define clear_offset_ntpfp clear_off_tu.ntpfp + +/* +* The PPS API +*/ + +static __inlineint time_pps_create (int source,pps_handle_t *handle) +{ +int ret; +struct pps_kparams dummy; + +if (!handle) { + errno =EINVAL ; +return -1 ; + } + +/* First we check if current device is a valid PPS one by +* doing a dummy PPS_GETPARAMS... +*/ + ret =ioctl (source,PPS_GETPARAMS , &dummy); +if (ret) { + errno =EOPNOTSUPP ; +return -1 ; + } + +/* ... then since in LinuxPPS there are no differences between a
Documentation/pps/timepps.h new file +1
-0+* "PPS source" and a "PPS handle", we simply return the same value.
Documentation/pps/timepps.h new file +22
-0+*/ + *handle = source; + +return 0 ; +} + +static __inlineint time_pps_destroy (pps_handle_t handle) +{ +return close (handle); +} + +static __inlineint time_pps_getparams (pps_handle_t handle, +pps_params_t *ppsparams) +{ +int ret; +struct pps_kparams __ppsparams; + + ret =ioctl (handle,PPS_GETPARAMS , &__ppsparams); + + ppsparams->api_version = __ppsparams.api_version; + ppsparams->mode = __ppsparams.mode; + ppsparams->assert_off_tu.tspec.tv_sec =__ppsparams.assert_off_tu.sec;
Documentation/pps/timepps.h new file +1
-0+ ppsparams->assert_off_tu.tspec.tv_nsec =__ppsparams.assert_off_tu.nsec;
Documentation/pps/timepps.h new file +1
-0+ ppsparams->clear_off_tu.tspec.tv_sec =__ppsparams.clear_off_tu.sec;
Documentation/pps/timepps.h new file +1
-0+ ppsparams->clear_off_tu.tspec.tv_nsec =__ppsparams.clear_off_tu.nsec; +
Documentation/pps/timepps.h new file +5
-0+return ret; +} + +static __inlineint time_pps_setparams (pps_handle_t handle, + const pps_params_t*ppsparams) +{
Documentation/pps/timepps.h new file +5
-0+struct pps_kparams __ppsparams; + + __ppsparams.api_version = ppsparams->api_version; + __ppsparams.mode = ppsparams->mode; + __ppsparams.assert_off_tu.sec =
ppsparams->assert_off_tu.tspec.tv_sec;Documentation/pps/timepps.h new file +1
-0+ __ppsparams.assert_off_tu.nsec =
ppsparams->assert_off_tu.tspec.tv_nsec;Documentation/pps/timepps.h new file +1
-0+ __ppsparams.clear_off_tu.sec =
ppsparams->clear_off_tu.tspec.tv_sec;Documentation/pps/timepps.h new file +1
-0+ __ppsparams.clear_off_tu.nsec =
ppsparams->clear_off_tu.tspec.tv_nsec; +Documentation/pps/timepps.h new file +10
-0+return ioctl (handle,PPS_SETPARAMS , &__ppsparams); +} + +/* Get capabilities for handle */ +static __inlineint time_pps_getcap (pps_handle_t handle,int *mode) +{ +return ioctl (handle,PPS_GETCAP , mode); +} + +static __inline int time_pps_fetch(pps_handle_t handle, const inttsformat,
Documentation/pps/timepps.h new file +2
-0+pps_info_t *ppsinfobuf, + const struct timespec*timeout) +{
Documentation/pps/timepps.h new file +21
-0+struct pps_fdata __fdata; +int ret; + +/* Sanity checks */ +if (tsformat !=PPS_TSFMT_TSPEC ) { + errno =EINVAL ; +return -1 ; + } + +if (timeout) { + __fdata.timeout.sec = timeout->tv_sec; + __fdata.timeout.nsec = timeout->tv_nsec; + __fdata.timeout.flags = ~PPS_TIME_INVALID ; + }else + __fdata.timeout.flags =PPS_TIME_INVALID ; + + ret =ioctl (handle,PPS_FETCH , &__fdata); + + ppsinfobuf->assert_sequence = __fdata.info.assert_sequence; + ppsinfobuf->clear_sequence = __fdata.info.clear_sequence; + ppsinfobuf->assert_tu.tspec.tv_sec =__fdata.info.assert_tu.sec;
Documentation/pps/timepps.h new file +1
-0+ ppsinfobuf->assert_tu.tspec.tv_nsec =__fdata.info.assert_tu.nsec;
Documentation/pps/timepps.h new file +1
-0+ ppsinfobuf->clear_tu.tspec.tv_sec =__fdata.info.clear_tu.sec;
Documentation/pps/timepps.h new file +1
-0+ ppsinfobuf->clear_tu.tspec.tv_nsec =__fdata.info.clear_tu.nsec;
Documentation/pps/timepps.h new file +8
-0+ ppsinfobuf->current_mode = __fdata.info.current_mode; + +return ret; +} + +static __inlineint time_pps_kcbind (pps_handle_t handle, +const int kernel_consumer, + const int edge, const inttsformat) +{
Documentation/pps/timepps.h new file +6
-0+/* LinuxPPS doesn't implement kernel consumer feature */ + errno =EOPNOTSUPP ; + return -1; +} + +#endif /* _SYS_TIMEPPS_H_ */
Signature · 1 line
Alexander
Rodolfo Giometti
maintainerRe: [PATCH 1/8] pps: userland header file for PPS API.
Quoted 9 lines · Alexander Gordeev
Hi Rodolfo,
Quoted 4 lines · On Tue, 16 Feb 2010 10:51:18 +0100 Rodolfo Giometti <[email protected]> wrote:
This patch adds into the PPS's documentation directory a possible implementation of the PPS API (RFC 2783) by using the LinuxPPS's char devices.
Quoted 6 lines
Quoted 2 lines
This file is not just an example but it can be used into real systems. :)
Isn't libc a proper place for this file? This header file provides a generic standardized interface (PPSAPI) to the custom Linux implementation (
linux/pps.h). I think this is just what libc is for.
You are right, but I added that file for documentation purpose also. Just to illustrate how to implement an high level API with my simple char device interface.
Quoted 3 lines
I wanted to file a bug in Debian BTS last week to add this header to libc6-dev package and also push it upstream but something distracted me. If you agree that the header should be in libc then I can do it now.
I agree. :)
Can you please put me in Cc in your letters with the Debian people?
Thanks a lot,
Rodolfo
Signature · 5 lines
GNU/Linux Solutions e-mail: [email protected] Linux Device Driver [email protected] Embedded Systems phone: +39 349 2432127 UNIX programming skype: rodolfo.giometti Freelance ICT Italia - Consulente ICT Italia - www.consulenti-ict.it
Quoted 10 lines · On Tue, 16 Feb 2010 10:51:17 +0100 Rodolfo Giometti <[email protected]> wrote:
This patchset adds several PPS functionalities.
All patches have a specific comment but I prefer say something more:
* Patches 01-02 are just documentation about PPS support.
* Patch 03 adds PPS client support skeleton.
* Patches 04-06 add generic PPS serial support (with specific modifications requested by Alan Cox).
Thanks - the serial/tty stuff is much much cleaner in this patch set.