Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Srinivas Neeli <sneeli@xilinx.com>
To:     Srinivas Neeli <sneeli@xilinx.com>,
        "a.zummo@towertech.it" <a.zummo@towertech.it>,
        "alexandre.belloni@bootlin.com" <alexandre.belloni@bootlin.com>,
        Michal Simek <michals@xilinx.com>,
        Srinivas Goud <sgoud@xilinx.com>,
        Shubhrajyoti Datta <shubhraj@xilinx.com>
CC:     "linux-rtc@vger.kernel.org" <linux-rtc@vger.kernel.org>,
        "linux-arm-kernel@lists.infradead.org" 
        <linux-arm-kernel@lists.infradead.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        git <git@xilinx.com>
Subject: RE: [PATCH] rtc: zynqmp: Add calibration set and get support
Thread-Topic: [PATCH] rtc: zynqmp: Add calibration set and get support
Thread-Index: AQHXeIdtredUt0IFlkqy5cg9C3sl76trGtLg
Date:   Mon, 9 Aug 2021 10:05:33 +0000
Message-ID: <DM6PR02MB53863D113E167A4C789201EAAFF69@DM6PR02MB5386.namprd02.prod.outlook.com>
References: <20210714080809.34289-1-srinivas.neeli@xilinx.com>
In-Reply-To: <20210714080809.34289-1-srinivas.neeli@xilinx.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?NsAgfmOnpcInqeIiOjIb1Hoe5HJ5vPMWxwcamuE6wMqWi/6hmPbeKo9jND6d?=
 =?us-ascii?Q?H6wAdvca1xU4b9rimMJ9emruWCAkMyQXlsFRXP30LhUhFl7RYNpX8D3sXTvj?=
 =?us-ascii?Q?NPwCikyHzHwG5FDvNXeVrKMBjO4TEMmLWCRRfy8JRQ2L+8PFZ5s09eo236rw?=
 =?us-ascii?Q?yktZ6Eocky0BPTHssL5bDiRm5RgYyMxlTVXmWpYrnkbbaXvSrJHb2jthD7Pw?=
 =?us-ascii?Q?SX2KF0stDaL/N11C44yHyHFCdDq6ruqBJqPd2Q2CVAN2zDMj3i2DGzIvRp+N?=
 =?us-ascii?Q?mKS7G1H6sETygGXETCmQQK5SfzPm2azhfljfjhQC3IGEfxoxmW9OPqrJMymg?=
 =?us-ascii?Q?eRu38DmMP7OUqKMKfn7kR3BGk/Isjoj1OHjEda0dBZLpajXuJkEGQ8QsdWXs?=
 =?us-ascii?Q?4bfPEMw5825I8aephrN33++G9KpZKQAsbKEEt9xkAWrmnd/qOGRH6AcEaZe5?=
 =?us-ascii?Q?elP2INowkhLUfUfdYkxiui0UyqCBkIhy9CxXXsASmwaVN6958wsN6gRk6M4t?=
 =?us-ascii?Q?Yi7jZBLk+sYUiy1k0G8G94ZZR0xxQmvOcVtF/0gUPF5uTGpvp2qTSah2jy8M?=
 =?us-ascii?Q?X6IkEbznl8Vf/XKGfpm01ag5RbqDfE4Vskw85s627mT/1+QeFd7yP+l4gJaq?=
 =?us-ascii?Q?fsG6+fgAjcbvpDhFigSDlnQ9McEEJoUZB2zKTL4fcBIRrHTcfWDGSKYz8ynb?=
 =?us-ascii?Q?zq3B2KVtiZlNw16cviC7YVaYU5FAu1HPXyFf2zchYrGWOKaMFdfas01vM1x7?=
 =?us-ascii?Q?J8w8+oI/yCCw3YZhuWeQbm7mrWjXcOrb+8YZQRgg5VO/uN3vDvLD26Tqdwoy?=
 =?us-ascii?Q?sp0KSiZh89A+gku7OpiHO8zkpSWiB4Q3OqjklT7P1zUV0tkTYB1qvHCIfkTh?=
 =?us-ascii?Q?GxNC07UlxpV9uGWaA2O7VVI/COXgkjXINfZP+zz4CT2RI3IeV8Nw9d3uawhX?=
 =?us-ascii?Q?+9Au4iwrscx7oUq0Ez+iu5h4x1GJO+5/Kg6wVan931/KJnxa4m9n1toM9pPH?=
 =?us-ascii?Q?y+HbXwMLiHDGsxv0gCcxSMXZdb0jeaWCn0MGdEs682wGtOnorgwl8ykZ5hAe?=
 =?us-ascii?Q?hS+ludwf0imh0mtUqbL7PqZPco++aqHYMNMmjhGrGMd7Vxoj8eMKseLvQd8E?=
 =?us-ascii?Q?gv1T1sk0BYnEwFqTGfHNDGYZokf75cNaPaNCWcfNUYJEKFbAQ/xcnHaV+n7a?=
 =?us-ascii?Q?zWXPjzblekfCN0Lael04YB33P13V4O3ZgZAhBS3ZK6PLjpMAGEkUbm/6WWLC?=
 =?us-ascii?Q?kvhlE4nxIFKpPAlEo8kPdSQW8Xe2Vu2pOr4vR31EwRdhtUUexgv3C5XvUdku?=
 =?us-ascii?Q?/x/IVY0PM4TJ2rm47YsmdcY1?=
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: xilinx.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: DM6PR02MB5386.namprd02.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: b8ccb898-8f64-4d0a-f09f-08d95b1d39d5
X-MS-Exchange-CrossTenant-originalarrivaltime: 09 Aug 2021 10:05:33.0957
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 657af505-d5df-48d0-8300-c31994686c5c
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: +q+eUFQMjRsdiGgvWSBU8OQHWYfnzXImwLPILm7B2QDUQkxFqLLm01AJptzVLilv/MHEvZyN/Q5G5eoaeKn/ug==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR02MB5179
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi,

