[mirror_ubuntu-jammy-kernel.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)

struct class *ptp_class;

/* private globals */

static dev_t ptp_devt;

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);
}

/* 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);

	if (ptp_vclock_in_use(ptp)) {
		pr_err("ptp: virtual clock in use\n");
		return -EBUSY;
	}

	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;

	if (ptp_vclock_in_use(ptp)) {
		pr_err("ptp: virtual clock in use\n");
		return -EBUSY;
	}

	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) {
		long 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 & ADJ_OFFSET) {
		if (ops->adjphase) {
			s32 offset = tx->offset;

			if (!(tx->modes & ADJ_NANO))
				offset *= NSEC_PER_USEC;

			err = ops->adjphase(ops, offset);
		}
	} 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 ptp_clock_release(struct device *dev)
{
	struct ptp_clock *ptp = container_of(dev, struct ptp_clock, dev);

	/* Release the clock's resources. */
	if (ptp->pps_source)
		pps_unregister_source(ptp->pps_source);
	ptp_cleanup_pin_groups(ptp);
	kfree(ptp->vclock_index);
	mutex_destroy(&ptp->tsevq_mux);
	mutex_destroy(&ptp->pincfg_mux);
	mutex_destroy(&ptp->n_vclocks_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);
	size_t size;

	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->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);
	mutex_init(&ptp->n_vclocks_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;
		}
	}

	/* PTP virtual clock is being registered under physical clock */
	if (parent && parent->class && parent->class->name &&
	    strcmp(parent->class->name, "ptp") == 0)
		ptp->is_virtual_clock = true;

	if (!ptp->is_virtual_clock) {
		ptp->max_vclocks = PTP_DEFAULT_MAX_VCLOCKS;

		size = sizeof(int) * ptp->max_vclocks;
		ptp->vclock_index = kzalloc(size, GFP_KERNEL);
		if (!ptp->vclock_index) {
			err = -ENOMEM;
			goto no_mem_for_vclocks;
		}
	}

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

	/* 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;
		}
		ptp->pps_source->lookup_cookie = ptp;
	}

	/* Initialize a new device of our class in our clock structure. */
	device_initialize(&ptp->dev);
	ptp->dev.devt = ptp->devid;
	ptp->dev.class = ptp_class;
	ptp->dev.parent = parent;
	ptp->dev.groups = ptp->pin_attr_groups;
	ptp->dev.release = ptp_clock_release;
	dev_set_drvdata(&ptp->dev, ptp);
	dev_set_name(&ptp->dev, "ptp%d", ptp->index);

	/* Create a posix clock and link it to the device. */
	err = posix_clock_register(&ptp->clock, &ptp->dev);
	if (err) {
	        if (ptp->pps_source)
	                pps_unregister_source(ptp->pps_source);

		if (ptp->kworker)
	                kthread_destroy_worker(ptp->kworker);

		put_device(&ptp->dev);

		pr_err("failed to create posix clock\n");
		return ERR_PTR(err);
	}

	return ptp;

no_pps:
	ptp_cleanup_pin_groups(ptp);
no_pin_groups:
	kfree(ptp->vclock_index);
no_mem_for_vclocks:
	if (ptp->kworker)
		kthread_destroy_worker(ptp->kworker);
kworker_err:
	mutex_destroy(&ptp->tsevq_mux);
	mutex_destroy(&ptp->pincfg_mux);
	mutex_destroy(&ptp->n_vclocks_mux);
	ida_simple_remove(&ptp_clocks_map, index);
no_slot:
	kfree(ptp);
no_memory:
	return ERR_PTR(err);
}
EXPORT_SYMBOL(ptp_clock_register);

static int unregister_vclock(struct device *dev, void *data)
{
	struct ptp_clock *ptp = dev_get_drvdata(dev);

	ptp_vclock_unregister(info_to_vclock(ptp->info));
	return 0;
}

