Skip to contentSkip to conversation

LinuxPPS: the PPS Linux implementation.

PATCH In review Rodolfo Giometti 4 participants 15 messages Feb 8, 2008 – Feb 11, 2008

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

This patch set adds the PPS support into Linux.

PPS means "pulse per second" and its API is specified by RFC 2783 (Pulse-Per-Second API for UNIX-like Operating Systems, Version 1.0).

The code has been tested with the NTPD program
(http://www.eecis.udel.edu/~mills/ntp/html/index.html) and several GPS antennae.

Rodolfo

--

 Documentation/pps/Makefile     |    2 
 b/Documentation/pps/Makefile   |   27 +++
 b/Documentation/pps/pps.txt    |  171 ++++++++++++++++++++
 b/Documentation/pps/ppsctl.c   |   63 +++++++
 b/Documentation/pps/ppsfind    |   17 ++
 b/Documentation/pps/ppstest.c  |  152 ++++++++++++++++++
 b/Documentation/pps/timepps.h  |  196 +++++++++++++++++++++++
 b/MAINTAINERS                  |    7 
 b/drivers/Kconfig              |    2 
 b/drivers/Makefile             |    1 
 b/drivers/char/lp.c            |   61 +++++++
 b/drivers/pps/Kconfig          |   32 +++
 b/drivers/pps/Makefile         |   10 +
 b/drivers/pps/clients/Kconfig  |   18 ++
 b/drivers/pps/clients/Makefile |    9 +
 b/drivers/pps/clients/ktimer.c |  115 +++++++++++++
 b/drivers/pps/kapi.c           |  272 ++++++++++++++++++++++++++++++++
 b/drivers/pps/pps.c            |  342 +++++++++++++++++++++++++++++++++++++++++ b/drivers/pps/sysfs.c          |  142 +++++++++++++++++
 b/drivers/serial/8250.c        |    2 
 b/drivers/serial/serial_core.c |   71 ++++++++
 b/include/linux/Kbuild         |    1 
 b/include/linux/parport.h      |   13 +
 b/include/linux/pps.h          |  205 ++++++++++++++++++++++++
 b/include/linux/serial_core.h  |   31 ++-
 drivers/pps/Kconfig            |    2 
 drivers/pps/Makefile           |    1 
 drivers/pps/clients/Kconfig    |   20 ++
 28 files changed, 1969 insertions(+), 16 deletions(-)
#1 lore raw

PATCH 1/8 LinuxPPS core support.

This patch adds the kernel side of the PPS support currently named "LinuxPPS".

PPS means "pulse per second" and a PPS source is just a device which provides a high precision signal each second so that an application can use it to adjust system clock time.

Common use is the combination of the NTPD as userland program with a GPS receiver as PPS source to obtain a wallclock-time with sub-millisecond synchronisation to UTC.

To obtain this goal the userland programs shoud use the PPS API specification (RFC 2783 - Pulse-Per-Second API for UNIX-like Operating Systems, Version 1.0) which in part is implemented by this patch. It provides a set of chars devices, one per PPS source, which can be used to get the time signal. The RFC's functions can be implemented by accessing to these char devices.

---
 MAINTAINERS          |    7 +
 drivers/Kconfig      |    2 +
 drivers/Makefile     |    1 +
 drivers/pps/Kconfig  |   32 +++++
 drivers/pps/Makefile |   10 ++
 drivers/pps/kapi.c   |  272 +++++++++++++++++++++++++++++++++++++++
 drivers/pps/pps.c    |  342 ++++++++++++++++++++++++++++++++++++++++++++++++++
 drivers/pps/sysfs.c  |  142 +++++++++++++++++++++
 include/linux/Kbuild |    1 +
 include/linux/pps.h  |  204 ++++++++++++++++++++++++++++++
 10 files changed, 1013 insertions(+), 0 deletions(-)
 create mode 100644 drivers/pps/Kconfig
 create mode 100644 drivers/pps/Makefile
 create mode 100644 drivers/pps/kapi.c
 create mode 100644 drivers/pps/pps.c
 create mode 100644 drivers/pps/sysfs.c
 create mode 100644 include/linux/pps.h
MAINTAINERS +7 -0
index 58b1603..c1cd5c2 100644
@@ -3096,6 +3096,13 @@ P:	James Chapman
 M:	[email protected]
 S:	Maintained
 
+PPS SUPPORT
+P:	Rodolfo Giometti
+M:	[email protected]
+W:	http://wiki.enneenne.com/index.php/LinuxPPS_support
+L:	[email protected]
+S:	Maintained
+
 PREEMPTIBLE KERNEL
 P:	Robert Love
 M:	[email protected]
drivers/Kconfig +2 -0
index 08d4ae2..2c656c8 100644
@@ -52,6 +52,8 @@ source "drivers/i2c/Kconfig"
 
 source "drivers/spi/Kconfig"
 
+source "drivers/pps/Kconfig"
+
 source "drivers/w1/Kconfig"
 
 source "drivers/power/Kconfig"
drivers/Makefile +1 -0
index 0ee9a8a..da8fee3 100644
@@ -61,6 +61,7 @@ obj-$(CONFIG_INPUT)		+= input/
 obj-$(CONFIG_I2O)		+= message/
 obj-$(CONFIG_RTC_LIB)		+= rtc/
 obj-y				+= i2c/
+obj-$(CONFIG_PPS)		+= pps/
 obj-$(CONFIG_W1)		+= w1/
 obj-$(CONFIG_POWER_SUPPLY)	+= power/
 obj-$(CONFIG_HWMON)		+= hwmon/
drivers/pps/Kconfig new file +32 -0
new file mode 100644
index 0000000..dce4a1f
@@ -0,0 +1,32 @@
+#
+# PPS support configuration
+#
+
+menu "PPS support"
+
+config PPS
+	tristate "PPS support"
+	depends on EXPERIMENTAL
+	---help---
+	  PPS (Pulse Per Second) is a special pulse provided by some GPS
+	  antennae. Userland can use it to get an high time reference.
+
+	  Some antennae's PPS signals are connected with the CD (Carrier
+	  Detect) pin of the serial line they use to communicate with the
+	  host. In this case use the SERIAL_LINE client support.
+
+	  Some antennae's PPS signals are connected with some special host
+	  inputs so you have to enable the corresponding client support.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called pps_core.ko.
+
+config PPS_DEBUG
+	bool "PPS debugging messages"
+	depends on PPS
+	help
+	  Say Y here if you want the PPS support to produce a bunch of 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.
+
+endmenu
drivers/pps/Makefile new file +10 -0
new file mode 100644
index 0000000..5a9a51b
@@ -0,0 +1,10 @@
+#
+# Makefile for the PPS core.
+#
+
+pps_core-objs			+= pps.o kapi.o sysfs.o
+obj-$(CONFIG_PPS)		+= pps_core.o
+
+ifeq ($(CONFIG_PPS_DEBUG),y)
+EXTRA_CFLAGS += -DDEBUG
+endif
drivers/pps/kapi.c new file +272 -0

