[linux-2.6-block.git] / include / linux / ptp_clock_kernel.h

/*
 * 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.
 */

#ifndef _PTP_CLOCK_KERNEL_H_
#define _PTP_CLOCK_KERNEL_H_

#include <linux/device.h>
#include <linux/pps_kernel.h>
#include <linux/ptp_clock.h>


struct ptp_clock_request {
	enum {
		PTP_CLK_REQ_EXTTS,
		PTP_CLK_REQ_PEROUT,
		PTP_CLK_REQ_PPS,
	} type;
	union {
		struct ptp_extts_request extts;
		struct ptp_perout_request perout;
	};
};

/**
 * struct ptp_clock_info - decribes a PTP hardware clock
 *
 * @owner:     The clock driver should set to THIS_MODULE.
 * @name:      A short "friendly name" to identify the clock and to
 *             help distinguish PHY based devices from MAC based ones.
 *             The string is not meant to be a unique id.
 * @max_adj:   The maximum possible frequency adjustment, in parts per billon.
 * @n_alarm:   The number of programmable alarms.
 * @n_ext_ts:  The number of external time stamp channels.
 * @n_per_out: The number of programmable periodic signals.
 * @pps:       Indicates whether the clock supports a PPS callback.
 *
 * clock operations
 *
 * @adjfreq:  Adjusts the frequency of the hardware clock.
 *            parameter delta: Desired period change in parts per billion.
 *
 * @adjtime:  Shifts the time of the hardware clock.
 *            parameter delta: Desired change in nanoseconds.
 *
 * @gettime:  Reads the current time from the hardware clock.
 *            parameter ts: Holds the result.
 *
 * @settime:  Set the current time on the hardware clock.
 *            parameter ts: Time value to set.
 *
 * @enable:   Request driver to enable or disable an ancillary feature.
 *            parameter request: Desired resource to enable or disable.
 *            parameter on: Caller passes one to enable or zero to disable.
 *
 * Drivers should embed their ptp_clock_info within a private
 * structure, obtaining a reference to it using container_of().
 *
 * The callbacks must all return zero on success, non-zero otherwise.
 */

struct ptp_clock_info {
	struct module *owner;
	char name[16];
	s32 max_adj;
	int n_alarm;
	int n_ext_ts;
	int n_per_out;
	int pps;
	int (*adjfreq)(struct ptp_clock_info *ptp, s32 delta);
	int (*adjtime)(struct ptp_clock_info *ptp, s64 delta);
	int (*gettime)(struct ptp_clock_info *ptp, struct timespec *ts);
	int (*settime)(struct ptp_clock_info *ptp, const struct timespec *ts);
	int (*enable)(struct ptp_clock_info *ptp,
		      struct ptp_clock_request *request, int on);
};

struct ptp_clock;

/**
 * ptp_clock_register() - register a PTP hardware clock driver
 *
 * @info:   Structure describing the new clock.
 * @parent: Pointer to the parent device of the new clock.
 */

extern struct ptp_clock *ptp_clock_register(struct ptp_clock_info *info,
					    struct device *parent);

/**
 * ptp_clock_unregister() - unregister a PTP hardware clock driver
 *
 * @ptp:  The clock to remove from service.
 */

extern int ptp_clock_unregister(struct ptp_clock *ptp);


enum ptp_clock_events {
	PTP_CLOCK_ALARM,
	PTP_CLOCK_EXTTS,
	PTP_CLOCK_PPS,
	PTP_CLOCK_PPSUSR,
};

/**
 * struct ptp_clock_event - decribes a PTP hardware clock event
 *
 * @type:  One of the ptp_clock_events enumeration values.
 * @index: Identifies the source of the event.
 * @timestamp: When the event occurred (%PTP_CLOCK_EXTTS only).
 * @pps_times: When the event occurred (%PTP_CLOCK_PPSUSR only).
 */

struct ptp_clock_event {
	int type;
	int index;
	union {
		u64 timestamp;
		struct pps_event_time pps_times;
	};
};

/**
 * ptp_clock_event() - notify the PTP layer about an event
 *
 * @ptp:    The clock obtained from ptp_clock_register().
 * @event:  Message structure describing the event.
 */

extern void ptp_clock_event(struct ptp_clock *ptp,
			    struct ptp_clock_event *event);

/**
 * ptp_clock_index() - obtain the device index of a PTP clock
 *
 * @ptp:    The clock obtained from ptp_clock_register().
 */

extern int ptp_clock_index(struct ptp_clock *ptp);

#endif
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	*/
	20
	21	#ifndef _PTP_CLOCK_KERNEL_H_
	22	#define _PTP_CLOCK_KERNEL_H_
	23
