[linux-2.6-block.git] / drivers / ptp / ptp_clock.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * PTP 1588 clock support
 *
 * Copyright (C) 2010 OMICRON electronics GmbH
 */
#include <linux/idr.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/posix-clock.h>
#include <linux/pps_kernel.h>
#include <linux/slab.h>
#include <linux/syscalls.h>
#include <linux/uaccess.h>
#include <uapi/linux/sched/types.h>

#include "ptp_private.h"

#define PTP_MAX_ALARMS 4
#define PTP_PPS_DEFAULTS (PPS_CAPTUREASSERT | PPS_OFFSETASSERT)
#define PTP_PPS_EVENT PPS_CAPTUREASSERT
#define PTP_PPS_MODE (PTP_PPS_DEFAULTS | PPS_CANWAIT | PPS_TSFMT_TSPEC)

/* private globals */

static dev_t ptp_devt;
static struct class *ptp_class;

static DEFINE_IDA(ptp_clocks_map);

/* time stamp event queue operations */

static inline int queue_free(struct timestamp_event_queue *q)
{
	return PTP_MAX_TIMESTAMPS - queue_cnt(q) - 1;
}

static void enqueue_external_timestamp(struct timestamp_event_queue *queue,
				       struct ptp_clock_event *src)
{
	struct ptp_extts_event *dst;
	unsigned long flags;
	s64 seconds;
	u32 remainder;

	seconds = div_u64_rem(src->timestamp, 1000000000, &remainder);

	spin_lock_irqsave(&queue->lock, flags);

	dst = &queue->buf[queue->tail];
	dst->index = src->index;
	dst->t.sec = seconds;
	dst->t.nsec = remainder;

	if (!queue_free(queue))
		queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;

	queue->tail = (queue->tail + 1) % PTP_MAX_TIMESTAMPS;

	spin_unlock_irqrestore(&queue->lock, flags);
}

static s32 scaled_ppm_to_ppb(long ppm)
{
	/*
	 * The 'freq' field in the 'struct timex' is in parts per
	 * million, but with a 16 bit binary fractional field.
	 *
	 * We want to calculate
	 *
	 *    ppb = scaled_ppm * 1000 / 2^16
	 *
	 * which simplifies to
	 *
	 *    ppb = scaled_ppm * 125 / 2^13
	 */
	s64 ppb = 1 + ppm;
	ppb *= 125;
	ppb >>= 13;
	return (s32) ppb;
}

/* posix clock implementation */

static int ptp_clock_getres(struct posix_clock *pc, struct timespec64 *tp)
{
	tp->tv_sec = 0;
	tp->tv_nsec = 1;
	return 0;
}

static int ptp_clock_settime(struct posix_clock *pc, const struct timespec64 *tp)
{
	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);

	return  ptp->info->settime64(ptp->info, tp);
}

static int ptp_clock_gettime(struct posix_clock *pc, struct timespec64 *tp)
{
	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
	int err;

	if (ptp->info->gettimex64)
		err = ptp->info->gettimex64(ptp->info, tp, NULL);
	else
		err = ptp->info->gettime64(ptp->info, tp);
	return err;
}

static int ptp_clock_adjtime(struct posix_clock *pc, struct __kernel_timex *tx)
{
	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
	struct ptp_clock_info *ops;
	int err = -EOPNOTSUPP;

	ops = ptp->info;

	if (tx->modes & ADJ_SETOFFSET) {
		struct timespec64 ts;
		ktime_t kt;
		s64 delta;

		ts.tv_sec  = tx->time.tv_sec;
		ts.tv_nsec = tx->time.tv_usec;

		if (!(tx->modes & ADJ_NANO))
			ts.tv_nsec *= 1000;

		if ((unsigned long) ts.tv_nsec >= NSEC_PER_SEC)
			return -EINVAL;

		kt = timespec64_to_ktime(ts);
		delta = ktime_to_ns(kt);
		err = ops->adjtime(ops, delta);
	} else if (tx->modes & ADJ_FREQUENCY) {
		s32 ppb = scaled_ppm_to_ppb(tx->freq);
		if (ppb > ops->max_adj || ppb < -ops->max_adj)
			return -ERANGE;
		if (ops->adjfine)
			err = ops->adjfine(ops, tx->freq);
		else
			err = ops->adjfreq(ops, ppb);
		ptp->dialed_frequency = tx->freq;
	} else if (tx->modes == 0) {
		tx->freq = ptp->dialed_frequency;
		err = 0;
	}

	return err;
}