272 lines not on this page · raw message

drivers/pps/pps.c new file +342 -0

342 lines not on this page · raw message

drivers/pps/sysfs.c new file +142 -0

142 lines not on this page · raw message

include/linux/Kbuild +1 -0
index c0f9bb7..93c5363 100644
@@ -297,6 +297,7 @@ unifdef-y += pmu.h
 unifdef-y += poll.h
 unifdef-y += ppp_defs.h
 unifdef-y += ppp-comp.h
+unifdef-y += pps.h
 unifdef-y += ptrace.h
 unifdef-y += qnx4_fs.h
 unifdef-y += quota.h
include/linux/pps.h new file +204 -0

204 lines not on this page · raw message

Signature · 1 line
1.5.2.5
#2 lore raw

PATCH 2/8 PPS: basic documentation file.

---
 Documentation/pps/pps.txt |  170 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 170 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/pps/pps.txt
Documentation/pps/pps.txt new file +170 -0
new file mode 100644
index 0000000..2af58bd
@@ -0,0 +1,170 @@
+
+			PPS - Pulse Per Second
+			----------------------
+
+(C) Copyright 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.
+
+
+
+Overview
+--------
+
+LinuxPPS provides a programming interface (API) to define into the
+system several PPS sources.
+
+PPS means "pulse per second" and a PPS source is just a device which
+provides a high precision signal each second so that an application
+can use it to adjust system clock time.
+
+A PPS source can be connected to a serial port (usually to the Data
+Carrier Detect pin) or to a parallel port (ACK-pin) or to a special
+CPU's GPIOs (this is the common case in embedded systems) but in each
+case when a new pulse comes the system must apply to it a timestamp
+and record it for the userland.
+
+Common use is the combination of the NTPD as userland program with a
+GPS receiver as PPS source to obtain a wallclock-time with
+sub-millisecond synchronisation to UTC.
+
+
+RFC considerations
+------------------
+
+While implementing a PPS API as RFC 2783 defines and using an embedded
+CPU GPIO-Pin as physical link to the signal, I encountered a deeper
+problem:
+
+   At startup it needs a file descriptor as argument for the function
+   time_pps_create().
+
+This implies that the source has a /dev/... entry. This assumption is
+ok for the serial and parallel port, where you can do something
+useful besides(!) the gathering of timestamps as it is the central
+task for a PPS-API. But this assumption does not work for a single
+purpose GPIO line. In this case even basic file-related functionality
+(like read() and write()) makes no sense at all and should not be a
+precondition for the use of a PPS-API.
+
+The problem can be simply solved if you consider that a PPS source is
+not always connected with a GPS data source.
+
+So your programs should check if the GPS data source (the serial port
+for instance) is a PPS source too, otherwise they should provide the
+possibility to open another device as PPS source.
+
+In LinuxPPS the PPS sources are simply char devices usually mapped
+into files /dev/pps0, /dev/pps1, etc..
+
+
+Coding example
+--------------
+
+To register a PPS source into the kernel you should define a struct
+pps_source_info_s as follow:
+
+    static struct pps_source_info_s pps_ktimer_info = {
+            .name         = "ktimer",
+            .path         = "",
+            .mode         = PPS_CAPTUREASSERT | PPS_OFFSETASSERT | \
+			    PPS_ECHOASSERT | \
+                            PPS_CANWAIT | PPS_TSFMT_TSPEC,
+            .echo         = pps_ktimer_echo,
+            .owner        = THIS_MODULE,
+    };
+
+and then calling the function pps_register_source() in your
+intialization routine as follow:
+
+    source = pps_register_source(&pps_ktimer_info,
+			PPS_CAPTUREASSERT | PPS_OFFSETASSERT);
+
+The pps_register_source() prototype is:
+
+  int pps_register_source(struct pps_source_info_s *info, int default_params)
+
+where "info" is a pointer to a structure that describes a particular
+PPS source, "default_params" tells the system what the initial default
+parameters for the device should be (is obvious that these parameters
+must be a subset of ones defined into the struct
+pps_source_info_s which describe the capabilities of the driver).
+
+Once you have registered a new PPS source into the system you can
+signal an assert event (for example in the interrupt handler routine)
+just using:
+
+    pps_event(source, PPS_CAPTUREASSERT, ptr);
+
+The same function may also run the defined echo function
+(pps_ktimer_echo(), passing to it the "ptr" pointer) if the user
+asked for that... etc..
+
+Please see the file drivers/pps/clients/ktimer.c for an example code.
+
+
+SYSFS support
+-------------
+
+If the SYSFS filesystem is enabled in the kernel it provides a new class:
+
+   $ ls /sys/class/pps/
+   pps0/  pps1/  pps2/
+
+Every directory is the ID of a PPS sources defined into the system and
+inside you find several files:
+
+   $ ls /sys/class/pps/pps0/
+   assert	clear  echo  mode  name  path  subsystem@  uevent
+
+Inside each "assert" and "clear" file you can find the timestamp and a
+sequence number:
+
+   $ cat /sys/class/pps/pps0/assert
+   1170026870.983207967#8
+
+Where before the "#" is the timestamp in seconds and after it is the
+sequence number. Other files are:
+
+* echo: reports if the PPS source has an echo function or not;
+
+* mode: reports available PPS functioning modes;
+
+* name: reports the PPS source's name;
+
+* path: reports the PPS source's device path, that is the device the
+  PPS source is connected to (if it exists).
+
+
+Testing the PPS support
+-----------------------
+
+In order to test the PPS support even without specific hardware you can use
+the ktimer driver (see the client subsection in the PPS configuration menu)
+and the userland tools provided into Documentaion/pps/ directory.
+
+Once you have enabled the compilation of ktimer just modprobe it (if
+not statically compiled):
+
+   # modprobe ktimer
+
+and the run ppstest as follow:
+
+   $ ./ppstest /dev/pps0
+   trying PPS source "/dev/pps1"
+   found PPS source "/dev/pps1"
+   ok, found 1 source(s), now start fetching data...
+   source 0 - assert 1186592699.388832443, sequence: 364 - clear  0.000000000, sequence: 0
+   source 0 - assert 1186592700.388931295, sequence: 365 - clear  0.000000000, sequence: 0
+   source 0 - assert 1186592701.389032765, sequence: 366 - clear  0.000000000, sequence: 0
+
+Please, note that to compile userland programs you need the file timepps.h
+(see Documentation/pps/).
Signature · 1 line
1.5.2.5
#3 lore raw

