[mirror_ubuntu-bionic-kernel.git] / drivers / net / ethernet / stmicro / stmmac / stmmac_ptp.h

/******************************************************************************
  PTP Header file

  Copyright (C) 2013  Vayavya Labs Pvt Ltd

  This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

  This program is distributed in the hope 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.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Author: Rayagond Kokatanur <rayagond@vayavyalabs.com>
******************************************************************************/

#ifndef	__STMMAC_PTP_H__
#define	__STMMAC_PTP_H__

#define	PTP_GMAC4_OFFSET	0xb00
#define	PTP_GMAC3_X_OFFSET	0x700

/* IEEE 1588 PTP register offsets */
#define	PTP_TCR		0x00	/* Timestamp Control Reg */
#define	PTP_SSIR	0x04	/* Sub-Second Increment Reg */
#define	PTP_STSR	0x08	/* System Time – Seconds Regr */
#define	PTP_STNSR	0x0c	/* System Time – Nanoseconds Reg */
#define	PTP_STSUR	0x10	/* System Time – Seconds Update Reg */
#define	PTP_STNSUR	0x14	/* System Time – Nanoseconds Update Reg */
#define	PTP_TAR		0x18	/* Timestamp Addend Reg */

#define	PTP_STNSUR_ADDSUB_SHIFT	31
#define	PTP_DIGITAL_ROLLOVER_MODE	0x3B9ACA00	/* 10e9-1 ns */
#define	PTP_BINARY_ROLLOVER_MODE	0x80000000	/* ~0.466 ns */

/* PTP Timestamp control register defines */
#define	PTP_TCR_TSENA		BIT(0)	/* Timestamp Enable */
#define	PTP_TCR_TSCFUPDT	BIT(1)	/* Timestamp Fine/Coarse Update */
#define	PTP_TCR_TSINIT		BIT(2)	/* Timestamp Initialize */
#define	PTP_TCR_TSUPDT		BIT(3)	/* Timestamp Update */
#define	PTP_TCR_TSTRIG		BIT(4)	/* Timestamp Interrupt Trigger Enable */
#define	PTP_TCR_TSADDREG	BIT(5)	/* Addend Reg Update */
#define	PTP_TCR_TSENALL		BIT(8)	/* Enable Timestamp for All Frames */
#define	PTP_TCR_TSCTRLSSR	BIT(9)	/* Digital or Binary Rollover Control */
/* Enable PTP packet Processing for Version 2 Format */
#define	PTP_TCR_TSVER2ENA	BIT(10)
/* Enable Processing of PTP over Ethernet Frames */
#define	PTP_TCR_TSIPENA		BIT(11)
/* Enable Processing of PTP Frames Sent over IPv6-UDP */
#define	PTP_TCR_TSIPV6ENA	BIT(12)
/* Enable Processing of PTP Frames Sent over IPv4-UDP */
#define	PTP_TCR_TSIPV4ENA	BIT(13)
/* Enable Timestamp Snapshot for Event Messages */
#define	PTP_TCR_TSEVNTENA	BIT(14)
/* Enable Snapshot for Messages Relevant to Master */
#define	PTP_TCR_TSMSTRENA	BIT(15)
/* Select PTP packets for Taking Snapshots */
#define	PTP_TCR_SNAPTYPSEL_1	GENMASK(17, 16)
/* Enable MAC address for PTP Frame Filtering */
#define	PTP_TCR_TSENMACADDR	BIT(18)

/* SSIR defines */
#define	PTP_SSIR_SSINC_MASK		0xff
#define	GMAC4_PTP_SSIR_SSINC_SHIFT	16

#endif	/* __STMMAC_PTP_H__ */
Commit	Line	Data
891434b1 RK	1	/******************************************************************************
	2	PTP Header file
	3
	4	Copyright (C) 2013 Vayavya Labs Pvt Ltd
	5
	6	This program is free software; you can redistribute it and/or modify it
	7	under the terms and conditions of the GNU General Public License,
	8	version 2, as published by the Free Software Foundation.
	9
	10	This program is distributed in the hope it will be useful, but WITHOUT
	11	ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	more details.
	14
	15	You should have received a copy of the GNU General Public License along with
	16	this program; if not, write to the Free Software Foundation, Inc.,
	17	51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	18
	19	The full GNU General Public License is included in this distribution in
	20	the file called "COPYING".
	21
	22	Author: Rayagond Kokatanur <rayagond@vayavyalabs.com>
	23	******************************************************************************/
	24