static struct posix_clock_operations ptp_clock_ops = {
	.owner		= THIS_MODULE,
	.clock_adjtime	= ptp_clock_adjtime,
	.clock_gettime	= ptp_clock_gettime,
	.clock_getres	= ptp_clock_getres,
	.clock_settime	= ptp_clock_settime,
	.ioctl		= ptp_ioctl,
	.open		= ptp_open,
	.poll		= ptp_poll,
	.read		= ptp_read,
};

static void delete_ptp_clock(struct posix_clock *pc)
{
	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);

	mutex_destroy(&ptp->tsevq_mux);
	mutex_destroy(&ptp->pincfg_mux);
	ida_simple_remove(&ptp_clocks_map, ptp->index);
	kfree(ptp);
}

static void ptp_aux_kworker(struct kthread_work *work)
{
	struct ptp_clock *ptp = container_of(work, struct ptp_clock,
					     aux_work.work);
	struct ptp_clock_info *info = ptp->info;
	long delay;

	delay = info->do_aux_work(info);

	if (delay >= 0)
		kthread_queue_delayed_work(ptp->kworker, &ptp->aux_work, delay);
}

/* public interface */

struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
				     struct device *parent)
{
	struct ptp_clock *ptp;
	int err = 0, index, major = MAJOR(ptp_devt);

	if (info->n_alarm > PTP_MAX_ALARMS)
		return ERR_PTR(-EINVAL);

	/* Initialize a clock structure. */
	err = -ENOMEM;
	ptp = kzalloc(sizeof(struct ptp_clock), GFP_KERNEL);
	if (ptp == NULL)
		goto no_memory;

	index = ida_simple_get(&ptp_clocks_map, 0, MINORMASK + 1, GFP_KERNEL);
	if (index < 0) {
		err = index;
		goto no_slot;
	}

	ptp->clock.ops = ptp_clock_ops;
	ptp->clock.release = delete_ptp_clock;
	ptp->info = info;
	ptp->devid = MKDEV(major, index);
	ptp->index = index;
	spin_lock_init(&ptp->tsevq.lock);
	mutex_init(&ptp->tsevq_mux);
	mutex_init(&ptp->pincfg_mux);
	init_waitqueue_head(&ptp->tsev_wq);

	if (ptp->info->do_aux_work) {
		kthread_init_delayed_work(&ptp->aux_work, ptp_aux_kworker);
		ptp->kworker = kthread_create_worker(0, "ptp%d", ptp->index);
		if (IS_ERR(ptp->kworker)) {
			err = PTR_ERR(ptp->kworker);
			pr_err("failed to create ptp aux_worker %d\n", err);
			goto kworker_err;
		}
	}

	err = ptp_populate_pin_groups(ptp);
	if (err)
		goto no_pin_groups;

	/* Create a new device in our class. */
	ptp->dev = device_create_with_groups(ptp_class, parent, ptp->devid,
					     ptp, ptp->pin_attr_groups,
					     "ptp%d", ptp->index);
	if (IS_ERR(ptp->dev)) {
		err = PTR_ERR(ptp->dev);
		goto no_device;
	}

	/* Register a new PPS source. */
	if (info->pps) {
		struct pps_source_info pps;
		memset(&pps, 0, sizeof(pps));
		snprintf(pps.name, PPS_MAX_NAME_LEN, "ptp%d", index);
		pps.mode = PTP_PPS_MODE;
		pps.owner = info->owner;
		ptp->pps_source = pps_register_source(&pps, PTP_PPS_DEFAULTS);
		if (IS_ERR(ptp->pps_source)) {
			err = PTR_ERR(ptp->pps_source);
			pr_err("failed to register pps source\n");
			goto no_pps;
		}
	}

	/* Create a posix clock. */
	err = posix_clock_register(&ptp->clock, ptp->devid);
	if (err) {
		pr_err("failed to create posix clock\n");
		goto no_clock;
	}