PATCH 3/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 |  195 +++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 195 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/pps/timepps.h
Documentation/pps/timepps.h new file +195 -0
new file mode 100644
index 0000000..2372949
@@ -0,0 +1,195 @@
+/*
+ * 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 <sys/syscall.h>
+#include <unistd.h>
+#include <errno.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 __inline int time_pps_create(int source, pps_handle_t *handle)
+{
+	int ret;
+
+	if (!handle) {
+		errno = EINVAL;
+		return -1;
+	}
+
+	/* First we check if current device is a PPS valid PPS one...
+	 */
+	ret = ioctl(source, PPS_CHECK);
+	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 __inline int time_pps_destroy(pps_handle_t handle)
+{
+	return close(handle);
+}
+
+static __inline int 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 __inline int 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 __inline int 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 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 __inline int 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.5.2.5
#4 lore raw

PATCH 4/8 PPS: documentation programs and examples.

Here some utilities and examples about the PPS API and the LinuxPPS support.

* ppsctl.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 |  151 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 195 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
new file mode 100644
index 0000000..af4f9b4
@@ -0,0 +1,27 @@
+TARGETS = ppstest
+
+CFLAGS += -Wall -O2 -D_GNU_SOURCE
+CFLAGS += -I .
+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
new file mode 100644
index 0000000..93c0e17
@@ -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 +151 -0