Is this patch fine?

Thanks
Srinivas Neeli

> -----Original Message-----
> From: Srinivas Neeli <srinivas.neeli@xilinx.com>
> Sent: Wednesday, July 14, 2021 1:38 PM
> To: a.zummo@towertech.it; alexandre.belloni@bootlin.com; Michal Simek
> <michals@xilinx.com>; Srinivas Goud <sgoud@xilinx.com>; Shubhrajyoti
> Datta <shubhraj@xilinx.com>
> Cc: linux-rtc@vger.kernel.org; linux-arm-kernel@lists.infradead.org; linu=
x-
> kernel@vger.kernel.org; git <git@xilinx.com>; Srinivas Neeli
> <sneeli@xilinx.com>
> Subject: [PATCH] rtc: zynqmp: Add calibration set and get support
>=20
> Zynqmp RTC controller has a calibration feature to compensate time
> deviation due to input clock inaccuracy.
> Set and get calibration API's are used for setting and getting calibratio=
n value
> from the controller calibration register.
>=20
> Signed-off-by: Srinivas Neeli <srinivas.neeli@xilinx.com>
> ---
>  drivers/rtc/rtc-zynqmp.c | 101 ++++++++++++++++++++++++++++++++----
> ---
>  1 file changed, 84 insertions(+), 17 deletions(-)
>=20
> diff --git a/drivers/rtc/rtc-zynqmp.c b/drivers/rtc/rtc-zynqmp.c index
> f440bb52be92..718f60d42760 100644
> --- a/drivers/rtc/rtc-zynqmp.c
> +++ b/drivers/rtc/rtc-zynqmp.c
> @@ -36,10 +36,16 @@
>  #define RTC_OSC_EN		BIT(24)
>  #define RTC_BATT_EN		BIT(31)
>=20
> -#define RTC_CALIB_DEF		0x198233
> +#define RTC_CALIB_DEF		0x8000
>  #define RTC_CALIB_MASK		0x1FFFFF
>  #define RTC_ALRM_MASK          BIT(1)
>  #define RTC_MSEC               1000
> +#define RTC_FR_MASK		0xF0000
> +#define RTC_SEC_MAX_VAL		0xFFFFFFFF
> +#define RTC_FR_MAX_TICKS	16
> +#define RTC_OFFSET_MAX		150000
> +#define RTC_OFFSET_MIN		-150000
> +#define RTC_PPB			1000000000LL
>=20
>  struct xlnx_rtc_dev {
>  	struct rtc_device	*rtc;
> @@ -61,13 +67,6 @@ static int xlnx_rtc_set_time(struct device *dev, struc=
t
> rtc_time *tm)
>  	 */
>  	new_time =3D rtc_tm_to_time64(tm) + 1;
>=20
> -	/*
> -	 * Writing into calibration register will clear the Tick Counter and
> -	 * force the next second to be signaled exactly in 1 second period
> -	 */
> -	xrtcdev->calibval &=3D RTC_CALIB_MASK;
> -	writel(xrtcdev->calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
> -
>  	writel(new_time, xrtcdev->reg_base + RTC_SET_TM_WR);
>=20
>  	/*
> @@ -174,14 +173,76 @@ static void xlnx_init_rtc(struct xlnx_rtc_dev
> *xrtcdev)
>  	rtc_ctrl |=3D RTC_BATT_EN;
>  	writel(rtc_ctrl, xrtcdev->reg_base + RTC_CTRL);
>=20
> -	/*
> -	 * Based on crystal freq of 33.330 KHz
> -	 * set the seconds counter and enable, set fractions counter
> -	 * to default value suggested as per design spec
> -	 * to correct RTC delay in frequency over period of time.
> +	/* Update calibvalue */
> +	xrtcdev->calibval =3D readl(xrtcdev->reg_base + RTC_CALIB_RD); }
> +
> +static int xlnx_rtc_read_offset(struct device *dev, long *offset) {
> +	struct xlnx_rtc_dev *xrtcdev =3D dev_get_drvdata(dev);
> +	long offset_val =3D 0;
> +	unsigned int tick_mult =3D RTC_PPB / (xrtcdev->calibval &
> +RTC_TICK_MASK);
> +
> +	/* Offset with seconds ticks */
> +	offset_val =3D xrtcdev->calibval & RTC_TICK_MASK;
> +	offset_val =3D offset_val - RTC_CALIB_DEF;
> +	offset_val =3D offset_val * tick_mult;
> +
> +	/* Offset with fractional ticks */
> +	if (xrtcdev->calibval & RTC_FR_EN)
> +		offset_val +=3D ((xrtcdev->calibval & RTC_FR_MASK) >>
> RTC_FR_DATSHIFT)
> +			* (tick_mult / RTC_FR_MAX_TICKS);
> +	*offset =3D offset_val;
> +
> +	return 0;
> +}
> +
> +static int xlnx_rtc_set_offset(struct device *dev, long offset) {
> +	struct xlnx_rtc_dev *xrtcdev =3D dev_get_drvdata(dev);
> +	short int  max_tick;
> +	unsigned char fract_tick =3D 0;
> +	unsigned int calibval;
> +	int fract_offset;
> +	unsigned int tick_mult =3D RTC_PPB / (xrtcdev->calibval &
> +RTC_TICK_MASK);
> +
> +	/* Make sure offset value is within supported range */
> +	if (offset < RTC_OFFSET_MIN || offset > RTC_OFFSET_MAX)
> +		return -ERANGE;
> +
> +	/* Number ticks for given offset */
> +	max_tick =3D div_s64_rem(offset, tick_mult, &fract_offset);
> +
> +	/* Number fractional ticks for given offset */
> +	if (fract_offset) {
> +		if (fract_offset < 0) {
> +			fract_offset =3D fract_offset + tick_mult;
> +			max_tick--;
> +		}
> +		if (fract_offset > (tick_mult / RTC_FR_MAX_TICKS)) {
> +			for (fract_tick =3D 1; fract_tick < 16; fract_tick++) {
> +				if (fract_offset <=3D
> +				    (fract_tick *
> +				     (tick_mult / RTC_FR_MAX_TICKS)))
> +					break;
> +			}
> +		}
> +	}
> +
> +	/* Zynqmp RTC uses second and fractional tick
> +	 * counters for compensation
>  	 */
> -	xrtcdev->calibval &=3D RTC_CALIB_MASK;
> -	writel(xrtcdev->calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
> +	calibval =3D max_tick + RTC_CALIB_DEF;
> +
> +	if (fract_tick)
> +		calibval |=3D RTC_FR_EN;
> +
> +	calibval |=3D (fract_tick << RTC_FR_DATSHIFT);
> +
> +	writel(calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
> +	xrtcdev->calibval =3D calibval;
> +
> +	return 0;
>  }
>=20
>  static const struct rtc_class_ops xlnx_rtc_ops =3D { @@ -190,6 +251,8 @@
> static const struct rtc_class_ops xlnx_rtc_ops =3D {
>  	.read_alarm	  =3D xlnx_rtc_read_alarm,
>  	.set_alarm	  =3D xlnx_rtc_set_alarm,
>  	.alarm_irq_enable =3D xlnx_rtc_alarm_irq_enable,
> +	.read_offset	  =3D xlnx_rtc_read_offset,
> +	.set_offset	  =3D xlnx_rtc_set_offset,
>  };
>=20
>  static irqreturn_t xlnx_rtc_interrupt(int irq, void *id) @@ -215,6 +278,=
7 @@
> static int xlnx_rtc_probe(struct platform_device *pdev)  {
>  	struct xlnx_rtc_dev *xrtcdev;
>  	int ret;
> +	unsigned int calibval;
>=20
>  	xrtcdev =3D devm_kzalloc(&pdev->dev, sizeof(*xrtcdev),
> GFP_KERNEL);
>  	if (!xrtcdev)
> @@ -256,9 +320,12 @@ static int xlnx_rtc_probe(struct platform_device
> *pdev)
>  	}
>=20
>  	ret =3D of_property_read_u32(pdev->dev.of_node, "calibration",
> -				   &xrtcdev->calibval);
> +				   &calibval);
>  	if (ret)
> -		xrtcdev->calibval =3D RTC_CALIB_DEF;
> +		calibval =3D RTC_CALIB_DEF;
> +	ret =3D readl(xrtcdev->reg_base + RTC_CALIB_RD);
> +	if (!ret)
> +		writel(calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
>=20
>  	xlnx_init_rtc(xrtcdev);
>=20
> --
> 2.31.1