blob: f197e8ea185c4099abc1289cd1b6cf74947f3bed [file] [log] [blame]
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -07001/*
2 * kernel API
3 *
4 *
5 * Copyright (C) 2005-2009 Rodolfo Giometti <giometti@linux.it>
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
Alexander Gordeev7f7cce72011-01-12 17:00:52 -080022#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070023
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>
Alexander Gordeev717c0332011-01-12 17:00:58 -080029#include <linux/timex.h>
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070030#include <linux/spinlock.h>
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070031#include <linux/fs.h>
32#include <linux/pps_kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090033#include <linux/slab.h>
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070034
Alexander Gordeev717c0332011-01-12 17:00:58 -080035#include "kc.h"
36
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070037/*
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070038 * Local functions
39 */
40
41static 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
James Nuss437c5342011-11-02 13:39:34 -070055static 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
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070063/*
64 * Exported functions
65 */
66
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070067/* 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 *
Alexander Gordeev5e196d32011-01-12 17:00:51 -080075 * The function returns, in case of success, the PPS device. Otherwise NULL.
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070076 */
77
Alexander Gordeev5e196d32011-01-12 17:00:51 -080078struct pps_device *pps_register_source(struct pps_source_info *info,
79 int default_params)
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070080{
81 struct pps_device *pps;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070082 int err;
83
84 /* Sanity checks */
85 if ((info->mode & default_params) != default_params) {
Alexander Gordeev7f7cce72011-01-12 17:00:52 -080086 pr_err("%s: unsupported default parameters\n",
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070087 info->name);
88 err = -EINVAL;
89 goto pps_register_source_exit;
90 }
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070091 if ((info->mode & (PPS_TSFMT_TSPEC | PPS_TSFMT_NTPFP)) == 0) {
Alexander Gordeev7f7cce72011-01-12 17:00:52 -080092 pr_err("%s: unspecified time format\n",
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -070093 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
105 /* These initializations must be done before calling idr_get_new()
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
James Nuss437c5342011-11-02 13:39:34 -0700112 /* 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
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700117 init_waitqueue_head(&pps->queue);
118 spin_lock_init(&pps->lock);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700119
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700120 /* Create the char device */
121 err = pps_register_cdev(pps);
122 if (err < 0) {
Alexander Gordeev7f7cce72011-01-12 17:00:52 -0800123 pr_err("%s: unable to create char device\n",
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700124 info->name);
Alexander Gordeev083e5862011-01-12 17:00:53 -0800125 goto kfree_pps;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700126 }
127
Alexander Gordeev7f7cce72011-01-12 17:00:52 -0800128 dev_info(pps->dev, "new PPS source %s\n", info->name);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700129
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800130 return pps;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700131
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700132kfree_pps:
133 kfree(pps);
134
135pps_register_source_exit:
Alexander Gordeev7f7cce72011-01-12 17:00:52 -0800136 pr_err("%s: unable to register source\n", info->name);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700137
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800138 return NULL;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700139}
140EXPORT_SYMBOL(pps_register_source);
141
142/* pps_unregister_source - remove a PPS source from the system
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800143 * @pps: the PPS source
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700144 *
145 * This function is used to remove a previously registered PPS source from
146 * the system.
147 */
148
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800149void pps_unregister_source(struct pps_device *pps)
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700150{
Alexander Gordeev717c0332011-01-12 17:00:58 -0800151 pps_kc_remove(pps);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700152 pps_unregister_cdev(pps);
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800153
Alexander Gordeev083e5862011-01-12 17:00:53 -0800154 /* don't have to kfree(pps) here because it will be done on
155 * device destruction */
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700156}
157EXPORT_SYMBOL(pps_unregister_source);
158
159/* pps_event - register a PPS event into the system
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800160 * @pps: the PPS device
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700161 * @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 *
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800168 * If an echo function is associated with the PPS device it will be called
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700169 * as:
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800170 * pps->info.echo(pps, event, data);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700171 */
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800172void pps_event(struct pps_device *pps, struct pps_event_time *ts, int event,
173 void *data)
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700174{
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700175 unsigned long flags;
Rodolfo Giometti276b2822009-11-11 14:26:54 -0800176 int captured = 0;
Alexander Gordeev99b0d362011-02-25 14:44:30 -0800177 struct pps_ktime ts_real = { .sec = 0, .nsec = 0, .flags = 0 };
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700178
Alexander Gordeev29f347c2011-01-12 17:00:54 -0800179 /* check event type */
180 BUG_ON((event & (PPS_CAPTUREASSERT | PPS_CAPTURECLEAR)) == 0);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700181
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800182 dev_dbg(pps->dev, "PPS event at %ld.%09ld\n",
183 ts->ts_real.tv_sec, ts->ts_real.tv_nsec);
Alexander Gordeev6f4229b2011-01-12 17:00:50 -0800184
185 timespec_to_pps_ktime(&ts_real, ts->ts_real);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700186
187 spin_lock_irqsave(&pps->lock, flags);
188
189 /* Must call the echo function? */
190 if ((pps->params.mode & (PPS_ECHOASSERT | PPS_ECHOCLEAR)))
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800191 pps->info.echo(pps, event, data);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700192
193 /* Check the event */
194 pps->current_mode = pps->params.mode;
Alexander Gordeev818b9ee2011-01-12 17:00:54 -0800195 if (event & pps->params.mode & PPS_CAPTUREASSERT) {
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700196 /* We have to add an offset? */
197 if (pps->params.mode & PPS_OFFSETASSERT)
Alexander Gordeev6f4229b2011-01-12 17:00:50 -0800198 pps_add_offset(&ts_real,
199 &pps->params.assert_off_tu);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700200
201 /* Save the time stamp */
Alexander Gordeev6f4229b2011-01-12 17:00:50 -0800202 pps->assert_tu = ts_real;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700203 pps->assert_sequence++;
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800204 dev_dbg(pps->dev, "capture assert seq #%u\n",
205 pps->assert_sequence);
Rodolfo Giometti276b2822009-11-11 14:26:54 -0800206
207 captured = ~0;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700208 }
Alexander Gordeev818b9ee2011-01-12 17:00:54 -0800209 if (event & pps->params.mode & PPS_CAPTURECLEAR) {
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700210 /* We have to add an offset? */
211 if (pps->params.mode & PPS_OFFSETCLEAR)
Alexander Gordeev6f4229b2011-01-12 17:00:50 -0800212 pps_add_offset(&ts_real,
213 &pps->params.clear_off_tu);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700214
215 /* Save the time stamp */
Alexander Gordeev6f4229b2011-01-12 17:00:50 -0800216 pps->clear_tu = ts_real;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700217 pps->clear_sequence++;
Alexander Gordeev5e196d32011-01-12 17:00:51 -0800218 dev_dbg(pps->dev, "capture clear seq #%u\n",
219 pps->clear_sequence);
Rodolfo Giometti276b2822009-11-11 14:26:54 -0800220
221 captured = ~0;
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700222 }
223
Alexander Gordeev717c0332011-01-12 17:00:58 -0800224 pps_kc_event(pps, ts, event);
225
Alexander Gordeev7a21a3c2011-01-12 17:00:49 -0800226 /* Wake up if captured something */
Rodolfo Giometti276b2822009-11-11 14:26:54 -0800227 if (captured) {
Alexander Gordeev3003d552011-01-12 17:00:50 -0800228 pps->last_ev++;
229 wake_up_interruptible_all(&pps->queue);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700230
Rodolfo Giometti276b2822009-11-11 14:26:54 -0800231 kill_fasync(&pps->async_queue, SIGIO, POLL_IN);
232 }
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700233
234 spin_unlock_irqrestore(&pps->lock, flags);
Rodolfo Giomettieae9d2b2009-06-17 16:28:37 -0700235}
236EXPORT_SYMBOL(pps_event);