151 lines not on this page · raw message

Signature · 1 line
1.5.2.5
#5 lore raw

PATCH 5/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 |  114 ++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 144 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
index dce4a1f..0c82285 100644
@@ -29,4 +29,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
index 5a9a51b..d8ec308 100644
@@ -4,6 +4,7 @@
 
 pps_core-objs			+= pps.o kapi.o sysfs.o
 obj-$(CONFIG_PPS)		+= pps_core.o
+obj-y				+= clients/
 
 ifeq ($(CONFIG_PPS_DEBUG),y)
 EXTRA_CFLAGS += -DDEBUG
drivers/pps/clients/Kconfig new file +18 -0
new file mode 100644
index 0000000..60b83be
@@ -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
new file mode 100644
index 0000000..f3c1e39
@@ -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 +114 -0

114 lines not on this page · raw message

Signature · 1 line
1.5.2.5
#6 lore raw

PATCH 6/8 PPS: serial clients support.

Adds support for the PPS sources connected with the CD (Carrier Detect) pin of a serial port.

---
 drivers/pps/clients/Kconfig  |   10 ++++++
 drivers/serial/8250.c        |    2 +
 drivers/serial/serial_core.c |   71 +++++++++++++++++++++++++++++++++++++++++-
 include/linux/serial_core.h  |   30 ++++++++++++++---
 4 files changed, 106 insertions(+), 7 deletions(-)
drivers/pps/clients/Kconfig +10 -0
index 60b83be..517c338 100644
@@ -15,4 +15,14 @@ config PPS_CLIENT_KTIMER
 	  This driver can also be built as a module.  If so, the module
 	  will be called ktimer.ko.
 
