LinuxPPS: core support
[linux-2.6.git] / Documentation / ABI / testing / sysfs-pps
1 What:           /sys/class/pps/
2 Date:           February 2008
3 Contact:        Rodolfo Giometti <giometti@linux.it>
4 Description:
5                 The /sys/class/pps/ directory will contain files and
6                 directories that will provide a unified interface to
7                 the PPS sources.
8
9 What:           /sys/class/pps/ppsX/
10 Date:           February 2008
11 Contact:        Rodolfo Giometti <giometti@linux.it>
12 Description:
13                 The /sys/class/pps/ppsX/ directory is related to X-th
14                 PPS source into the system. Each directory will
15                 contain files to manage and control its PPS source.
16
17 What:           /sys/class/pps/ppsX/assert
18 Date:           February 2008
19 Contact:        Rodolfo Giometti <giometti@linux.it>
20 Description:
21                 The /sys/class/pps/ppsX/assert file reports the assert events
22                 and the assert sequence number of the X-th source in the form:
23
24                         <secs>.<nsec>#<sequence>
25
26                 If the source has no assert events the content of this file
27                 is empty.
28
29 What:           /sys/class/pps/ppsX/clear
30 Date:           February 2008
31 Contact:        Rodolfo Giometti <giometti@linux.it>
32 Description:
33                 The /sys/class/pps/ppsX/clear file reports the clear events
34                 and the clear sequence number of the X-th source in the form:
35
36                         <secs>.<nsec>#<sequence>
37
38                 If the source has no clear events the content of this file
39                 is empty.
40
41 What:           /sys/class/pps/ppsX/mode
42 Date:           February 2008
43 Contact:        Rodolfo Giometti <giometti@linux.it>
44 Description:
45                 The /sys/class/pps/ppsX/mode file reports the functioning
46                 mode of the X-th source in hexadecimal encoding.
47
48                 Please, refer to linux/include/linux/pps.h for further
49                 info.
50
51 What:           /sys/class/pps/ppsX/echo
52 Date:           February 2008
53 Contact:        Rodolfo Giometti <giometti@linux.it>
54 Description:
55                 The /sys/class/pps/ppsX/echo file reports if the X-th does
56                 or does not support an "echo" function.
57
58 What:           /sys/class/pps/ppsX/name
59 Date:           February 2008
60 Contact:        Rodolfo Giometti <giometti@linux.it>
61 Description:
62                 The /sys/class/pps/ppsX/name file reports the name of the
63                 X-th source.
64
65 What:           /sys/class/pps/ppsX/path
66 Date:           February 2008
67 Contact:        Rodolfo Giometti <giometti@linux.it>
68 Description:
69                 The /sys/class/pps/ppsX/path file reports the path name of
70                 the device connected with the X-th source.
71
72                 If the source is not connected with any device the content
73                 of this file is empty.