Linux Audio

Check our new training course

Real-Time Linux with PREEMPT_RT training

Feb 18-20, 2025
Register
Loading...
v5.4
  1// SPDX-License-Identifier: GPL-2.0+
  2/*
  3 * Support for dynamic clock devices
  4 *
  5 * Copyright (C) 2010 OMICRON electronics GmbH
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  6 */
  7#include <linux/device.h>
  8#include <linux/export.h>
  9#include <linux/file.h>
 10#include <linux/posix-clock.h>
 11#include <linux/slab.h>
 12#include <linux/syscalls.h>
 13#include <linux/uaccess.h>
 14
 15#include "posix-timers.h"
 16
 17static void delete_clock(struct kref *kref);
 18
 19/*
 20 * Returns NULL if the posix_clock instance attached to 'fp' is old and stale.
 21 */
 22static struct posix_clock *get_posix_clock(struct file *fp)
 23{
 24	struct posix_clock *clk = fp->private_data;
 25
 26	down_read(&clk->rwsem);
 27
 28	if (!clk->zombie)
 29		return clk;
 30
 31	up_read(&clk->rwsem);
 32
 33	return NULL;
 34}
 35
 36static void put_posix_clock(struct posix_clock *clk)
 37{
 38	up_read(&clk->rwsem);
 39}
 40
 41static ssize_t posix_clock_read(struct file *fp, char __user *buf,
 42				size_t count, loff_t *ppos)
 43{
 44	struct posix_clock *clk = get_posix_clock(fp);
 45	int err = -EINVAL;
 46
 47	if (!clk)
 48		return -ENODEV;
 49
 50	if (clk->ops.read)
 51		err = clk->ops.read(clk, fp->f_flags, buf, count);
 52
 53	put_posix_clock(clk);
 54
 55	return err;
 56}
 57
 58static __poll_t posix_clock_poll(struct file *fp, poll_table *wait)
 59{
 60	struct posix_clock *clk = get_posix_clock(fp);
 61	__poll_t result = 0;
 62
 63	if (!clk)
 64		return EPOLLERR;
 65
 66	if (clk->ops.poll)
 67		result = clk->ops.poll(clk, fp, wait);
 68
 69	put_posix_clock(clk);
 70
 71	return result;
 72}
 73
 74static long posix_clock_ioctl(struct file *fp,
 75			      unsigned int cmd, unsigned long arg)
 76{
 77	struct posix_clock *clk = get_posix_clock(fp);
 78	int err = -ENOTTY;
 79
 80	if (!clk)
 81		return -ENODEV;
 82
 83	if (clk->ops.ioctl)
 84		err = clk->ops.ioctl(clk, cmd, arg);
 85
 86	put_posix_clock(clk);
 87
 88	return err;
 89}
 90
 91#ifdef CONFIG_COMPAT
 92static long posix_clock_compat_ioctl(struct file *fp,
 93				     unsigned int cmd, unsigned long arg)
 94{
 95	struct posix_clock *clk = get_posix_clock(fp);
 96	int err = -ENOTTY;
 97
 98	if (!clk)
 99		return -ENODEV;
100
101	if (clk->ops.ioctl)
102		err = clk->ops.ioctl(clk, cmd, arg);
103
104	put_posix_clock(clk);
105
106	return err;
107}
108#endif
109
110static int posix_clock_open(struct inode *inode, struct file *fp)
111{
112	int err;
113	struct posix_clock *clk =
114		container_of(inode->i_cdev, struct posix_clock, cdev);
115
116	down_read(&clk->rwsem);
117
118	if (clk->zombie) {
119		err = -ENODEV;
120		goto out;
121	}
122	if (clk->ops.open)
123		err = clk->ops.open(clk, fp->f_mode);
124	else
125		err = 0;
126
127	if (!err) {
128		kref_get(&clk->kref);
129		fp->private_data = clk;
130	}
131out:
132	up_read(&clk->rwsem);
133	return err;
134}
135
136static int posix_clock_release(struct inode *inode, struct file *fp)
137{
138	struct posix_clock *clk = fp->private_data;
139	int err = 0;
140
141	if (clk->ops.release)
142		err = clk->ops.release(clk);
143
144	kref_put(&clk->kref, delete_clock);
145
146	fp->private_data = NULL;
147
148	return err;
149}
150
151static const struct file_operations posix_clock_file_operations = {
152	.owner		= THIS_MODULE,
153	.llseek		= no_llseek,
154	.read		= posix_clock_read,
155	.poll		= posix_clock_poll,
156	.unlocked_ioctl	= posix_clock_ioctl,
157	.open		= posix_clock_open,
158	.release	= posix_clock_release,
159#ifdef CONFIG_COMPAT
160	.compat_ioctl	= posix_clock_compat_ioctl,
161#endif
162};
163
164int posix_clock_register(struct posix_clock *clk, dev_t devid)
165{
166	int err;
167
168	kref_init(&clk->kref);
169	init_rwsem(&clk->rwsem);
170
171	cdev_init(&clk->cdev, &posix_clock_file_operations);
172	clk->cdev.owner = clk->ops.owner;
173	err = cdev_add(&clk->cdev, devid, 1);
174
175	return err;
176}
177EXPORT_SYMBOL_GPL(posix_clock_register);
178
179static void delete_clock(struct kref *kref)
180{
181	struct posix_clock *clk = container_of(kref, struct posix_clock, kref);
182
183	if (clk->release)
184		clk->release(clk);
185}
186
187void posix_clock_unregister(struct posix_clock *clk)
188{
189	cdev_del(&clk->cdev);
190
191	down_write(&clk->rwsem);
192	clk->zombie = true;
193	up_write(&clk->rwsem);
194
195	kref_put(&clk->kref, delete_clock);
196}
197EXPORT_SYMBOL_GPL(posix_clock_unregister);
198
199struct posix_clock_desc {
200	struct file *fp;
201	struct posix_clock *clk;
202};
203
204static int get_clock_desc(const clockid_t id, struct posix_clock_desc *cd)
205{
206	struct file *fp = fget(clockid_to_fd(id));
207	int err = -EINVAL;
208
209	if (!fp)
210		return err;
211
212	if (fp->f_op->open != posix_clock_open || !fp->private_data)
213		goto out;
214
215	cd->fp = fp;
216	cd->clk = get_posix_clock(fp);
217
218	err = cd->clk ? 0 : -ENODEV;
219out:
220	if (err)
221		fput(fp);
222	return err;
223}
224
225static void put_clock_desc(struct posix_clock_desc *cd)
226{
227	put_posix_clock(cd->clk);
228	fput(cd->fp);
229}
230
231static int pc_clock_adjtime(clockid_t id, struct __kernel_timex *tx)
232{
233	struct posix_clock_desc cd;
234	int err;
235
236	err = get_clock_desc(id, &cd);
237	if (err)
238		return err;
239
240	if ((cd.fp->f_mode & FMODE_WRITE) == 0) {
241		err = -EACCES;
242		goto out;
243	}
244
245	if (cd.clk->ops.clock_adjtime)
246		err = cd.clk->ops.clock_adjtime(cd.clk, tx);
247	else
248		err = -EOPNOTSUPP;
249out:
250	put_clock_desc(&cd);
251
252	return err;
253}
254
255static int pc_clock_gettime(clockid_t id, struct timespec64 *ts)
256{
257	struct posix_clock_desc cd;
258	int err;
259
260	err = get_clock_desc(id, &cd);
261	if (err)
262		return err;
263
264	if (cd.clk->ops.clock_gettime)
265		err = cd.clk->ops.clock_gettime(cd.clk, ts);
266	else
267		err = -EOPNOTSUPP;
268
269	put_clock_desc(&cd);
270
271	return err;
272}
273
274static int pc_clock_getres(clockid_t id, struct timespec64 *ts)
275{
276	struct posix_clock_desc cd;
277	int err;
278
279	err = get_clock_desc(id, &cd);
280	if (err)
281		return err;
282
283	if (cd.clk->ops.clock_getres)
284		err = cd.clk->ops.clock_getres(cd.clk, ts);
285	else
286		err = -EOPNOTSUPP;
287
288	put_clock_desc(&cd);
289
290	return err;
291}
292
293static int pc_clock_settime(clockid_t id, const struct timespec64 *ts)
294{
295	struct posix_clock_desc cd;
296	int err;
297
298	err = get_clock_desc(id, &cd);
299	if (err)
300		return err;
301
302	if ((cd.fp->f_mode & FMODE_WRITE) == 0) {
303		err = -EACCES;
304		goto out;
305	}
306
307	if (cd.clk->ops.clock_settime)
308		err = cd.clk->ops.clock_settime(cd.clk, ts);
309	else
310		err = -EOPNOTSUPP;
311out:
312	put_clock_desc(&cd);
313
314	return err;
315}
316
317const struct k_clock clock_posix_dynamic = {
318	.clock_getres	= pc_clock_getres,
319	.clock_set	= pc_clock_settime,
320	.clock_get	= pc_clock_gettime,
321	.clock_adj	= pc_clock_adjtime,
322};
v4.17
 
  1/*
  2 * posix-clock.c - support for dynamic clock devices
  3 *
  4 * Copyright (C) 2010 OMICRON electronics GmbH
  5 *
  6 *  This program is free software; you can redistribute it and/or modify
  7 *  it under the terms of the GNU General Public License as published by
  8 *  the Free Software Foundation; either version 2 of the License, or
  9 *  (at your option) any later version.
 10 *
 11 *  This program is distributed in the hope that it will be useful,
 12 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 13 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 14 *  GNU General Public License for more details.
 15 *
 16 *  You should have received a copy of the GNU General Public License
 17 *  along with this program; if not, write to the Free Software
 18 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 19 */
 20#include <linux/device.h>
 21#include <linux/export.h>
 22#include <linux/file.h>
 23#include <linux/posix-clock.h>
 24#include <linux/slab.h>
 25#include <linux/syscalls.h>
 26#include <linux/uaccess.h>
 27
 28#include "posix-timers.h"
 29
 30static void delete_clock(struct kref *kref);
 31
 32/*
 33 * Returns NULL if the posix_clock instance attached to 'fp' is old and stale.
 34 */
 35static struct posix_clock *get_posix_clock(struct file *fp)
 36{
 37	struct posix_clock *clk = fp->private_data;
 38
 39	down_read(&clk->rwsem);
 40
 41	if (!clk->zombie)
 42		return clk;
 43
 44	up_read(&clk->rwsem);
 45
 46	return NULL;
 47}
 48
 49static void put_posix_clock(struct posix_clock *clk)
 50{
 51	up_read(&clk->rwsem);
 52}
 53
 54static ssize_t posix_clock_read(struct file *fp, char __user *buf,
 55				size_t count, loff_t *ppos)
 56{
 57	struct posix_clock *clk = get_posix_clock(fp);
 58	int err = -EINVAL;
 59
 60	if (!clk)
 61		return -ENODEV;
 62
 63	if (clk->ops.read)
 64		err = clk->ops.read(clk, fp->f_flags, buf, count);
 65
 66	put_posix_clock(clk);
 67
 68	return err;
 69}
 70
 71static __poll_t posix_clock_poll(struct file *fp, poll_table *wait)
 72{
 73	struct posix_clock *clk = get_posix_clock(fp);
 74	__poll_t result = 0;
 75
 76	if (!clk)
 77		return EPOLLERR;
 78
 79	if (clk->ops.poll)
 80		result = clk->ops.poll(clk, fp, wait);
 81
 82	put_posix_clock(clk);
 83
 84	return result;
 85}
 86
 87static long posix_clock_ioctl(struct file *fp,
 88			      unsigned int cmd, unsigned long arg)
 89{
 90	struct posix_clock *clk = get_posix_clock(fp);
 91	int err = -ENOTTY;
 92
 93	if (!clk)
 94		return -ENODEV;
 95
 96	if (clk->ops.ioctl)
 97		err = clk->ops.ioctl(clk, cmd, arg);
 98
 99	put_posix_clock(clk);
100
101	return err;
102}
103
104#ifdef CONFIG_COMPAT
105static long posix_clock_compat_ioctl(struct file *fp,
106				     unsigned int cmd, unsigned long arg)
107{
108	struct posix_clock *clk = get_posix_clock(fp);
109	int err = -ENOTTY;
110
111	if (!clk)
112		return -ENODEV;
113
114	if (clk->ops.ioctl)
115		err = clk->ops.ioctl(clk, cmd, arg);
116
117	put_posix_clock(clk);
118
119	return err;
120}
121#endif
122
123static int posix_clock_open(struct inode *inode, struct file *fp)
124{
125	int err;
126	struct posix_clock *clk =
127		container_of(inode->i_cdev, struct posix_clock, cdev);
128
129	down_read(&clk->rwsem);
130
131	if (clk->zombie) {
132		err = -ENODEV;
133		goto out;
134	}
135	if (clk->ops.open)
136		err = clk->ops.open(clk, fp->f_mode);
137	else
138		err = 0;
139
140	if (!err) {
141		kref_get(&clk->kref);
142		fp->private_data = clk;
143	}
144out:
145	up_read(&clk->rwsem);
146	return err;
147}
148
149static int posix_clock_release(struct inode *inode, struct file *fp)
150{
151	struct posix_clock *clk = fp->private_data;
152	int err = 0;
153
154	if (clk->ops.release)
155		err = clk->ops.release(clk);
156
157	kref_put(&clk->kref, delete_clock);
158
159	fp->private_data = NULL;
160
161	return err;
162}
163
164static const struct file_operations posix_clock_file_operations = {
165	.owner		= THIS_MODULE,
166	.llseek		= no_llseek,
167	.read		= posix_clock_read,
168	.poll		= posix_clock_poll,
169	.unlocked_ioctl	= posix_clock_ioctl,
170	.open		= posix_clock_open,
171	.release	= posix_clock_release,
172#ifdef CONFIG_COMPAT
173	.compat_ioctl	= posix_clock_compat_ioctl,
174#endif
175};
176
177int posix_clock_register(struct posix_clock *clk, dev_t devid)
178{
179	int err;
180
181	kref_init(&clk->kref);
182	init_rwsem(&clk->rwsem);
183
184	cdev_init(&clk->cdev, &posix_clock_file_operations);
185	clk->cdev.owner = clk->ops.owner;
186	err = cdev_add(&clk->cdev, devid, 1);
187
188	return err;
189}
190EXPORT_SYMBOL_GPL(posix_clock_register);
191
192static void delete_clock(struct kref *kref)
193{
194	struct posix_clock *clk = container_of(kref, struct posix_clock, kref);
195
196	if (clk->release)
197		clk->release(clk);
198}
199
200void posix_clock_unregister(struct posix_clock *clk)
201{
202	cdev_del(&clk->cdev);
203
204	down_write(&clk->rwsem);
205	clk->zombie = true;
206	up_write(&clk->rwsem);
207
208	kref_put(&clk->kref, delete_clock);
209}
210EXPORT_SYMBOL_GPL(posix_clock_unregister);
211
212struct posix_clock_desc {
213	struct file *fp;
214	struct posix_clock *clk;
215};
216
217static int get_clock_desc(const clockid_t id, struct posix_clock_desc *cd)
218{
219	struct file *fp = fget(clockid_to_fd(id));
220	int err = -EINVAL;
221
222	if (!fp)
223		return err;
224
225	if (fp->f_op->open != posix_clock_open || !fp->private_data)
226		goto out;
227
228	cd->fp = fp;
229	cd->clk = get_posix_clock(fp);
230
231	err = cd->clk ? 0 : -ENODEV;
232out:
233	if (err)
234		fput(fp);
235	return err;
236}
237
238static void put_clock_desc(struct posix_clock_desc *cd)
239{
240	put_posix_clock(cd->clk);
241	fput(cd->fp);
242}
243
244static int pc_clock_adjtime(clockid_t id, struct timex *tx)
245{
246	struct posix_clock_desc cd;
247	int err;
248
249	err = get_clock_desc(id, &cd);
250	if (err)
251		return err;
252
253	if ((cd.fp->f_mode & FMODE_WRITE) == 0) {
254		err = -EACCES;
255		goto out;
256	}
257
258	if (cd.clk->ops.clock_adjtime)
259		err = cd.clk->ops.clock_adjtime(cd.clk, tx);
260	else
261		err = -EOPNOTSUPP;
262out:
263	put_clock_desc(&cd);
264
265	return err;
266}
267
268static int pc_clock_gettime(clockid_t id, struct timespec64 *ts)
269{
270	struct posix_clock_desc cd;
271	int err;
272
273	err = get_clock_desc(id, &cd);
274	if (err)
275		return err;
276
277	if (cd.clk->ops.clock_gettime)
278		err = cd.clk->ops.clock_gettime(cd.clk, ts);
279	else
280		err = -EOPNOTSUPP;
281
282	put_clock_desc(&cd);
283
284	return err;
285}
286
287static int pc_clock_getres(clockid_t id, struct timespec64 *ts)
288{
289	struct posix_clock_desc cd;
290	int err;
291
292	err = get_clock_desc(id, &cd);
293	if (err)
294		return err;
295
296	if (cd.clk->ops.clock_getres)
297		err = cd.clk->ops.clock_getres(cd.clk, ts);
298	else
299		err = -EOPNOTSUPP;
300
301	put_clock_desc(&cd);
302
303	return err;
304}
305
306static int pc_clock_settime(clockid_t id, const struct timespec64 *ts)
307{
308	struct posix_clock_desc cd;
309	int err;
310
311	err = get_clock_desc(id, &cd);
312	if (err)
313		return err;
314
315	if ((cd.fp->f_mode & FMODE_WRITE) == 0) {
316		err = -EACCES;
317		goto out;
318	}
319
320	if (cd.clk->ops.clock_settime)
321		err = cd.clk->ops.clock_settime(cd.clk, ts);
322	else
323		err = -EOPNOTSUPP;
324out:
325	put_clock_desc(&cd);
326
327	return err;
328}
329
330const struct k_clock clock_posix_dynamic = {
331	.clock_getres	= pc_clock_getres,
332	.clock_set	= pc_clock_settime,
333	.clock_get	= pc_clock_gettime,
334	.clock_adj	= pc_clock_adjtime,
335};