+comment "UART serial support (forced off)"
+	depends on ! (SERIAL_CORE != n && !(PPS = m && SERIAL_CORE = y))
+
+config PPS_CLIENT_UART
+	bool "UART serial support"
+	depends on SERIAL_CORE != n && !(PPS = m && SERIAL_CORE = y)
+	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/serial/8250.c +2 -0
index f94109c..a5e83f8 100644
@@ -2118,6 +2118,8 @@ serial8250_set_termios(struct uart_port *port, struct ktermios *termios,
 		up->ier |= UART_IER_MSI;
 	if (up->capabilities & UART_CAP_UUE)
 		up->ier |= UART_IER_UUE | UART_IER_RTOIE;
+	if (up->port.flags & UPF_HARDPPS_CD)
+		up->ier |= UART_IER_MSI;	/* enable interrupts */
 
 	serial_out(up, UART_IER, up->ier);
 
drivers/serial/serial_core.c +70 -1

105 lines not on this page · raw message

include/linux/serial_core.h +24 -6
index 9963f81..c8e4d92 100644
@@ -160,6 +160,7 @@
 #include <linux/tty.h>
 #include <linux/mutex.h>
 #include <linux/sysrq.h>
+#include <linux/pps.h>
 
 struct uart_port;
 struct uart_info;
@@ -239,6 +240,9 @@ struct uart_port {
 	unsigned char		regshift;		/* reg offset shift */
 	unsigned char		iotype;			/* io access style */
 	unsigned char		unused1;
+#ifdef CONFIG_PPS_CLIENT_UART
+	int			pps_source;		/* PPS source ID */
+#endif
 
 #define UPIO_PORT		(0)
 #define UPIO_HUB6		(1)
@@ -283,7 +287,8 @@ struct uart_port {
 #define UPF_IOREMAP		((__force upf_t) (1 << 31))
 
 #define UPF_CHANGE_MASK		((__force upf_t) (0x17fff))
-#define UPF_USR_MASK		((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
+#define UPF_USR_MASK		((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY\
+							|UPF_HARDPPS_CD))
 
 	unsigned int		mctrl;			/* current modem ctrl settings */
 	unsigned int		timeout;		/* character-based timeout */
@@ -316,6 +321,10 @@ struct uart_state {
 	struct uart_info	*info;
 	struct uart_port	*port;
 
+#ifdef CONFIG_PPS_CLIENT_UART
+	struct pps_source_info	pps_info;
+#endif
+
 	struct mutex		mutex;
 };
 
@@ -480,13 +489,22 @@ uart_handle_dcd_change(struct uart_port *port, unsigned int status)
 {
 	struct uart_info *info = port->info;
 
-	port->icount.dcd++;
-
-#ifdef CONFIG_HARD_PPS
-	if ((port->flags & UPF_HARDPPS_CD) && status)
-		hardpps();
+#ifdef CONFIG_PPS_CLIENT_UART
+	if (port->flags & UPF_HARDPPS_CD) {
+		if (status) {
+			pps_event(port->pps_source, PPS_CAPTUREASSERT, port);
+			dev_dbg(port->dev, "PPS assert at %lu on source #%d\n",
+				jiffies, port->pps_source);
+		} else {
+			pps_event(port->pps_source, PPS_CAPTURECLEAR, port);
+			dev_dbg(port->dev, "PPS clear at %lu on source #%d\n",
+				jiffies, port->pps_source);
+		}
+	}
 #endif
 
+	port->icount.dcd++;
+
 	if (info->flags & UIF_CHECK_CD) {
 		if (status)
 			wake_up_interruptible(&info->open_wait);
Signature · 1 line
1.5.2.5
#7 lore raw

PATCH 7/8 PPS: example program to enable PPS support on serial ports.

---
 Documentation/pps/Makefile |    2 +-
 Documentation/pps/ppsctl.c |   62 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+), 1 deletions(-)
 create mode 100644 Documentation/pps/ppsctl.c
Documentation/pps/Makefile +1 -1
index af4f9b4..8ef4f47 100644
@@ -1,4 +1,4 @@
-TARGETS = ppstest
+TARGETS = ppstest ppsctl
 
 CFLAGS += -Wall -O2 -D_GNU_SOURCE
 CFLAGS += -I .
Documentation/pps/ppsctl.c new file +62 -0

62 lines not on this page · raw message

Signature · 1 line
1.5.2.5
#8 lore raw

PATCH 8/8 PPS: parallel port clients support.

Adds support for the PPS sources connected with the interrupt pin of a parallel port.

---
 drivers/char/lp.c           |   61 +++++++++++++++++++++++++++++++++++++++++++
 drivers/pps/clients/Kconfig |   10 +++++++
 include/linux/parport.h     |   12 ++++++++
 3 files changed, 83 insertions(+), 0 deletions(-)
drivers/char/lp.c +61 -0
index 81674d7..edc5f9d 100644
@@ -746,6 +746,27 @@ static struct console lpcons = {
 
 #endif /* console on line printer */
 
+/* Support for PPS signal on the line printer */
+
+#ifdef CONFIG_PPS_CLIENT_LP
+
+static void lp_pps_echo(int source, int event, void *data)
+{
+	struct parport *port = data;
+	unsigned char status = parport_read_status(port);
+
+	/* echo event via SEL bit */
+	parport_write_control(port,
+		parport_read_control(port) | PARPORT_CONTROL_SELECT);
+
+	/* signal no event */
+	if ((status & PARPORT_STATUS_ACK) != 0)
+		parport_write_control(port,
+			parport_read_control(port) & ~PARPORT_CONTROL_SELECT);
+}
+
+#endif
+
 /* --- initialisation code ------------------------------------- */
 
 static int parport_nr[LP_NO] = { [0 ... LP_NO-1] = LP_PARPORT_UNSPEC };
@@ -816,6 +837,38 @@ static int lp_register(int nr, struct parport *port)
 	}
 #endif
 
+#ifdef CONFIG_PPS_CLIENT_LP
+	port->pps_info.owner = THIS_MODULE;
+	port->pps_info.dev = port->dev;
+	snprintf(port->pps_info.path, PPS_MAX_NAME_LEN, "/dev/lp%d", nr);
+
+	/* No PPS support if lp port has no IRQ line */
+	if (port->irq != PARPORT_IRQ_NONE) {
+		strncpy(port->pps_info.name, port->name, PPS_MAX_NAME_LEN);
+
+		port->pps_info.mode = PPS_CAPTUREASSERT | PPS_OFFSETASSERT | \
+				PPS_ECHOASSERT | \
+				PPS_CANWAIT | PPS_TSFMT_TSPEC;
+
+		port->pps_info.echo = lp_pps_echo;
+
+		port->pps_source = pps_register_source(&(port->pps_info),
+				PPS_CAPTUREASSERT | PPS_OFFSETASSERT);
+		if (port->pps_source < 0)
+			dev_err(port->dev,
+					"cannot register PPS source \"%s\"\n",
+					port->pps_info.path);
+		else
+			dev_info(port->dev, "PPS source #%d \"%s\" added\n",
+					port->pps_source, port->pps_info.path);
+	} else {
+		port->pps_source = -1;
+		dev_err(port->dev, "PPS support disabled because port \"%s\" "
+					"is in polling mode\n",
+					port->pps_info.path);
+	}
+#endif
+
 	return 0;
 }
 
@@ -858,6 +911,14 @@ static void lp_detach (struct parport *port)
 		console_registered = NULL;
 	}
 #endif /* CONFIG_LP_CONSOLE */
