[mirror_ubuntu-focal-kernel.git] / drivers / net / dsa / mv88e6xxx / ptp.h

/*
 * Marvell 88E6xxx Switch PTP support
 *
 * Copyright (c) 2008 Marvell Semiconductor
 *
 * Copyright (c) 2017 National Instruments
 *      Erik Hons <erik.hons@ni.com>
 *      Brandon Streiff <brandon.streiff@ni.com>
 *      Dane Wagner <dane.wagner@ni.com>
 *
 * 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.
 */

#ifndef _MV88E6XXX_PTP_H
#define _MV88E6XXX_PTP_H

#include "chip.h"

/* Offset 0x00: TAI Global Config */
#define MV88E6XXX_TAI_CFG			0x00
#define MV88E6XXX_TAI_CFG_CAP_OVERWRITE		0x8000
#define MV88E6XXX_TAI_CFG_CAP_CTR_START		0x4000
#define MV88E6XXX_TAI_CFG_EVREQ_FALLING		0x2000
#define MV88E6XXX_TAI_CFG_TRIG_ACTIVE_LO	0x1000
#define MV88E6XXX_TAI_CFG_IRL_ENABLE		0x0400
#define MV88E6XXX_TAI_CFG_TRIG_IRQ_EN		0x0200
#define MV88E6XXX_TAI_CFG_EVREQ_IRQ_EN		0x0100
#define MV88E6XXX_TAI_CFG_TRIG_LOCK		0x0080
#define MV88E6XXX_TAI_CFG_BLOCK_UPDATE		0x0008
#define MV88E6XXX_TAI_CFG_MULTI_PTP		0x0004
#define MV88E6XXX_TAI_CFG_TRIG_MODE_ONESHOT	0x0002
#define MV88E6XXX_TAI_CFG_TRIG_ENABLE		0x0001

/* Offset 0x01: Timestamp Clock Period (ps) */
#define MV88E6XXX_TAI_CLOCK_PERIOD		0x01

/* Offset 0x02/0x03: Trigger Generation Amount */
#define MV88E6XXX_TAI_TRIG_GEN_AMOUNT_LO	0x02
#define MV88E6XXX_TAI_TRIG_GEN_AMOUNT_HI	0x03

/* Offset 0x04: Clock Compensation */
#define MV88E6XXX_TAI_TRIG_CLOCK_COMP		0x04

/* Offset 0x05: Trigger Configuration */
#define MV88E6XXX_TAI_TRIG_CFG			0x05

/* Offset 0x06: Ingress Rate Limiter Clock Generation Amount */
#define MV88E6XXX_TAI_IRL_AMOUNT		0x06

/* Offset 0x07: Ingress Rate Limiter Compensation */
#define MV88E6XXX_TAI_IRL_COMP			0x07

/* Offset 0x08: Ingress Rate Limiter Compensation */
#define MV88E6XXX_TAI_IRL_COMP_PS		0x08

/* Offset 0x09: Event Status */
#define MV88E6XXX_TAI_EVENT_STATUS		0x09
#define MV88E6XXX_TAI_EVENT_STATUS_CAP_TRIG	0x4000
#define MV88E6XXX_TAI_EVENT_STATUS_ERROR	0x0200
#define MV88E6XXX_TAI_EVENT_STATUS_VALID	0x0100
#define MV88E6XXX_TAI_EVENT_STATUS_CTR_MASK	0x00ff

/* Offset 0x0A/0x0B: Event Time */
#define MV88E6XXX_TAI_EVENT_TIME_LO		0x0a
#define MV88E6XXX_TAI_EVENT_TYPE_HI		0x0b

/* Offset 0x0E/0x0F: PTP Global Time */
#define MV88E6XXX_TAI_TIME_LO			0x0e
#define MV88E6XXX_TAI_TIME_HI			0x0f

/* Offset 0x10/0x11: Trig Generation Time */
#define MV88E6XXX_TAI_TRIG_TIME_LO		0x10
#define MV88E6XXX_TAI_TRIG_TIME_HI		0x11

/* Offset 0x12: Lock Status */
#define MV88E6XXX_TAI_LOCK_STATUS		0x12

/* Offset 0x00: Ether Type */
#define MV88E6XXX_PTP_GC_ETYPE			0x00

/* Offset 0x01: Message ID */
#define MV88E6XXX_PTP_GC_MESSAGE_ID		0x01

/* Offset 0x02: Time Stamp Arrive Time */
#define MV88E6XXX_PTP_GC_TS_ARR_PTR		0x02

/* Offset 0x03: Port Arrival Interrupt Enable */
#define MV88E6XXX_PTP_GC_PORT_ARR_INT_EN	0x03

/* Offset 0x04: Port Departure Interrupt Enable */
#define MV88E6XXX_PTP_GC_PORT_DEP_INT_EN	0x04

/* Offset 0x05: Configuration */
#define MV88E6XXX_PTP_GC_CONFIG			0x05
#define MV88E6XXX_PTP_GC_CONFIG_DIS_OVERWRITE	BIT(1)
#define MV88E6XXX_PTP_GC_CONFIG_DIS_TS		BIT(0)