1ef76158	24	#include <linux/device.h>
220a60a4	25	#include <linux/pps_kernel.h>
d94ba80e RC	26	#include <linux/ptp_clock.h>
	27
	28
	29	struct ptp_clock_request {
	30	enum {
	31	PTP_CLK_REQ_EXTTS,
	32	PTP_CLK_REQ_PEROUT,
	33	PTP_CLK_REQ_PPS,
	34	} type;
	35	union {
	36	struct ptp_extts_request extts;
	37	struct ptp_perout_request perout;
	38	};
	39	};
	40
	41	/**
	42	* struct ptp_clock_info - decribes a PTP hardware clock
	43	*
	44	* @owner: The clock driver should set to THIS_MODULE.
de465846 RC	45	* @name: A short "friendly name" to identify the clock and to
	46	* help distinguish PHY based devices from MAC based ones.
	47	* The string is not meant to be a unique id.
d94ba80e RC	48	* @max_adj: The maximum possible frequency adjustment, in parts per billon.
	49	* @n_alarm: The number of programmable alarms.
	50	* @n_ext_ts: The number of external time stamp channels.
	51	* @n_per_out: The number of programmable periodic signals.
	52	* @pps: Indicates whether the clock supports a PPS callback.
	53	*
	54	* clock operations
	55	*
	56	* @adjfreq: Adjusts the frequency of the hardware clock.
	57	* parameter delta: Desired period change in parts per billion.
	58	*
	59	* @adjtime: Shifts the time of the hardware clock.
	60	* parameter delta: Desired change in nanoseconds.
	61	*
	62	* @gettime: Reads the current time from the hardware clock.
	63	* parameter ts: Holds the result.
	64	*
	65	* @settime: Set the current time on the hardware clock.
	66	* parameter ts: Time value to set.
	67	*
	68	* @enable: Request driver to enable or disable an ancillary feature.
	69	* parameter request: Desired resource to enable or disable.
	70	* parameter on: Caller passes one to enable or zero to disable.
	71	*
	72	* Drivers should embed their ptp_clock_info within a private
	73	* structure, obtaining a reference to it using container_of().
	74	*
	75	* The callbacks must all return zero on success, non-zero otherwise.
	76	*/
	77
	78	struct ptp_clock_info {
	79	struct module *owner;
	80	char name[16];
	81	s32 max_adj;
	82	int n_alarm;
	83	int n_ext_ts;
	84	int n_per_out;
	85	int pps;
	86	int (adjfreq)(struct ptp_clock_info ptp, s32 delta);
	87	int (adjtime)(struct ptp_clock_info ptp, s64 delta);
	88	int (gettime)(struct ptp_clock_info ptp, struct timespec *ts);
	89	int (settime)(struct ptp_clock_info ptp, const struct timespec *ts);
	90	int (enable)(struct ptp_clock_info ptp,
	91	struct ptp_clock_request *request, int on);
	92	};
	93
	94	struct ptp_clock;
	95
	96	/**
	97	* ptp_clock_register() - register a PTP hardware clock driver
	98	*
1ef76158 RC	99	* @info: Structure describing the new clock.
1ef76158 RC	100	* @parent: Pointer to the parent device of the new clock.
d94ba80e RC	101	*/
d94ba80e RC	102
1ef76158 RC	103	extern struct ptp_clock ptp_clock_register(struct ptp_clock_info info,
1ef76158 RC	104	struct device *parent);
d94ba80e RC	105
	106	/**
	107	* ptp_clock_unregister() - unregister a PTP hardware clock driver
	108	*
	109	* @ptp: The clock to remove from service.
	110	*/
	111
	112	extern int ptp_clock_unregister(struct ptp_clock *ptp);
	113
	114
	115	enum ptp_clock_events {
	116	PTP_CLOCK_ALARM,
	117	PTP_CLOCK_EXTTS,
	118	PTP_CLOCK_PPS,
220a60a4	119	PTP_CLOCK_PPSUSR,
d94ba80e RC	120	};
	121
	122	/**
	123	* struct ptp_clock_event - decribes a PTP hardware clock event
	124	*
	125	* @type: One of the ptp_clock_events enumeration values.
	126	* @index: Identifies the source of the event.
220a60a4 BH	127	* @timestamp: When the event occurred (%PTP_CLOCK_EXTTS only).
220a60a4 BH	128	* @pps_times: When the event occurred (%PTP_CLOCK_PPSUSR only).
d94ba80e RC	129	*/
	130
	131	struct ptp_clock_event {
	132	int type;
	133	int index;
220a60a4 BH	134	union {
	135	u64 timestamp;
	136	struct pps_event_time pps_times;
	137	};
d94ba80e RC	138	};
	139
	140	/**
	141	* ptp_clock_event() - notify the PTP layer about an event
	142	*
	143	* @ptp: The clock obtained from ptp_clock_register().
	144	* @event: Message structure describing the event.
	145	*/
	146
	147	extern void ptp_clock_event(struct ptp_clock *ptp,
	148	struct ptp_clock_event *event);
	149
995a9090 RC	150	/**
	151	* ptp_clock_index() - obtain the device index of a PTP clock
	152	*
	153	* @ptp: The clock obtained from ptp_clock_register().
	154	*/
	155
	156	extern int ptp_clock_index(struct ptp_clock *ptp);
	157
d94ba80e	158	#endif