+
+#ifdef CONFIG_PPS_CLIENT_LP
+	if (port->pps_source >= 0) {
+		pps_unregister_source(port->pps_source);
+		dev_dbg(port->dev, "PPS source #%d \"%s\" removed\n",
+			port->pps_source, port->pps_info.path);
+	}
+#endif
 }
 
 static struct parport_driver lp_driver = {
drivers/pps/clients/Kconfig +10 -0
index 517c338..09ba5c3 100644
@@ -25,4 +25,14 @@ config PPS_CLIENT_UART
 	  If you say yes here you get support for a PPS source connected
 	  with the CD (Carrier Detect) pin of your serial port.
 
+comment "Parallel printer support (forced off)"
+	depends on !( PRINTER != n && !(PPS = m && PRINTER = y))
+
+config PPS_CLIENT_LP
+	bool "Parallel printer support"
+	depends on PRINTER != n && !(PPS = m && PRINTER = y)
+	help
+	  If you say yes here you get support for a PPS source connected
+	  with the interrupt pin of your parallel port.
+
 endif
include/linux/parport.h +12 -0
index d1ad546..501a9dc 100644
@@ -100,6 +100,7 @@ typedef enum {
 #include <linux/proc_fs.h>
 #include <linux/spinlock.h>
 #include <linux/wait.h>
+#include <linux/pps.h>
 #include <linux/irqreturn.h>
 #include <asm/system.h>
 #include <asm/ptrace.h>
@@ -328,6 +329,11 @@ struct parport {
 
 	struct list_head full_list;
 	struct parport *slaves[3];
+
+#ifdef CONFIG_PPS_CLIENT_LP
+	struct pps_source_info pps_info;
+	int pps_source;		/* PPS source ID */
+#endif
 };
 
 #define DEFAULT_SPIN_TIME 500 /* us */
@@ -516,6 +522,12 @@ extern int parport_daisy_select (struct parport *port, int daisy, int mode);
 /* Lowlevel drivers _can_ call this support function to handle irqs.  */
 static inline void parport_generic_irq(struct parport *port)
 {
+#ifdef CONFIG_PPS_CLIENT_LP
+	pps_event(port->pps_source, PPS_CAPTUREASSERT, port);
+	dev_dbg(port->dev, "PPS assert at %lu on source #%d\n",
+		jiffies, port->pps_source);
+#endif
+
 	parport_ieee1284_interrupt (port);
 	read_lock(&port->cad_lock);
 	if (port->cad && port->cad->irq_func)
Signature · 1 line
1.5.2.5
#9 lore raw

Re: [PATCH 1/8] LinuxPPS core support.

In reply to Rodolfo Giometti

Hi Rodolfo.

Kconfig bits are trivial and looks OK.

drivers/pps/Makefile line 6

Quoted 12 lines
drivers/pps/Makefile new file +6 -0
new file mode 100644
index 0000000..5a9a51b
@@ -0,0 +1,10 @@
+#
+# Makefile for the PPS core.
+#
+
+pps_core-objs			+= pps.o kapi.o sysfs.o
+obj-$(CONFIG_PPS)		+= pps_core.o

Please use:
pps_core-y := pps.o kapi.o sysfs.o
obj-$(CONFIG_PPS) := pps_core.o

The change from '+=' to ':=' is purely cosmetic but I prefer this way to make it explicit that the variables contain no other values.

drivers/pps/Makefile line 10

Quoted 4 lines
drivers/pps/Makefile new file +4 -0
+
+ifeq ($(CONFIG_PPS_DEBUG),y)
+EXTRA_CFLAGS += -DDEBUG
+endif

And this we do so today:
ccflags-$(CONFIG_PPS_DEBUG) := -DDEBUG

I did not look at the code so do not consider it reviewed by this feedback.

Sam

#10 lore raw

Re: [PATCH 1/8] LinuxPPS core support.

In reply to Rodolfo Giometti
Quoted 19 lines · Rodolfo Giometti

This patch adds the kernel side of the PPS support currently named "LinuxPPS".

PPS means "pulse per second" and a PPS source is just a device which provides a high precision signal each second so that an application can use it to adjust system clock time.

Common use is the combination of the NTPD as userland program with a GPS receiver as PPS source to obtain a wallclock-time with sub-millisecond synchronisation to UTC.

To obtain this goal the userland programs shoud use the PPS API specification (RFC 2783 - Pulse-Per-Second API for UNIX-like Operating Systems, Version 1.0) which in part is implemented by this patch. It provides a set of chars devices, one per PPS source, which can be used to get the time signal. The RFC's functions can be implemented by accessing to these char devices.

Quoted 9 lines
---
 MAINTAINERS          |    7 +
 drivers/Kconfig      |    2 +
 drivers/Makefile     |    1 +
 drivers/pps/Kconfig  |   32 +++++
 drivers/pps/Makefile |   10 ++
 drivers/pps/kapi.c   |  272 +++++++++++++++++++++++++++++++++++++++
 drivers/pps/pps.c    |  342 ++++++++++++++++++++++++++++++++++++++++++++++++++
 drivers/pps/sysfs.c  |  142 +++++++++++++++++++++

As you are adding sysfs files, please also describe them in Documentation/ABI/ in this same series of patches.

Quoted 36 lines
drivers/pps/sysfs.c new file +36 -0
+void pps_sysfs_remove_source_entry(struct pps_device *pps)
+{
+	/* Delete info files */
+	if (pps->info.mode & PPS_CAPTUREASSERT)
+		device_remove_file(pps->dev, &dev_attr_assert);
+
+	if (pps->info.mode & PPS_CAPTURECLEAR)
+		device_remove_file(pps->dev, &dev_attr_clear);
+
+	device_remove_file(pps->dev, &dev_attr_mode);
+	device_remove_file(pps->dev, &dev_attr_echo);
+	device_remove_file(pps->dev, &dev_attr_name);
+	device_remove_file(pps->dev, &dev_attr_path);
+}
+
+int pps_sysfs_create_source_entry(struct pps_device *pps)
+{
+	int ret;
+
+	/* Create file "assert" and "clear" according to source capability */
+	if (pps->info.mode & PPS_CAPTUREASSERT) {
+		ret = device_create_file(pps->dev, &dev_attr_assert);
+		if (ret)
+			dev_err(pps->dev, "unable to create \"assert\" "
+					"sysfs entry");
+	}
+
+	if (pps->info.mode & PPS_CAPTURECLEAR) {
+		ret = device_create_file(pps->dev, &dev_attr_clear);
+		if (ret)
+			dev_err(pps->dev, "unable to create \"clear\" "
+					"sysfs entry");
+	}
+
+	ret = device_create_file(pps->dev, &dev_attr_mode);
+	if (ret)

drivers/pps/sysfs.c line 139

Quoted 10 lines
drivers/pps/sysfs.c new file +10 -0
+		dev_err(pps->dev, "unable to create \"mode\" sysfs entry");
+	ret = device_create_file(pps->dev, &dev_attr_echo);
+	if (ret)
+		dev_err(pps->dev, "unable to create \"echo\" sysfs entry");
+	ret = device_create_file(pps->dev, &dev_attr_name);
+	if (ret)
+		dev_err(pps->dev, "unable to create \"name\" sysfs entry");
+	ret = device_create_file(pps->dev, &dev_attr_path);
+	if (ret)
+		dev_err(pps->dev, "unable to create \"path\" sysfs entry");

Why not use a default attribute group?

That way the files are created before the uevent is issued, and the amount of code you have to write is much smaller.

thanks,

greg k-h

maintainer
#11 lore raw

Re: [PATCH 1/8] LinuxPPS core support.

Quoted 3 lines · Greg KH

As you are adding sysfs files, please also describe them in Documentation/ABI/ in this same series of patches.

Ok. I'm going to add them under "testing".

Quoted 4 lines

Why not use a default attribute group?

That way the files are created before the uevent is issued, and the amount of code you have to write is much smaller.

What do you mean exactly? I don't understand what you wish. :'(

Thanks,

Rodolfo

Signature · 4 lines
GNU/Linux Solutions                  e-mail:    [email protected]
Linux Device Driver                             [email protected]
Embedded Systems                     		[email protected]
UNIX programming                     phone:     +39 349 2432127
#12 lore raw

Re: [PATCH 1/8] LinuxPPS core support.

Quoted 5 lines · Rodolfo Giometti
Quoted 3 lines · Greg KH

As you are adding sysfs files, please also describe them in Documentation/ABI/ in this same series of patches.

Quoted 8 lines

Ok. I'm going to add them under "testing".

Quoted 4 lines

Why not use a default attribute group?

That way the files are created before the uevent is issued, and the amount of code you have to write is much smaller.

What do you mean exactly? I don't understand what you wish. :'(

If you use a 'struct device' you can use a default attribute group for that device to be created whenever it is added.

However you are not using the driver core that way, you are just calling device_create(), which doesn't work that way.

But you can just use an attribute group instead, which still saves you a lot of code, try using that instead (sysfs_create_group()).

Or go all the way and embed a 'struct device' in your structure, and create a bus, then you can use the default attribute group, although that might be a bit more work :)

thanks,

greg k-h

maintainer
#13 lore raw

Re: [PATCH 1/8] LinuxPPS core support.

Quoted 21 lines · Greg KH
Quoted 5 lines · Rodolfo Giometti
Quoted 3 lines · Greg KH

As you are adding sysfs files, please also describe them in Documentation/ABI/ in this same series of patches.

Quoted 8 lines

Ok. I'm going to add them under "testing".

Quoted 4 lines

Why not use a default attribute group?

That way the files are created before the uevent is issued, and the amount of code you have to write is much smaller.

What do you mean exactly? I don't understand what you wish. :'(

If you use a 'struct device' you can use a default attribute group for that device to be created whenever it is added.

However you are not using the driver core that way, you are just calling device_create(), which doesn't work that way.

Quoted 6 lines

But you can just use an attribute group instead, which still saves you a lot of code, try using that instead (sysfs_create_group()).

Or go all the way and embed a 'struct device' in your structure, and create a bus, then you can use the default attribute group, although that might be a bit more work :)

I see but how can I manage the fact that files "assert" and "clear" are created according to pps->info.mode field content?

See the code:

int pps_sysfs_create_source_entry(struct pps_device *pps)

{
        int ret;

        /* Create file "assert" and "clear" according to source capability */
        if (pps->info.mode & PPS_CAPTUREASSERT) {
                ret = device_create_file(pps->dev, &dev_attr_assert);
                if (ret)
                        dev_err(pps->dev, "unable to create \"assert\" "
                                        "sysfs entry");
        }

        if (pps->info.mode & PPS_CAPTURECLEAR) {
                ret = device_create_file(pps->dev, &dev_attr_clear);
                if (ret)
                        dev_err(pps->dev, "unable to create \"clear\" "
                                        "sysfs entry");
        }

        ret = device_create_file(pps->dev, &dev_attr_mode);
        if (ret)
                dev_err(pps->dev, "unable to create \"mode\" sysfs entry");

Do you think is better create these files anyway and in case report a NULL string?

Thanks,

Rodolfo

Signature · 4 lines
GNU/Linux Solutions                  e-mail:    [email protected]
Linux Device Driver                             [email protected]
Embedded Systems                     		[email protected]
UNIX programming                     phone:     +39 349 2432127
maintainer
#14 lore raw

Re: [PATCH 1/8] LinuxPPS core support.

Quoted 2 lines · Rodolfo Giometti

Do you think is better create these files anyway and in case report a NULL string?

Is that ok?

/*
* Attribute functions
*/

static ssize_t pps_show_assert(struct device *dev,
struct device_attribute *attr, char *buf)

{
	struct pps_device *pps = dev_get_drvdata(dev);

	if (!(pps->info.mode & PPS_CAPTUREASSERT))
		return 0;

	return sprintf(buf, "%lld.%09d#%d\n",
			pps->assert_tu.sec, pps->assert_tu.nsec,
			pps->assert_sequence);
}

DEVICE_ATTR(assert, S_IRUGO, pps_show_assert, NULL);

static ssize_t pps_show_clear(struct device *dev,
struct device_attribute *attr, char *buf)

{
	struct pps_device *pps = dev_get_drvdata(dev);

	if (!(pps->info.mode & PPS_CAPTURECLEAR))
		return 0;

	return sprintf(buf, "%lld.%09d#%d\n",
			pps->clear_tu.sec, pps->clear_tu.nsec,
			pps->clear_sequence);
}

DEVICE_ATTR(clear, S_IRUGO, pps_show_clear, NULL);

static ssize_t pps_show_mode(struct device *dev,
struct device_attribute *attr, char *buf)

{
	struct pps_device *pps = dev_get_drvdata(dev);

	return sprintf(buf, "%4x\n", pps->info.mode);
}

DEVICE_ATTR(mode, S_IRUGO, pps_show_mode, NULL);

...

static struct attribute *pps_attrs[] = {
&dev_attr_mode.attr,
&dev_attr_echo.attr,
&dev_attr_name.attr,
&dev_attr_path.attr,
&dev_attr_assert.attr,
&dev_attr_clear.attr,
NULL
};

static struct attribute_group pps_group = {
.attrs = pps_attrs,
};

/*
* Public functions
*/

void pps_sysfs_remove_source_entry(struct pps_device *pps)

{
	/* Delete info files */
	sysfs_remove_group(&pps->dev->kobj, &pps_group);
}

int pps_sysfs_create_source_entry(struct pps_device *pps)

{
	int ret;

	/* Create info files */
	ret = sysfs_create_group(&pps->dev->kobj, &pps_group);
	if (ret)
		dev_err(pps->dev, "unable to create default sysfs entries");

	return 0;
}

Ciao,

Rodolfo

Signature · 4 lines
GNU/Linux Solutions                  e-mail:    [email protected]
Linux Device Driver                             [email protected]
Embedded Systems                     		[email protected]
UNIX programming                     phone:     +39 349 2432127