[mirror_ubuntu-artful-kernel.git] / drivers / ptp / ptp_clock.c

/*
 * PTP 1588 clock support
 *
 * Copyright (C) 2010 OMICRON electronics GmbH
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#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;

	err = ptp->info->gettime64(ptp->info, tp);
	return err;
}

static int ptp_clock_adjtime(struct posix_clock *pc, struct 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) {
		char *worker_name = kasprintf(GFP_KERNEL, "ptp%d", ptp->index);

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