/* Offset 0x8: Interrupt Status */
#define MV88E6XXX_PTP_GC_INT_STATUS		0x08

/* Offset 0x9/0xa: Global Time */
#define MV88E6XXX_PTP_GC_TIME_LO		0x09
#define MV88E6XXX_PTP_GC_TIME_HI		0x0A

#ifdef CONFIG_NET_DSA_MV88E6XXX_PTP

long mv88e6xxx_hwtstamp_work(struct ptp_clock_info *ptp);
int mv88e6xxx_ptp_setup(struct mv88e6xxx_chip *chip);
void mv88e6xxx_ptp_free(struct mv88e6xxx_chip *chip);

#define ptp_to_chip(ptp) container_of(ptp, struct mv88e6xxx_chip,	\
				      ptp_clock_info)

extern const struct mv88e6xxx_ptp_ops mv88e6352_ptp_ops;
extern const struct mv88e6xxx_ptp_ops mv88e6165_ptp_ops;

#else /* !CONFIG_NET_DSA_MV88E6XXX_PTP */

static inline long mv88e6xxx_hwtstamp_work(struct ptp_clock_info *ptp)
{
	return -1;
}

static inline int mv88e6xxx_ptp_setup(struct mv88e6xxx_chip *chip)
{
	return 0;
}

static inline void mv88e6xxx_ptp_free(struct mv88e6xxx_chip *chip)
{
}

static const struct mv88e6xxx_ptp_ops mv88e6352_ptp_ops = {};
static const struct mv88e6xxx_ptp_ops mv88e6165_ptp_ops = {};

#endif /* CONFIG_NET_DSA_MV88E6XXX_PTP */

#endif /* _MV88E6XXX_PTP_H */
Commit	Line	Data
2fa8d3af BS	1	/*
	2	* Marvell 88E6xxx Switch PTP support
	3	*
	4	* Copyright (c) 2008 Marvell Semiconductor
	5	*
	6	* Copyright (c) 2017 National Instruments
	7	* Erik Hons <erik.hons@ni.com>
	8	* Brandon Streiff <brandon.streiff@ni.com>
	9	* Dane Wagner <dane.wagner@ni.com>
	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation; either version 2 of the License, or
	14	* (at your option) any later version.
	15	*/
	16
	17	#ifndef _MV88E6XXX_PTP_H
	18	#define _MV88E6XXX_PTP_H
	19
	20	#include "chip.h"
	21
	22	/* Offset 0x00: TAI Global Config */
	23	#define MV88E6XXX_TAI_CFG 0x00
4eb3be29 BS	24	#define MV88E6XXX_TAI_CFG_CAP_OVERWRITE 0x8000
	25	#define MV88E6XXX_TAI_CFG_CAP_CTR_START 0x4000
	26	#define MV88E6XXX_TAI_CFG_EVREQ_FALLING 0x2000
	27	#define MV88E6XXX_TAI_CFG_TRIG_ACTIVE_LO 0x1000
	28	#define MV88E6XXX_TAI_CFG_IRL_ENABLE 0x0400
	29	#define MV88E6XXX_TAI_CFG_TRIG_IRQ_EN 0x0200
	30	#define MV88E6XXX_TAI_CFG_EVREQ_IRQ_EN 0x0100
	31	#define MV88E6XXX_TAI_CFG_TRIG_LOCK 0x0080
	32	#define MV88E6XXX_TAI_CFG_BLOCK_UPDATE 0x0008
	33	#define MV88E6XXX_TAI_CFG_MULTI_PTP 0x0004
	34	#define MV88E6XXX_TAI_CFG_TRIG_MODE_ONESHOT 0x0002
	35	#define MV88E6XXX_TAI_CFG_TRIG_ENABLE 0x0001
2fa8d3af BS	36
	37	/* Offset 0x01: Timestamp Clock Period (ps) */
	38	#define MV88E6XXX_TAI_CLOCK_PERIOD 0x01
	39
	40	/* Offset 0x02/0x03: Trigger Generation Amount */
	41	#define MV88E6XXX_TAI_TRIG_GEN_AMOUNT_LO 0x02
	42	#define MV88E6XXX_TAI_TRIG_GEN_AMOUNT_HI 0x03
	43
	44	/* Offset 0x04: Clock Compensation */
	45	#define MV88E6XXX_TAI_TRIG_CLOCK_COMP 0x04
	46
	47	/* Offset 0x05: Trigger Configuration */
	48	#define MV88E6XXX_TAI_TRIG_CFG 0x05
	49
	50	/* Offset 0x06: Ingress Rate Limiter Clock Generation Amount */
	51	#define MV88E6XXX_TAI_IRL_AMOUNT 0x06
	52
	53	/* Offset 0x07: Ingress Rate Limiter Compensation */
	54	#define MV88E6XXX_TAI_IRL_COMP 0x07
	55
	56	/* Offset 0x08: Ingress Rate Limiter Compensation */
	57	#define MV88E6XXX_TAI_IRL_COMP_PS 0x08
	58
	59	/* Offset 0x09: Event Status */
	60	#define MV88E6XXX_TAI_EVENT_STATUS 0x09