d2042052 GC	25	#ifndef __STMMAC_PTP_H__
d2042052 GC	26	#define __STMMAC_PTP_H__
891434b1	27
d2042052 GC	28	#define PTP_GMAC4_OFFSET 0xb00
d2042052 GC	29	#define PTP_GMAC3_X_OFFSET 0x700
891434b1	30
d2042052 GC	31	/* IEEE 1588 PTP register offsets */
	32	#define PTP_TCR 0x00 /* Timestamp Control Reg */
	33	#define PTP_SSIR 0x04 /* Sub-Second Increment Reg */
	34	#define PTP_STSR 0x08 /* System Time – Seconds Regr */
	35	#define PTP_STNSR 0x0c /* System Time – Nanoseconds Reg */
	36	#define PTP_STSUR 0x10 /* System Time – Seconds Update Reg */
	37	#define PTP_STNSUR 0x14 /* System Time – Nanoseconds Update Reg */
	38	#define PTP_TAR 0x18 /* Timestamp Addend Reg */
891434b1	39
d2042052 GC	40	#define PTP_STNSUR_ADDSUB_SHIFT 31
	41	#define PTP_DIGITAL_ROLLOVER_MODE 0x3B9ACA00 /* 10e9-1 ns */
	42	#define PTP_BINARY_ROLLOVER_MODE 0x80000000 /* ~0.466 ns */
891434b1	43
d2042052 GC	44	/* PTP Timestamp control register defines */
	45	#define PTP_TCR_TSENA BIT(0) /* Timestamp Enable */
	46	#define PTP_TCR_TSCFUPDT BIT(1) /* Timestamp Fine/Coarse Update */
	47	#define PTP_TCR_TSINIT BIT(2) /* Timestamp Initialize */
	48	#define PTP_TCR_TSUPDT BIT(3) /* Timestamp Update */
	49	#define PTP_TCR_TSTRIG BIT(4) /* Timestamp Interrupt Trigger Enable */
	50	#define PTP_TCR_TSADDREG BIT(5) /* Addend Reg Update */
	51	#define PTP_TCR_TSENALL BIT(8) /* Enable Timestamp for All Frames */
	52	#define PTP_TCR_TSCTRLSSR BIT(9) /* Digital or Binary Rollover Control */
891434b1	53	/* Enable PTP packet Processing for Version 2 Format */
d2042052	54	#define PTP_TCR_TSVER2ENA BIT(10)
891434b1	55	/* Enable Processing of PTP over Ethernet Frames */
d2042052	56	#define PTP_TCR_TSIPENA BIT(11)
891434b1	57	/* Enable Processing of PTP Frames Sent over IPv6-UDP */
d2042052	58	#define PTP_TCR_TSIPV6ENA BIT(12)
891434b1	59	/* Enable Processing of PTP Frames Sent over IPv4-UDP */
d2042052	60	#define PTP_TCR_TSIPV4ENA BIT(13)
891434b1	61	/* Enable Timestamp Snapshot for Event Messages */
d2042052	62	#define PTP_TCR_TSEVNTENA BIT(14)
891434b1	63	/* Enable Snapshot for Messages Relevant to Master */
d2042052	64	#define PTP_TCR_TSMSTRENA BIT(15)
891434b1	65	/* Select PTP packets for Taking Snapshots */
d2042052	66	#define PTP_TCR_SNAPTYPSEL_1 GENMASK(17, 16)
891434b1	67	/* Enable MAC address for PTP Frame Filtering */
d2042052 GC	68	#define PTP_TCR_TSENMACADDR BIT(18)
	69
	70	/* SSIR defines */
	71	#define PTP_SSIR_SSINC_MASK 0xff
	72	#define GMAC4_PTP_SSIR_SSINC_SHIFT 16
891434b1	73
d2042052	74	#endif /* __STMMAC_PTP_H__ */