	return ptp;

no_clock:
	if (ptp->pps_source)
		pps_unregister_source(ptp->pps_source);
no_pps:
	device_destroy(ptp_class, ptp->devid);
no_device:
	ptp_cleanup_pin_groups(ptp);
no_pin_groups:
	if (ptp->kworker)
		kthread_destroy_worker(ptp->kworker);
kworker_err:
	mutex_destroy(&ptp->tsevq_mux);
	mutex_destroy(&ptp->pincfg_mux);
	ida_simple_remove(&ptp_clocks_map, index);
no_slot:
	kfree(ptp);
no_memory:
	return ERR_PTR(err);
}
EXPORT_SYMBOL(ptp_clock_register);

int ptp_clock_unregister(struct ptp_clock *ptp)
{
	ptp->defunct = 1;
	wake_up_interruptible(&ptp->tsev_wq);

	if (ptp->kworker) {
		kthread_cancel_delayed_work_sync(&ptp->aux_work);
		kthread_destroy_worker(ptp->kworker);
	}

	/* Release the clock's resources. */
	if (ptp->pps_source)
		pps_unregister_source(ptp->pps_source);

	device_destroy(ptp_class, ptp->devid);
	ptp_cleanup_pin_groups(ptp);

	posix_clock_unregister(&ptp->clock);
	return 0;
}
EXPORT_SYMBOL(ptp_clock_unregister);

void ptp_clock_event(struct ptp_clock *ptp, struct ptp_clock_event *event)
{
	struct pps_event_time evt;

	switch (event->type) {

	case PTP_CLOCK_ALARM:
		break;

	case PTP_CLOCK_EXTTS:
		enqueue_external_timestamp(&ptp->tsevq, event);
		wake_up_interruptible(&ptp->tsev_wq);
		break;

	case PTP_CLOCK_PPS:
		pps_get_ts(&evt);
		pps_event(ptp->pps_source, &evt, PTP_PPS_EVENT, NULL);
		break;

	case PTP_CLOCK_PPSUSR:
		pps_event(ptp->pps_source, &event->pps_times,
			  PTP_PPS_EVENT, NULL);
		break;
	}
}
EXPORT_SYMBOL(ptp_clock_event);

int ptp_clock_index(struct ptp_clock *ptp)
{
	return ptp->index;
}
EXPORT_SYMBOL(ptp_clock_index);

int ptp_find_pin(struct ptp_clock *ptp,
		 enum ptp_pin_function func, unsigned int chan)
{
	struct ptp_pin_desc *pin = NULL;
	int i;

	mutex_lock(&ptp->pincfg_mux);
	for (i = 0; i < ptp->info->n_pins; i++) {
		if (ptp->info->pin_config[i].func == func &&
		    ptp->info->pin_config[i].chan == chan) {
			pin = &ptp->info->pin_config[i];
			break;
		}
	}
	mutex_unlock(&ptp->pincfg_mux);

	return pin ? i : -1;
}
EXPORT_SYMBOL(ptp_find_pin);

int ptp_schedule_worker(struct ptp_clock *ptp, unsigned long delay)
{
	return kthread_mod_delayed_work(ptp->kworker, &ptp->aux_work, delay);
}
EXPORT_SYMBOL(ptp_schedule_worker);

/* module operations */

static void __exit ptp_exit(void)
{
	class_destroy(ptp_class);
	unregister_chrdev_region(ptp_devt, MINORMASK + 1);
	ida_destroy(&ptp_clocks_map);
}

static int __init ptp_init(void)
{
	int err;

	ptp_class = class_create(THIS_MODULE, "ptp");
	if (IS_ERR(ptp_class)) {
		pr_err("ptp: failed to allocate class\n");
		return PTR_ERR(ptp_class);
	}

	err = alloc_chrdev_region(&ptp_devt, 0, MINORMASK + 1, "ptp");
	if (err < 0) {
		pr_err("ptp: failed to allocate device region\n");
		goto no_region;
	}

	ptp_class->dev_groups = ptp_groups;
	pr_info("PTP clock support registered\n");
	return 0;

no_region:
	class_destroy(ptp_class);
	return err;
}

subsys_initcall(ptp_init);
module_exit(ptp_exit);

MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
MODULE_DESCRIPTION("PTP clocks support");
MODULE_LICENSE("GPL");
Commit	Line	Data
74ba9207	1	// SPDX-License-Identifier: GPL-2.0-or-later
d94ba80e RC	2	/*
	3	* PTP 1588 clock support
	4	*
	5	* Copyright (C) 2010 OMICRON electronics GmbH
d94ba80e	6	*/
7356a764	7	#include <linux/idr.h>
d94ba80e RC	8	#include <linux/device.h>
	9	#include <linux/err.h>
	10	#include <linux/init.h>
	11	#include <linux/kernel.h>
	12	#include <linux/module.h>
	13	#include <linux/posix-clock.h>
	14	#include <linux/pps_kernel.h>
	15	#include <linux/slab.h>
	16	#include <linux/syscalls.h>
	17	#include <linux/uaccess.h>
d9535cb7	18	#include <uapi/linux/sched/types.h>
d94ba80e RC	19
	20	#include "ptp_private.h"
	21
	22	#define PTP_MAX_ALARMS 4
d94ba80e RC	23	#define PTP_PPS_DEFAULTS (PPS_CAPTUREASSERT \| PPS_OFFSETASSERT)
	24	#define PTP_PPS_EVENT PPS_CAPTUREASSERT
	25	#define PTP_PPS_MODE (PTP_PPS_DEFAULTS \| PPS_CANWAIT \| PPS_TSFMT_TSPEC)
	26
	27	/* private globals */
	28
	29	static dev_t ptp_devt;
	30	static struct class *ptp_class;
	31
7356a764	32	static DEFINE_IDA(ptp_clocks_map);
d94ba80e RC	33
	34	/* time stamp event queue operations */
	35
	36	static inline int queue_free(struct timestamp_event_queue *q)
	37	{
	38	return PTP_MAX_TIMESTAMPS - queue_cnt(q) - 1;
	39	}
	40
	41	static void enqueue_external_timestamp(struct timestamp_event_queue *queue,
	42	struct ptp_clock_event *src)
	43	{
	44	struct ptp_extts_event *dst;
	45	unsigned long flags;
	46	s64 seconds;
	47	u32 remainder;
	48
	49	seconds = div_u64_rem(src->timestamp, 1000000000, &remainder);
	50
	51	spin_lock_irqsave(&queue->lock, flags);
	52
	53	dst = &queue->buf[queue->tail];
	54	dst->index = src->index;
	55	dst->t.sec = seconds;
	56	dst->t.nsec = remainder;
	57
	58	if (!queue_free(queue))
	59	queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;
	60
	61	queue->tail = (queue->tail + 1) % PTP_MAX_TIMESTAMPS;
	62
	63	spin_unlock_irqrestore(&queue->lock, flags);
	64	}
	65
	66	static s32 scaled_ppm_to_ppb(long ppm)
	67	{
	68	/*
	69	* The 'freq' field in the 'struct timex' is in parts per
	70	* million, but with a 16 bit binary fractional field.
	71	*
	72	* We want to calculate
	73	*
	74	* ppb = scaled_ppm * 1000 / 2^16
	75	*
	76	* which simplifies to
	77	*
	78	* ppb = scaled_ppm * 125 / 2^13
	79	*/
	80	s64 ppb = 1 + ppm;
	81	ppb *= 125;
	82	ppb >>= 13;
	83	return (s32) ppb;
	84	}
	85
	86	/* posix clock implementation */
	87