int ptp_clock_unregister(struct ptp_clock *ptp)
{
	if (ptp_vclock_in_use(ptp)) {
		device_for_each_child(&ptp->dev, NULL, unregister_vclock);
	}

	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);
	}
	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;

	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;
		}
	}

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

int ptp_find_pin_unlocked(struct ptp_clock *ptp,
			  enum ptp_pin_function func, unsigned int chan)
{
	int result;

	mutex_lock(&ptp->pincfg_mux);

	result = ptp_find_pin(ptp, func, chan);

	mutex_unlock(&ptp->pincfg_mux);

	return result;
}
EXPORT_SYMBOL(ptp_find_pin_unlocked);

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);

void ptp_cancel_worker_sync(struct ptp_clock *ptp)
{
	kthread_cancel_delayed_work_sync(&ptp->aux_work);
}
EXPORT_SYMBOL(ptp_cancel_worker_sync);

/* 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
acb288e8 YL	27	struct class *ptp_class;
acb288e8 YL	28
d94ba80e RC	29	/* private globals */
	30
	31	static dev_t ptp_devt;
d94ba80e	32
7356a764	33	static DEFINE_IDA(ptp_clocks_map);
d94ba80e RC	34
	35	/* time stamp event queue operations */
	36
	37	static inline int queue_free(struct timestamp_event_queue *q)
	38	{
	39	return PTP_MAX_TIMESTAMPS - queue_cnt(q) - 1;
	40	}
	41
	42	static void enqueue_external_timestamp(struct timestamp_event_queue *queue,
	43	struct ptp_clock_event *src)
	44	{
	45	struct ptp_extts_event *dst;
	46	unsigned long flags;
	47	s64 seconds;
	48	u32 remainder;
	49
	50	seconds = div_u64_rem(src->timestamp, 1000000000, &remainder);
	51
	52	spin_lock_irqsave(&queue->lock, flags);
	53
	54	dst = &queue->buf[queue->tail];
	55	dst->index = src->index;
	56	dst->t.sec = seconds;
	57	dst->t.nsec = remainder;
	58
	59	if (!queue_free(queue))
	60	queue->head = (queue->head + 1) % PTP_MAX_TIMESTAMPS;
	61
	62	queue->tail = (queue->tail + 1) % PTP_MAX_TIMESTAMPS;
	63
	64	spin_unlock_irqrestore(&queue->lock, flags);
	65	}
	66