4eb3be29 BS	61	#define MV88E6XXX_TAI_EVENT_STATUS_CAP_TRIG 0x4000
	62	#define MV88E6XXX_TAI_EVENT_STATUS_ERROR 0x0200
	63	#define MV88E6XXX_TAI_EVENT_STATUS_VALID 0x0100
	64	#define MV88E6XXX_TAI_EVENT_STATUS_CTR_MASK 0x00ff
2fa8d3af BS	65
	66	/* Offset 0x0A/0x0B: Event Time */
	67	#define MV88E6XXX_TAI_EVENT_TIME_LO 0x0a
	68	#define MV88E6XXX_TAI_EVENT_TYPE_HI 0x0b
	69
	70	/* Offset 0x0E/0x0F: PTP Global Time */
	71	#define MV88E6XXX_TAI_TIME_LO 0x0e
	72	#define MV88E6XXX_TAI_TIME_HI 0x0f
	73
	74	/* Offset 0x10/0x11: Trig Generation Time */
	75	#define MV88E6XXX_TAI_TRIG_TIME_LO 0x10
	76	#define MV88E6XXX_TAI_TRIG_TIME_HI 0x11
	77
	78	/* Offset 0x12: Lock Status */
	79	#define MV88E6XXX_TAI_LOCK_STATUS 0x12
	80
dfa54348 AL	81	/* Offset 0x00: Ether Type */
	82	#define MV88E6XXX_PTP_GC_ETYPE 0x00
	83
	84	/* Offset 0x01: Message ID */
	85	#define MV88E6XXX_PTP_GC_MESSAGE_ID 0x01
	86
	87	/* Offset 0x02: Time Stamp Arrive Time */
	88	#define MV88E6XXX_PTP_GC_TS_ARR_PTR 0x02
	89
	90	/* Offset 0x03: Port Arrival Interrupt Enable */
	91	#define MV88E6XXX_PTP_GC_PORT_ARR_INT_EN 0x03
	92
	93	/* Offset 0x04: Port Departure Interrupt Enable */
	94	#define MV88E6XXX_PTP_GC_PORT_DEP_INT_EN 0x04
	95
	96	/* Offset 0x05: Configuration */
	97	#define MV88E6XXX_PTP_GC_CONFIG 0x05
	98	#define MV88E6XXX_PTP_GC_CONFIG_DIS_OVERWRITE BIT(1)
	99	#define MV88E6XXX_PTP_GC_CONFIG_DIS_TS BIT(0)
	100
	101	/* Offset 0x8: Interrupt Status */
	102	#define MV88E6XXX_PTP_GC_INT_STATUS 0x08
	103
	104	/* Offset 0x9/0xa: Global Time */
	105	#define MV88E6XXX_PTP_GC_TIME_LO 0x09
	106	#define MV88E6XXX_PTP_GC_TIME_HI 0x0A
	107
2fa8d3af BS	108	#ifdef CONFIG_NET_DSA_MV88E6XXX_PTP
2fa8d3af BS	109
c6fe0ad2	110	long mv88e6xxx_hwtstamp_work(struct ptp_clock_info *ptp);
2fa8d3af BS	111	int mv88e6xxx_ptp_setup(struct mv88e6xxx_chip *chip);
	112	void mv88e6xxx_ptp_free(struct mv88e6xxx_chip *chip);
	113
c6fe0ad2 BS	114	#define ptp_to_chip(ptp) container_of(ptp, struct mv88e6xxx_chip, \
	115	ptp_clock_info)
	116
6d2ac8ee	117	extern const struct mv88e6xxx_ptp_ops mv88e6352_ptp_ops;
dfa54348	118	extern const struct mv88e6xxx_ptp_ops mv88e6165_ptp_ops;
6d2ac8ee	119
2fa8d3af BS	120	#else /* !CONFIG_NET_DSA_MV88E6XXX_PTP */
2fa8d3af BS	121
46182452	122	static inline long mv88e6xxx_hwtstamp_work(struct ptp_clock_info *ptp)
c6fe0ad2 BS	123	{
	124	return -1;
	125	}
	126
2fa8d3af BS	127	static inline int mv88e6xxx_ptp_setup(struct mv88e6xxx_chip *chip)
	128	{
	129	return 0;
	130	}
	131
46182452	132	static inline void mv88e6xxx_ptp_free(struct mv88e6xxx_chip *chip)
2fa8d3af BS	133	{
	134	}
	135
6d2ac8ee	136	static const struct mv88e6xxx_ptp_ops mv88e6352_ptp_ops = {};
dfa54348	137	static const struct mv88e6xxx_ptp_ops mv88e6165_ptp_ops = {};
6d2ac8ee	138
2fa8d3af BS	139	#endif /* CONFIG_NET_DSA_MV88E6XXX_PTP */
	140
	141	#endif /* _MV88E6XXX_PTP_H */