d340266e	88	static int ptp_clock_getres(struct posix_clock pc, struct timespec64 tp)
d94ba80e	89	{
d68fb11c TG	90	tp->tv_sec = 0;
	91	tp->tv_nsec = 1;
	92	return 0;
d94ba80e RC	93	}
d94ba80e RC	94
d340266e	95	static int ptp_clock_settime(struct posix_clock pc, const struct timespec64 tp)
d94ba80e RC	96	{
d94ba80e RC	97	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
d7d38f5b	98
d340266e	99	return ptp->info->settime64(ptp->info, tp);
d94ba80e RC	100	}
d94ba80e RC	101
d340266e	102	static int ptp_clock_gettime(struct posix_clock pc, struct timespec64 tp)
d94ba80e RC	103	{
d94ba80e RC	104	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
d7d38f5b RC	105	int err;
d7d38f5b RC	106
916444df ML	107	if (ptp->info->gettimex64)
	108	err = ptp->info->gettimex64(ptp->info, tp, NULL);
	109	else
	110	err = ptp->info->gettime64(ptp->info, tp);
d7d38f5b	111	return err;
d94ba80e RC	112	}
d94ba80e RC	113
ead25417	114	static int ptp_clock_adjtime(struct posix_clock pc, struct __kernel_timex tx)
d94ba80e RC	115	{
	116	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
	117	struct ptp_clock_info *ops;
	118	int err = -EOPNOTSUPP;
	119
	120	ops = ptp->info;
	121
	122	if (tx->modes & ADJ_SETOFFSET) {
d340266e	123	struct timespec64 ts;
d94ba80e RC	124	ktime_t kt;
	125	s64 delta;
	126
	127	ts.tv_sec = tx->time.tv_sec;
	128	ts.tv_nsec = tx->time.tv_usec;
	129
	130	if (!(tx->modes & ADJ_NANO))
	131	ts.tv_nsec *= 1000;
	132
	133	if ((unsigned long) ts.tv_nsec >= NSEC_PER_SEC)
	134	return -EINVAL;
	135
d340266e	136	kt = timespec64_to_ktime(ts);
d94ba80e RC	137	delta = ktime_to_ns(kt);
d94ba80e RC	138	err = ops->adjtime(ops, delta);
d94ba80e	139	} else if (tx->modes & ADJ_FREQUENCY) {
d39a7435 RC	140	s32 ppb = scaled_ppm_to_ppb(tx->freq);
	141	if (ppb > ops->max_adj \|\| ppb < -ops->max_adj)
	142	return -ERANGE;
d8d26354 RC	143	if (ops->adjfine)
	144	err = ops->adjfine(ops, tx->freq);
	145	else
	146	err = ops->adjfreq(ops, ppb);
39a8cbd9	147	ptp->dialed_frequency = tx->freq;
5c35bad5 RC	148	} else if (tx->modes == 0) {
	149	tx->freq = ptp->dialed_frequency;
	150	err = 0;
d94ba80e RC	151	}
	152
	153	return err;
	154	}
	155
	156	static struct posix_clock_operations ptp_clock_ops = {
	157	.owner = THIS_MODULE,
	158	.clock_adjtime = ptp_clock_adjtime,
	159	.clock_gettime = ptp_clock_gettime,
	160	.clock_getres = ptp_clock_getres,
	161	.clock_settime = ptp_clock_settime,
	162	.ioctl = ptp_ioctl,
	163	.open = ptp_open,
	164	.poll = ptp_poll,
	165	.read = ptp_read,
	166	};
	167
	168	static void delete_ptp_clock(struct posix_clock *pc)
	169	{
	170	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
	171
	172	mutex_destroy(&ptp->tsevq_mux);
6092315d	173	mutex_destroy(&ptp->pincfg_mux);
7356a764	174	ida_simple_remove(&ptp_clocks_map, ptp->index);
d94ba80e RC	175	kfree(ptp);
	176	}
	177
d9535cb7 GS	178	static void ptp_aux_kworker(struct kthread_work *work)
	179	{
	180	struct ptp_clock *ptp = container_of(work, struct ptp_clock,
	181	aux_work.work);
	182	struct ptp_clock_info *info = ptp->info;
	183	long delay;
	184
	185	delay = info->do_aux_work(info);
	186
	187	if (delay >= 0)
	188	kthread_queue_delayed_work(ptp->kworker, &ptp->aux_work, delay);
	189	}
	190