d94ba80e RC	67	/* posix clock implementation */
d94ba80e RC	68
d340266e	69	static int ptp_clock_getres(struct posix_clock pc, struct timespec64 tp)
d94ba80e	70	{
d68fb11c TG	71	tp->tv_sec = 0;
	72	tp->tv_nsec = 1;
	73	return 0;
d94ba80e RC	74	}
d94ba80e RC	75
d340266e	76	static int ptp_clock_settime(struct posix_clock pc, const struct timespec64 tp)
d94ba80e RC	77	{
d94ba80e RC	78	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
d7d38f5b	79
73f37068 YL	80	if (ptp_vclock_in_use(ptp)) {
	81	pr_err("ptp: virtual clock in use\n");
	82	return -EBUSY;
	83	}
	84
d340266e	85	return ptp->info->settime64(ptp->info, tp);
d94ba80e RC	86	}
d94ba80e RC	87
d340266e	88	static int ptp_clock_gettime(struct posix_clock pc, struct timespec64 tp)
d94ba80e RC	89	{
d94ba80e RC	90	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
d7d38f5b RC	91	int err;
d7d38f5b RC	92
916444df ML	93	if (ptp->info->gettimex64)
	94	err = ptp->info->gettimex64(ptp->info, tp, NULL);
	95	else
	96	err = ptp->info->gettime64(ptp->info, tp);
d7d38f5b	97	return err;
d94ba80e RC	98	}
d94ba80e RC	99
ead25417	100	static int ptp_clock_adjtime(struct posix_clock pc, struct __kernel_timex tx)
d94ba80e RC	101	{
	102	struct ptp_clock *ptp = container_of(pc, struct ptp_clock, clock);
	103	struct ptp_clock_info *ops;
	104	int err = -EOPNOTSUPP;
	105
73f37068 YL	106	if (ptp_vclock_in_use(ptp)) {
	107	pr_err("ptp: virtual clock in use\n");
	108	return -EBUSY;
	109	}
	110
d94ba80e RC	111	ops = ptp->info;
	112
	113	if (tx->modes & ADJ_SETOFFSET) {
d340266e	114	struct timespec64 ts;
d94ba80e RC	115	ktime_t kt;
	116	s64 delta;
	117
	118	ts.tv_sec = tx->time.tv_sec;
	119	ts.tv_nsec = tx->time.tv_usec;
	120
	121	if (!(tx->modes & ADJ_NANO))
	122	ts.tv_nsec *= 1000;
	123
	124	if ((unsigned long) ts.tv_nsec >= NSEC_PER_SEC)
	125	return -EINVAL;
	126
d340266e	127	kt = timespec64_to_ktime(ts);
d94ba80e RC	128	delta = ktime_to_ns(kt);
d94ba80e RC	129	err = ops->adjtime(ops, delta);
d94ba80e	130	} else if (tx->modes & ADJ_FREQUENCY) {
475b92f9	131	long ppb = scaled_ppm_to_ppb(tx->freq);
d39a7435 RC	132	if (ppb > ops->max_adj \|\| ppb < -ops->max_adj)
d39a7435 RC	133	return -ERANGE;
d8d26354 RC	134	if (ops->adjfine)
	135	err = ops->adjfine(ops, tx->freq);
	136	else
	137	err = ops->adjfreq(ops, ppb);
39a8cbd9	138	ptp->dialed_frequency = tx->freq;
184ecc9e	139	} else if (tx->modes & ADJ_OFFSET) {
eabd5c9d RC	140	if (ops->adjphase) {
	141	s32 offset = tx->offset;
	142
	143	if (!(tx->modes & ADJ_NANO))
	144	offset *= NSEC_PER_USEC;
	145
	146	err = ops->adjphase(ops, offset);
	147	}
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
a33121e5	168	static void ptp_clock_release(struct device *dev)
d94ba80e	169	{
a33121e5	170	struct ptp_clock *ptp = container_of(dev, struct ptp_clock, dev);
d94ba80e	171
cdc7e3ed AR	172	/* Release the clock's resources. */
	173	if (ptp->pps_source)
	174	pps_unregister_source(ptp->pps_source);
75718584	175	ptp_cleanup_pin_groups(ptp);
b6b19a71	176	kfree(ptp->vclock_index);
d94ba80e	177	mutex_destroy(&ptp->tsevq_mux);
6092315d	178	mutex_destroy(&ptp->pincfg_mux);
73f37068	179	mutex_destroy(&ptp->n_vclocks_mux);
7356a764	180	ida_simple_remove(&ptp_clocks_map, ptp->index);
d94ba80e RC	181	kfree(ptp);
	182	}
	183
d9535cb7 GS	184	static void ptp_aux_kworker(struct kthread_work *work)
	185	{
	186	struct ptp_clock *ptp = container_of(work, struct ptp_clock,
	187	aux_work.work);
	188	struct ptp_clock_info *info = ptp->info;
	189	long delay;
	190
	191	delay = info->do_aux_work(info);
	192
	193	if (delay >= 0)
	194	kthread_queue_delayed_work(ptp->kworker, &ptp->aux_work, delay);
	195	}
	196
d94ba80e RC	197	/* public interface */
d94ba80e RC	198
1ef76158 RC	199	struct ptp_clock ptp_clock_register(struct ptp_clock_info info,
1ef76158 RC	200	struct device *parent)
d94ba80e RC	201	{
	202	struct ptp_clock *ptp;
	203	int err = 0, index, major = MAJOR(ptp_devt);
44c494c8	204	size_t size;
d94ba80e RC	205
	206	if (info->n_alarm > PTP_MAX_ALARMS)
	207	return ERR_PTR(-EINVAL);
	208
d94ba80e RC	209	/* Initialize a clock structure. */
	210	err = -ENOMEM;
	211	ptp = kzalloc(sizeof(struct ptp_clock), GFP_KERNEL);
	212	if (ptp == NULL)
	213	goto no_memory;
	214
7356a764 JB	215	index = ida_simple_get(&ptp_clocks_map, 0, MINORMASK + 1, GFP_KERNEL);
	216	if (index < 0) {
	217	err = index;
	218	goto no_slot;
	219	}
	220
d94ba80e	221	ptp->clock.ops = ptp_clock_ops;
d94ba80e RC	222	ptp->info = info;
	223	ptp->devid = MKDEV(major, index);
	224	ptp->index = index;
	225	spin_lock_init(&ptp->tsevq.lock);
	226	mutex_init(&ptp->tsevq_mux);
6092315d	227	mutex_init(&ptp->pincfg_mux);
73f37068	228	mutex_init(&ptp->n_vclocks_mux);
d94ba80e RC	229	init_waitqueue_head(&ptp->tsev_wq);
d94ba80e RC	230
d9535cb7	231	if (ptp->info->do_aux_work) {
d9535cb7	232	kthread_init_delayed_work(&ptp->aux_work, ptp_aux_kworker);
822c5f73	233	ptp->kworker = kthread_create_worker(0, "ptp%d", ptp->index);
d9535cb7 GS	234	if (IS_ERR(ptp->kworker)) {
	235	err = PTR_ERR(ptp->kworker);
	236	pr_err("failed to create ptp aux_worker %d\n", err);
	237	goto kworker_err;
	238	}
	239	}
	240
73f37068	241	/* PTP virtual clock is being registered under physical clock */
55eac206	242	if (parent && parent->class && parent->class->name &&
73f37068 YL	243	strcmp(parent->class->name, "ptp") == 0)
	244	ptp->is_virtual_clock = true;
	245
44c494c8	246	if (!ptp->is_virtual_clock) {
73f37068 YL	247	ptp->max_vclocks = PTP_DEFAULT_MAX_VCLOCKS;
73f37068 YL	248
44c494c8 YL	249	size = sizeof(int) * ptp->max_vclocks;
	250	ptp->vclock_index = kzalloc(size, GFP_KERNEL);
	251	if (!ptp->vclock_index) {
	252	err = -ENOMEM;
	253	goto no_mem_for_vclocks;
	254	}
	255	}
	256
85a66e55 DT	257	err = ptp_populate_pin_groups(ptp);
	258	if (err)
	259	goto no_pin_groups;
	260
d94ba80e RC	261	/* Register a new PPS source. */
	262	if (info->pps) {
	263	struct pps_source_info pps;
	264	memset(&pps, 0, sizeof(pps));
	265	snprintf(pps.name, PPS_MAX_NAME_LEN, "ptp%d", index);
	266	pps.mode = PTP_PPS_MODE;
	267	pps.owner = info->owner;
	268	ptp->pps_source = pps_register_source(&pps, PTP_PPS_DEFAULTS);
b9d93594 DC	269	if (IS_ERR(ptp->pps_source)) {
b9d93594 DC	270	err = PTR_ERR(ptp->pps_source);
d94ba80e RC	271	pr_err("failed to register pps source\n");
	272	goto no_pps;
	273	}
debdd8e3	274	ptp->pps_source->lookup_cookie = ptp;
d94ba80e RC	275	}
d94ba80e RC	276
a33121e5 VD	277	/* Initialize a new device of our class in our clock structure. */
	278	device_initialize(&ptp->dev);
	279	ptp->dev.devt = ptp->devid;
	280	ptp->dev.class = ptp_class;
	281	ptp->dev.parent = parent;
	282	ptp->dev.groups = ptp->pin_attr_groups;
	283	ptp->dev.release = ptp_clock_release;
	284	dev_set_drvdata(&ptp->dev, ptp);
	285	dev_set_name(&ptp->dev, "ptp%d", ptp->index);
	286
	287	/* Create a posix clock and link it to the device. */
	288	err = posix_clock_register(&ptp->clock, &ptp->dev);
d94ba80e	289	if (err) {
4225fea1 YY	290	if (ptp->pps_source)
	291	pps_unregister_source(ptp->pps_source);
	292
4225fea1 YY	293	if (ptp->kworker)
	294	kthread_destroy_worker(ptp->kworker);
	295
	296	put_device(&ptp->dev);
	297
d94ba80e	298	pr_err("failed to create posix clock\n");
4225fea1	299	return ERR_PTR(err);
d94ba80e RC	300	}
d94ba80e RC	301
d94ba80e RC	302	return ptp;
d94ba80e RC	303
d94ba80e	304	no_pps:
85a66e55 DT	305	ptp_cleanup_pin_groups(ptp);
85a66e55 DT	306	no_pin_groups:
44c494c8 YL	307	kfree(ptp->vclock_index);
44c494c8 YL	308	no_mem_for_vclocks:
d9535cb7 GS	309	if (ptp->kworker)
	310	kthread_destroy_worker(ptp->kworker);
	311	kworker_err:
d94ba80e	312	mutex_destroy(&ptp->tsevq_mux);
6092315d	313	mutex_destroy(&ptp->pincfg_mux);
73f37068	314	mutex_destroy(&ptp->n_vclocks_mux);
b9118b72	315	ida_simple_remove(&ptp_clocks_map, index);
7356a764	316	no_slot:
d94ba80e RC	317	kfree(ptp);
d94ba80e RC	318	no_memory:
d94ba80e RC	319	return ERR_PTR(err);
	320	}
	321	EXPORT_SYMBOL(ptp_clock_register);
	322
0db819c9 ML	323	static int unregister_vclock(struct device dev, void data)
	324	{
	325	struct ptp_clock *ptp = dev_get_drvdata(dev);
	326
	327	ptp_vclock_unregister(info_to_vclock(ptp->info));
	328	return 0;
	329	}
	330
d94ba80e RC	331	int ptp_clock_unregister(struct ptp_clock *ptp)
d94ba80e RC	332	{
73f37068	333	if (ptp_vclock_in_use(ptp)) {
0db819c9	334	device_for_each_child(&ptp->dev, NULL, unregister_vclock);
73f37068 YL	335	}
73f37068 YL	336
d94ba80e RC	337	ptp->defunct = 1;
	338	wake_up_interruptible(&ptp->tsev_wq);
	339
d9535cb7 GS	340	if (ptp->kworker) {
	341	kthread_cancel_delayed_work_sync(&ptp->aux_work);
	342	kthread_destroy_worker(ptp->kworker);
	343	}
d94ba80e	344	posix_clock_unregister(&ptp->clock);
75718584	345
d94ba80e RC	346	return 0;
	347	}
	348	EXPORT_SYMBOL(ptp_clock_unregister);
	349
	350	void ptp_clock_event(struct ptp_clock ptp, struct ptp_clock_event event)
	351	{
	352	struct pps_event_time evt;
	353
	354	switch (event->type) {
	355
	356	case PTP_CLOCK_ALARM:
	357	break;
	358
	359	case PTP_CLOCK_EXTTS:
	360	enqueue_external_timestamp(&ptp->tsevq, event);
	361	wake_up_interruptible(&ptp->tsev_wq);
	362	break;
	363
	364	case PTP_CLOCK_PPS:
	365	pps_get_ts(&evt);
	366	pps_event(ptp->pps_source, &evt, PTP_PPS_EVENT, NULL);
	367	break;
220a60a4 BH	368
	369	case PTP_CLOCK_PPSUSR:
	370	pps_event(ptp->pps_source, &event->pps_times,
	371	PTP_PPS_EVENT, NULL);
	372	break;
d94ba80e RC	373	}
	374	}
	375	EXPORT_SYMBOL(ptp_clock_event);
	376
995a9090 RC	377	int ptp_clock_index(struct ptp_clock *ptp)
	378	{
	379	return ptp->index;
	380	}
	381	EXPORT_SYMBOL(ptp_clock_index);
	382
6092315d RC	383	int ptp_find_pin(struct ptp_clock *ptp,
	384	enum ptp_pin_function func, unsigned int chan)
	385	{
	386	struct ptp_pin_desc *pin = NULL;
	387	int i;
	388
6092315d RC	389	for (i = 0; i < ptp->info->n_pins; i++) {
	390	if (ptp->info->pin_config[i].func == func &&
	391	ptp->info->pin_config[i].chan == chan) {
	392	pin = &ptp->info->pin_config[i];
	393	break;
	394	}
	395	}
6092315d RC	396
	397	return pin ? i : -1;
	398	}
	399	EXPORT_SYMBOL(ptp_find_pin);
	400
62582a7e RC	401	int ptp_find_pin_unlocked(struct ptp_clock *ptp,
	402	enum ptp_pin_function func, unsigned int chan)
	403	{
	404	int result;
	405
	406	mutex_lock(&ptp->pincfg_mux);
	407
	408	result = ptp_find_pin(ptp, func, chan);
	409
	410	mutex_unlock(&ptp->pincfg_mux);
	411
	412	return result;
	413	}
	414	EXPORT_SYMBOL(ptp_find_pin_unlocked);
	415
d9535cb7 GS	416	int ptp_schedule_worker(struct ptp_clock *ptp, unsigned long delay)
	417	{
	418	return kthread_mod_delayed_work(ptp->kworker, &ptp->aux_work, delay);
	419	}
	420	EXPORT_SYMBOL(ptp_schedule_worker);
	421
544fed47 VO	422	void ptp_cancel_worker_sync(struct ptp_clock *ptp)
	423	{
	424	kthread_cancel_delayed_work_sync(&ptp->aux_work);
	425	}
	426	EXPORT_SYMBOL(ptp_cancel_worker_sync);
	427
d94ba80e RC	428	/* module operations */
	429
	430	static void __exit ptp_exit(void)
	431	{
	432	class_destroy(ptp_class);
7356a764 JB	433	unregister_chrdev_region(ptp_devt, MINORMASK + 1);
7356a764 JB	434	ida_destroy(&ptp_clocks_map);
d94ba80e RC	435	}
	436
	437	static int __init ptp_init(void)
	438	{
	439	int err;
	440
	441	ptp_class = class_create(THIS_MODULE, "ptp");
	442	if (IS_ERR(ptp_class)) {
	443	pr_err("ptp: failed to allocate class\n");
	444	return PTR_ERR(ptp_class);
	445	}
	446
7356a764	447	err = alloc_chrdev_region(&ptp_devt, 0, MINORMASK + 1, "ptp");
d94ba80e RC	448	if (err < 0) {
	449	pr_err("ptp: failed to allocate device region\n");
	450	goto no_region;
	451	}
	452
3499116b	453	ptp_class->dev_groups = ptp_groups;
d94ba80e RC	454	pr_info("PTP clock support registered\n");
	455	return 0;
	456
	457	no_region:
	458	class_destroy(ptp_class);
	459	return err;
	460	}
	461
	462	subsys_initcall(ptp_init);
	463	module_exit(ptp_exit);
	464
c2ec3ff6	465	MODULE_AUTHOR("Richard Cochran <richardcochran@gmail.com>");
d94ba80e RC	466	MODULE_DESCRIPTION("PTP clocks support");
d94ba80e RC	467	MODULE_LICENSE("GPL");