]>
Commit | Line | Data |
---|---|---|
eae9d2ba RG |
1 | /* |
2 | * kernel API | |
3 | * | |
4 | * | |
5 | * Copyright (C) 2005-2009 Rodolfo Giometti <[email protected]> | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
20 | */ | |
21 | ||
7f7cce74 | 22 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
eae9d2ba RG |
23 | |
24 | #include <linux/kernel.h> | |
25 | #include <linux/module.h> | |
26 | #include <linux/init.h> | |
27 | #include <linux/sched.h> | |
28 | #include <linux/time.h> | |
717c0336 | 29 | #include <linux/timex.h> |
eae9d2ba | 30 | #include <linux/spinlock.h> |
eae9d2ba RG |
31 | #include <linux/fs.h> |
32 | #include <linux/pps_kernel.h> | |
5a0e3ad6 | 33 | #include <linux/slab.h> |
eae9d2ba | 34 | |
717c0336 AG |
35 | #include "kc.h" |
36 | ||
eae9d2ba RG |
37 | /* |
38 | * Local functions | |
39 | */ | |
40 | ||
41 | static void pps_add_offset(struct pps_ktime *ts, struct pps_ktime *offset) | |
42 | { | |
43 | ts->nsec += offset->nsec; | |
44 | while (ts->nsec >= NSEC_PER_SEC) { | |
45 | ts->nsec -= NSEC_PER_SEC; | |
46 | ts->sec++; | |
47 | } | |
48 | while (ts->nsec < 0) { | |
49 | ts->nsec += NSEC_PER_SEC; | |
50 | ts->sec--; | |
51 | } | |
52 | ts->sec += offset->sec; | |
53 | } | |
54 | ||
437c5341 JN |
55 | static void pps_echo_client_default(struct pps_device *pps, int event, |
56 | void *data) | |
57 | { | |
58 | dev_info(pps->dev, "echo %s %s\n", | |
59 | event & PPS_CAPTUREASSERT ? "assert" : "", | |
60 | event & PPS_CAPTURECLEAR ? "clear" : ""); | |
61 | } | |
62 | ||
eae9d2ba RG |
63 | /* |
64 | * Exported functions | |
65 | */ | |
66 | ||
eae9d2ba RG |
67 | /* pps_register_source - add a PPS source in the system |
68 | * @info: the PPS info struct | |
69 | * @default_params: the default PPS parameters of the new source | |
70 | * | |
71 | * This function is used to add a new PPS source in the system. The new | |
72 | * source is described by info's fields and it will have, as default PPS | |
73 | * parameters, the ones specified into default_params. | |
74 | * | |
5e196d34 | 75 | * The function returns, in case of success, the PPS device. Otherwise NULL. |
eae9d2ba RG |
76 | */ |
77 | ||
5e196d34 AG |
78 | struct pps_device *pps_register_source(struct pps_source_info *info, |
79 | int default_params) | |
eae9d2ba RG |
80 | { |
81 | struct pps_device *pps; | |
eae9d2ba RG |
82 | int err; |
83 | ||
84 | /* Sanity checks */ | |
85 | if ((info->mode & default_params) != default_params) { | |
7f7cce74 | 86 | pr_err("%s: unsupported default parameters\n", |
eae9d2ba RG |
87 | info->name); |
88 | err = -EINVAL; | |
89 | goto pps_register_source_exit; | |
90 | } | |
eae9d2ba | 91 | if ((info->mode & (PPS_TSFMT_TSPEC | PPS_TSFMT_NTPFP)) == 0) { |
7f7cce74 | 92 | pr_err("%s: unspecified time format\n", |
eae9d2ba RG |
93 | info->name); |
94 | err = -EINVAL; | |
95 | goto pps_register_source_exit; | |
96 | } | |
97 | ||
98 | /* Allocate memory for the new PPS source struct */ | |
99 | pps = kzalloc(sizeof(struct pps_device), GFP_KERNEL); | |
100 | if (pps == NULL) { | |
101 | err = -ENOMEM; | |
102 | goto pps_register_source_exit; | |
103 | } | |
104 | ||
19dd2da3 | 105 | /* These initializations must be done before calling idr_alloc() |
eae9d2ba RG |
106 | * in order to avoid reces into pps_event(). |
107 | */ | |
108 | pps->params.api_version = PPS_API_VERS; | |
109 | pps->params.mode = default_params; | |
110 | pps->info = *info; | |
111 | ||
437c5341 JN |
112 | /* check for default echo function */ |
113 | if ((pps->info.mode & (PPS_ECHOASSERT | PPS_ECHOCLEAR)) && | |
114 | pps->info.echo == NULL) | |
115 | pps->info.echo = pps_echo_client_default; | |
116 | ||
eae9d2ba RG |
117 | init_waitqueue_head(&pps->queue); |
118 | spin_lock_init(&pps->lock); | |
eae9d2ba | 119 | |
eae9d2ba RG |
120 | /* Create the char device */ |
121 | err = pps_register_cdev(pps); | |
122 | if (err < 0) { | |
7f7cce74 | 123 | pr_err("%s: unable to create char device\n", |
eae9d2ba | 124 | info->name); |
083e5866 | 125 | goto kfree_pps; |
eae9d2ba RG |
126 | } |
127 | ||
7f7cce74 | 128 | dev_info(pps->dev, "new PPS source %s\n", info->name); |
eae9d2ba | 129 | |
5e196d34 | 130 | return pps; |
eae9d2ba | 131 | |
eae9d2ba RG |
132 | kfree_pps: |
133 | kfree(pps); | |
134 | ||
135 | pps_register_source_exit: | |
7f7cce74 | 136 | pr_err("%s: unable to register source\n", info->name); |
eae9d2ba | 137 | |
5e196d34 | 138 | return NULL; |
eae9d2ba RG |
139 | } |
140 | EXPORT_SYMBOL(pps_register_source); | |
141 | ||
142 | /* pps_unregister_source - remove a PPS source from the system | |
5e196d34 | 143 | * @pps: the PPS source |
eae9d2ba RG |
144 | * |
145 | * This function is used to remove a previously registered PPS source from | |
146 | * the system. | |
147 | */ | |
148 | ||
5e196d34 | 149 | void pps_unregister_source(struct pps_device *pps) |
eae9d2ba | 150 | { |
717c0336 | 151 | pps_kc_remove(pps); |
5e196d34 | 152 | pps_unregister_cdev(pps); |
eae9d2ba | 153 | |
083e5866 AG |
154 | /* don't have to kfree(pps) here because it will be done on |
155 | * device destruction */ | |
eae9d2ba RG |
156 | } |
157 | EXPORT_SYMBOL(pps_unregister_source); | |
158 | ||
159 | /* pps_event - register a PPS event into the system | |
5e196d34 | 160 | * @pps: the PPS device |
eae9d2ba RG |
161 | * @ts: the event timestamp |
162 | * @event: the event type | |
163 | * @data: userdef pointer | |
164 | * | |
165 | * This function is used by each PPS client in order to register a new | |
166 | * PPS event into the system (it's usually called inside an IRQ handler). | |
167 | * | |
5e196d34 | 168 | * If an echo function is associated with the PPS device it will be called |
eae9d2ba | 169 | * as: |
5e196d34 | 170 | * pps->info.echo(pps, event, data); |
eae9d2ba | 171 | */ |
5e196d34 AG |
172 | void pps_event(struct pps_device *pps, struct pps_event_time *ts, int event, |
173 | void *data) | |
eae9d2ba | 174 | { |
eae9d2ba | 175 | unsigned long flags; |
276b282e | 176 | int captured = 0; |
99b0d365 | 177 | struct pps_ktime ts_real = { .sec = 0, .nsec = 0, .flags = 0 }; |
eae9d2ba | 178 | |
29f347c9 AG |
179 | /* check event type */ |
180 | BUG_ON((event & (PPS_CAPTUREASSERT | PPS_CAPTURECLEAR)) == 0); | |
eae9d2ba | 181 | |
ade1bdff AB |
182 | dev_dbg(pps->dev, "PPS event at %lld.%09ld\n", |
183 | (s64)ts->ts_real.tv_sec, ts->ts_real.tv_nsec); | |
6f4229b5 AG |
184 | |
185 | timespec_to_pps_ktime(&ts_real, ts->ts_real); | |
eae9d2ba RG |
186 | |
187 | spin_lock_irqsave(&pps->lock, flags); | |
188 | ||
189 | /* Must call the echo function? */ | |
190 | if ((pps->params.mode & (PPS_ECHOASSERT | PPS_ECHOCLEAR))) | |
5e196d34 | 191 | pps->info.echo(pps, event, data); |
eae9d2ba RG |
192 | |
193 | /* Check the event */ | |
194 | pps->current_mode = pps->params.mode; | |
818b9eef | 195 | if (event & pps->params.mode & PPS_CAPTUREASSERT) { |
eae9d2ba RG |
196 | /* We have to add an offset? */ |
197 | if (pps->params.mode & PPS_OFFSETASSERT) | |
6f4229b5 AG |
198 | pps_add_offset(&ts_real, |
199 | &pps->params.assert_off_tu); | |
eae9d2ba RG |
200 | |
201 | /* Save the time stamp */ | |
6f4229b5 | 202 | pps->assert_tu = ts_real; |
eae9d2ba | 203 | pps->assert_sequence++; |
5e196d34 AG |
204 | dev_dbg(pps->dev, "capture assert seq #%u\n", |
205 | pps->assert_sequence); | |
276b282e RG |
206 | |
207 | captured = ~0; | |
eae9d2ba | 208 | } |
818b9eef | 209 | if (event & pps->params.mode & PPS_CAPTURECLEAR) { |
eae9d2ba RG |
210 | /* We have to add an offset? */ |
211 | if (pps->params.mode & PPS_OFFSETCLEAR) | |
6f4229b5 AG |
212 | pps_add_offset(&ts_real, |
213 | &pps->params.clear_off_tu); | |
eae9d2ba RG |
214 | |
215 | /* Save the time stamp */ | |
6f4229b5 | 216 | pps->clear_tu = ts_real; |
eae9d2ba | 217 | pps->clear_sequence++; |
5e196d34 AG |
218 | dev_dbg(pps->dev, "capture clear seq #%u\n", |
219 | pps->clear_sequence); | |
276b282e RG |
220 | |
221 | captured = ~0; | |
eae9d2ba RG |
222 | } |
223 | ||
717c0336 AG |
224 | pps_kc_event(pps, ts, event); |
225 | ||
7a21a3cc | 226 | /* Wake up if captured something */ |
276b282e | 227 | if (captured) { |
3003d55b AG |
228 | pps->last_ev++; |
229 | wake_up_interruptible_all(&pps->queue); | |
eae9d2ba | 230 | |
276b282e RG |
231 | kill_fasync(&pps->async_queue, SIGIO, POLL_IN); |
232 | } | |
eae9d2ba RG |
233 | |
234 | spin_unlock_irqrestore(&pps->lock, flags); | |
eae9d2ba RG |
235 | } |
236 | EXPORT_SYMBOL(pps_event); |