d94ba80e RC	191	/* public interface */
d94ba80e RC	192
1ef76158 RC	193	struct ptp_clock ptp_clock_register(struct ptp_clock_info info,
1ef76158 RC	194	struct device *parent)
d94ba80e RC	195	{
	196	struct ptp_clock *ptp;
	197	int err = 0, index, major = MAJOR(ptp_devt);
	198
	199	if (info->n_alarm > PTP_MAX_ALARMS)
	200	return ERR_PTR(-EINVAL);
	201
d94ba80e RC	202	/* Initialize a clock structure. */
	203	err = -ENOMEM;
	204	ptp = kzalloc(sizeof(struct ptp_clock), GFP_KERNEL);
	205	if (ptp == NULL)
	206	goto no_memory;
	207
7356a764 JB	208	index = ida_simple_get(&ptp_clocks_map, 0, MINORMASK + 1, GFP_KERNEL);
	209	if (index < 0) {
	210	err = index;
	211	goto no_slot;
	212	}
	213
d94ba80e RC	214	ptp->clock.ops = ptp_clock_ops;
	215	ptp->clock.release = delete_ptp_clock;
	216	ptp->info = info;
	217	ptp->devid = MKDEV(major, index);
	218	ptp->index = index;
	219	spin_lock_init(&ptp->tsevq.lock);
	220	mutex_init(&ptp->tsevq_mux);
6092315d	221	mutex_init(&ptp->pincfg_mux);
d94ba80e RC	222	init_waitqueue_head(&ptp->tsev_wq);
d94ba80e RC	223
d9535cb7	224	if (ptp->info->do_aux_work) {
d9535cb7	225	kthread_init_delayed_work(&ptp->aux_work, ptp_aux_kworker);
822c5f73	226	ptp->kworker = kthread_create_worker(0, "ptp%d", ptp->index);
d9535cb7 GS	227	if (IS_ERR(ptp->kworker)) {
	228	err = PTR_ERR(ptp->kworker);
	229	pr_err("failed to create ptp aux_worker %d\n", err);
	230	goto kworker_err;
	231	}
	232	}
	233
85a66e55 DT	234	err = ptp_populate_pin_groups(ptp);
	235	if (err)
	236	goto no_pin_groups;
	237
d94ba80e	238	/* Create a new device in our class. */
85a66e55 DT	239	ptp->dev = device_create_with_groups(ptp_class, parent, ptp->devid,
	240	ptp, ptp->pin_attr_groups,
	241	"ptp%d", ptp->index);
aea0a897 Y	242	if (IS_ERR(ptp->dev)) {
aea0a897 Y	243	err = PTR_ERR(ptp->dev);
d94ba80e	244	goto no_device;
aea0a897	245	}
d94ba80e	246
d94ba80e RC	247	/* Register a new PPS source. */
	248	if (info->pps) {
	249	struct pps_source_info pps;
	250	memset(&pps, 0, sizeof(pps));
	251	snprintf(pps.name, PPS_MAX_NAME_LEN, "ptp%d", index);
	252	pps.mode = PTP_PPS_MODE;
	253	pps.owner = info->owner;
	254	ptp->pps_source = pps_register_source(&pps, PTP_PPS_DEFAULTS);
b9d93594 DC	255	if (IS_ERR(ptp->pps_source)) {
b9d93594 DC	256	err = PTR_ERR(ptp->pps_source);
d94ba80e RC	257	pr_err("failed to register pps source\n");
	258	goto no_pps;
	259	}
	260	}
	261
	262	/* Create a posix clock. */
	263	err = posix_clock_register(&ptp->clock, ptp->devid);
	264	if (err) {
	265	pr_err("failed to create posix clock\n");
	266	goto no_clock;
	267	}
	268
d94ba80e RC	269	return ptp;
	270
	271	no_clock:
	272	if (ptp->pps_source)
	273	pps_unregister_source(ptp->pps_source);
	274	no_pps:
d94ba80e RC	275	device_destroy(ptp_class, ptp->devid);
d94ba80e RC	276	no_device:
85a66e55 DT	277	ptp_cleanup_pin_groups(ptp);
85a66e55 DT	278	no_pin_groups:
d9535cb7 GS	279	if (ptp->kworker)
	280	kthread_destroy_worker(ptp->kworker);
	281	kworker_err:
d94ba80e	282	mutex_destroy(&ptp->tsevq_mux);
6092315d	283	mutex_destroy(&ptp->pincfg_mux);
b9118b72	284	ida_simple_remove(&ptp_clocks_map, index);
7356a764	285	no_slot:
d94ba80e RC	286	kfree(ptp);
d94ba80e RC	287	no_memory:
d94ba80e RC	288	return ERR_PTR(err);
	289	}
	290	EXPORT_SYMBOL(ptp_clock_register);
	291
	292	int ptp_clock_unregister(struct ptp_clock *ptp)
	293	{
	294	ptp->defunct = 1;
	295	wake_up_interruptible(&ptp->tsev_wq);
	296
d9535cb7 GS	297	if (ptp->kworker) {
	298	kthread_cancel_delayed_work_sync(&ptp->aux_work);
	299	kthread_destroy_worker(ptp->kworker);
	300	}
	301
d94ba80e RC	302	/* Release the clock's resources. */
	303	if (ptp->pps_source)
	304	pps_unregister_source(ptp->pps_source);
85a66e55	305
d94ba80e	306	device_destroy(ptp_class, ptp->devid);
85a66e55	307	ptp_cleanup_pin_groups(ptp);
d94ba80e RC	308
	309	posix_clock_unregister(&ptp->clock);
	310	return 0;
	311	}
	312	EXPORT_SYMBOL(ptp_clock_unregister);
	313
	314	void ptp_clock_event(struct ptp_clock ptp, struct ptp_clock_event event)
	315	{
	316	struct pps_event_time evt;
	317
	318	switch (event->type) {
	319
	320	case PTP_CLOCK_ALARM:
	321	break;
	322
	323	case PTP_CLOCK_EXTTS:
	324	enqueue_external_timestamp(&ptp->tsevq, event);
	325	wake_up_interruptible(&ptp->tsev_wq);
	326	break;
	327
	328	case PTP_CLOCK_PPS:
	329	pps_get_ts(&evt);
	330	pps_event(ptp->pps_source, &evt, PTP_PPS_EVENT, NULL);
	331	break;
220a60a4 BH	332
	333	case PTP_CLOCK_PPSUSR:
	334	pps_event(ptp->pps_source, &event->pps_times,
	335	PTP_PPS_EVENT, NULL);
	336	break;
d94ba80e RC	337	}
	338	}
	339	EXPORT_SYMBOL(ptp_clock_event);
	340
995a9090 RC	341	int ptp_clock_index(struct ptp_clock *ptp)
	342	{
	343	return ptp->index;
	344	}
	345	EXPORT_SYMBOL(ptp_clock_index);
	346
6092315d RC	347	int ptp_find_pin(struct ptp_clock *ptp,
	348	enum ptp_pin_function func, unsigned int chan)
	349	{
	350	struct ptp_pin_desc *pin = NULL;
	351	int i;
	352
	353	mutex_lock(&ptp->pincfg_mux);
	354	for (i = 0; i < ptp->info->n_pins; i++) {
	355	if (ptp->info->pin_config[i].func == func &&
	356	ptp->info->pin_config[i].chan == chan) {
	357	pin = &ptp->info->pin_config[i];
	358	break;
	359	}
	360	}
	361	mutex_unlock(&ptp->pincfg_mux);
	362
	363	return pin ? i : -1;
	364	}
	365	EXPORT_SYMBOL(ptp_find_pin);
	366
d9535cb7 GS	367	int ptp_schedule_worker(struct ptp_clock *ptp, unsigned long delay)
	368	{
	369	return kthread_mod_delayed_work(ptp->kworker, &ptp->aux_work, delay);
	370	}
	371	EXPORT_SYMBOL(ptp_schedule_worker);
	372
d94ba80e RC	373	/* module operations */
	374
	375	static void __exit ptp_exit(void)
	376	{
	377	class_destroy(ptp_class);
7356a764 JB	378	unregister_chrdev_region(ptp_devt, MINORMASK + 1);
7356a764 JB	379	ida_destroy(&ptp_clocks_map);
d94ba80e RC	380	}
	381
	382	static int __init ptp_init(void)
	383	{
	384	int err;
	385
	386	ptp_class = class_create(THIS_MODULE, "ptp");
	387	if (IS_ERR(ptp_class)) {
	388	pr_err("ptp: failed to allocate class\n");
	389	return PTR_ERR(ptp_class);
	390	}
	391
7356a764	392	err = alloc_chrdev_region(&ptp_devt, 0, MINORMASK + 1, "ptp");
d94ba80e RC	393	if (err < 0) {
	394	pr_err("ptp: failed to allocate device region\n");
	395	goto no_region;
	396	}
	397
3499116b	398	ptp_class->dev_groups = ptp_groups;
d94ba80e RC	399	pr_info("PTP clock support registered\n");
	400	return 0;
	401
	402	no_region:
	403	class_destroy(ptp_class);
	404	return err;
	405	}
	406
	407	subsys_initcall(ptp_init);
	408	module_exit(ptp_exit);
	409
c2ec3ff6	410	MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
d94ba80e RC	411	MODULE_DESCRIPTION("PTP clocks support");
d94ba80e RC	412	MODULE_LICENSE("GPL");