Index: stable/11/share/man/man4/man4.arm/Makefile =================================================================== --- stable/11/share/man/man4/man4.arm/Makefile (revision 346525) +++ stable/11/share/man/man4/man4.arm/Makefile (revision 346526) @@ -1,20 +1,21 @@ # $FreeBSD$ PACKAGE=runtime-manuals MAN= cgem.4 \ devcfg.4 \ imx6_ahci.4 \ + imx6_snvs.4 \ imx_wdog.4 \ mge.4 \ npe.4 \ ti_adc.4 MLINKS= cgem.4 if_cgem.4 MLINKS+= imx_wdog.4 imxwdt.4 MLINKS+= mge.4 if_mge.4 MLINKS+=npe.4 if_npe.4 MANSUBDIR=/arm .include Index: stable/11/share/man/man4/man4.arm/imx6_snvs.4 =================================================================== --- stable/11/share/man/man4/man4.arm/imx6_snvs.4 (nonexistent) +++ stable/11/share/man/man4/man4.arm/imx6_snvs.4 (revision 346526) @@ -0,0 +1,78 @@ +.\" +.\" Copyright (c) 2018 Ian Lepore +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd July 8, 2018 +.Dt IMX6_SNVS 4 +.Os +.Sh NAME +.Nm imx6_snvs +.Nd device driver for the NXP i.MX6 on-chip Realtime Clock +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device imx6_snvs" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +imx6_snvs_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides +support for the i.MX6 on-chip realtime clock. +It provides the time of day with a resolution of approximately +30 microseconds. +.Pp +.Sq SNVS +stands for Secure Non-Volatile Storage, and refers to the subsystem +within the chip that (optionally) remains powered by a battery when +the rest of the system is powered down. +The on-chip realtime clock is part of that subsystem. +Other features of the SNVS subsystem are related to security, tamper +monitoring, and power control; the +.Nm +driver does not currently support those features. +.Pp +Many i.MX6 systems do not use a battery to provide power to the SNVS +due to its relatively high power draw. In such systems, this driver +is able to provide a very accurate time following a reboot, but cannot +provide time at all if the power is cycled. If the system provides an +i2c or other type of alternate realtime clock with lower resolution, +there is value in configuring both clock drivers. +Doing so allows SNVS to provide accurate time after a reboot, while the +external clock provides approximate time after power cycling. +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 12.0 . Property changes on: stable/11/share/man/man4/man4.arm/imx6_snvs.4 ___________________________________________________________________ Added: svn:eol-style ## -0,0 +1 ## +native \ No newline at end of property Added: svn:keywords ## -0,0 +1 ## +FreeBSD=%H \ No newline at end of property Added: svn:mime-type ## -0,0 +1 ## +text/plain \ No newline at end of property Index: stable/11/sys/arm/freescale/imx/imx6_snvs.c =================================================================== --- stable/11/sys/arm/freescale/imx/imx6_snvs.c (revision 346525) +++ stable/11/sys/arm/freescale/imx/imx6_snvs.c (revision 346526) @@ -1,228 +1,239 @@ /*- * Copyright (c) 2017 Ian Lepore * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); /* * Driver for imx6 Secure Non-Volatile Storage system, which really means "all * the stuff that's powered by a battery when main power is off". This includes * realtime clock, tamper monitor, and power-management functions. Currently * this driver provides only realtime clock support. */ #include #include #include #include #include #include #include #include #include "clock_if.h" #define SNVS_LPCR 0x38 /* Control register */ #define LPCR_LPCALB_VAL_SHIFT 10 /* Calibration shift */ #define LPCR_LPCALB_VAL_MASK 0x1f /* Calibration mask */ #define LPCR_LPCALB_EN (1u << 8) /* Calibration enable */ #define LPCR_SRTC_ENV (1u << 0) /* RTC enabled/valid */ #define SNVS_LPSRTCMR 0x50 /* Counter MSB */ #define SNVS_LPSRTCLR 0x54 /* Counter LSB */ #define RTC_RESOLUTION_US (1000000 / 32768) /* 32khz clock */ /* * The RTC is a 47-bit counter clocked at 32KHz and organized as a 32.15 * fixed-point binary value. Shifting by SBT_LSB bits translates between * counter and sbintime values. */ #define RTC_BITS 47 #define SBT_BITS 64 #define SBT_LSB (SBT_BITS - RTC_BITS) struct snvs_softc { device_t dev; struct resource * memres; uint32_t lpcr; }; static struct ofw_compat_data compat_data[] = { {"fsl,sec-v4.0-mon", true}, {NULL, false} }; static inline uint32_t RD4(struct snvs_softc *sc, bus_size_t offset) { return (bus_read_4(sc->memres, offset)); } static inline void WR4(struct snvs_softc *sc, bus_size_t offset, uint32_t value) { bus_write_4(sc->memres, offset, value); } static void snvs_rtc_enable(struct snvs_softc *sc, bool enable) { uint32_t enbit; if (enable) sc->lpcr |= LPCR_SRTC_ENV; else sc->lpcr &= ~LPCR_SRTC_ENV; WR4(sc, SNVS_LPCR, sc->lpcr); /* Wait for the hardware to achieve the requested state. */ enbit = sc->lpcr & LPCR_SRTC_ENV; while ((RD4(sc, SNVS_LPCR) & LPCR_SRTC_ENV) != enbit) continue; } static int snvs_gettime(device_t dev, struct timespec *ts) { struct snvs_softc *sc; sbintime_t counter1, counter2; sc = device_get_softc(dev); /* If the clock is not enabled and valid, we can't help. */ if (!(RD4(sc, SNVS_LPCR) & LPCR_SRTC_ENV)) { return (EINVAL); } /* * The counter is clocked asynchronously to cpu accesses; read and * assemble the pieces of the counter until we get the same value twice. * The counter is 47 bits, organized as a 32.15 binary fixed-point * value. If we shift it up to the high order part of a 64-bit word it * turns into an sbintime. */ do { counter1 = (uint64_t)RD4(sc, SNVS_LPSRTCMR) << (SBT_LSB + 32); counter1 |= (uint64_t)RD4(sc, SNVS_LPSRTCLR) << (SBT_LSB); counter2 = (uint64_t)RD4(sc, SNVS_LPSRTCMR) << (SBT_LSB + 32); counter2 |= (uint64_t)RD4(sc, SNVS_LPSRTCLR) << (SBT_LSB); } while (counter1 != counter2); *ts = sbttots(counter1); + clock_dbgprint_ts(sc->dev, CLOCK_DBG_READ, ts); + return (0); } static int -snvs_settime(device_t dev, struct timespec *unused) +snvs_settime(device_t dev, struct timespec *ts) { struct snvs_softc *sc; - struct bintime bt; sbintime_t sbt; sc = device_get_softc(dev); /* - * Ignore the inaccurate time passed in from the common clock code and - * obtain a time worthy of our 30us accuracy. + * The hardware format is the same as sbt (with fewer fractional bits), + * so first convert the time to sbt. It takes two clock cycles for the + * counter to start after setting the enable bit, so add two SBT_LSBs to + * what we're about to set. */ - bintime(&bt); - bt.sec -= utc_offset(); - sbt = bttosbt(bt); - - /* - * It takes two clock cycles for the counter to start after setting the - * enable bit, so add two SBT_LSBs to what we're about to set. - */ + sbt = tstosbt(*ts); sbt += 2 << SBT_LSB; snvs_rtc_enable(sc, false); WR4(sc, SNVS_LPSRTCMR, (uint32_t)(sbt >> (SBT_LSB + 32))); WR4(sc, SNVS_LPSRTCLR, (uint32_t)(sbt >> (SBT_LSB))); snvs_rtc_enable(sc, true); + clock_dbgprint_ts(sc->dev, CLOCK_DBG_WRITE, ts); + return (0); } static int snvs_probe(device_t dev) { if (!ofw_bus_status_okay(dev)) return (ENXIO); if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data) return (ENXIO); device_set_desc(dev, "i.MX6 SNVS RTC"); return (BUS_PROBE_DEFAULT); } static int snvs_attach(device_t dev) { struct snvs_softc *sc; int rid; sc = device_get_softc(dev); sc->dev = dev; rid = 0; sc->memres = bus_alloc_resource_any(sc->dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); if (sc->memres == NULL) { device_printf(sc->dev, "could not allocate registers\n"); return (ENXIO); } clock_register(sc->dev, RTC_RESOLUTION_US); return (0); } +static int +snvs_detach(device_t dev) +{ + struct snvs_softc *sc; + + sc = device_get_softc(dev); + clock_unregister(sc->dev); + bus_release_resource(sc->dev, SYS_RES_MEMORY, 0, sc->memres); + return (0); +} + static device_method_t snvs_methods[] = { DEVMETHOD(device_probe, snvs_probe), DEVMETHOD(device_attach, snvs_attach), + DEVMETHOD(device_detach, snvs_detach), /* clock_if methods */ DEVMETHOD(clock_gettime, snvs_gettime), DEVMETHOD(clock_settime, snvs_settime), DEVMETHOD_END }; static driver_t snvs_driver = { "snvs", snvs_methods, sizeof(struct snvs_softc), }; static devclass_t snvs_devclass; DRIVER_MODULE(snvs, simplebus, snvs_driver, snvs_devclass, 0, 0); +SIMPLEBUS_PNP_INFO(compat_data); Index: stable/11/sys/modules/imx/Makefile =================================================================== --- stable/11/sys/modules/imx/Makefile (revision 346525) +++ stable/11/sys/modules/imx/Makefile (revision 346526) @@ -1,11 +1,12 @@ # $FreeBSD$ # Build modules specific to freescale/nxp imx-family SoCs. SUBDIR = \ ../ffec \ imx6_ahci \ + imx6_snvs \ imx_i2c \ imx_spi \ imx_wdog \ .include Index: stable/11/sys/modules/imx/imx6_snvs/Makefile =================================================================== --- stable/11/sys/modules/imx/imx6_snvs/Makefile (nonexistent) +++ stable/11/sys/modules/imx/imx6_snvs/Makefile (revision 346526) @@ -0,0 +1,15 @@ +# $FreeBSD$ + +.PATH: ${SRCTOP}/sys/arm/freescale/imx + +KMOD= imx6_snvs +SRCS= imx6_snvs.c + +# Generated files... +SRCS+= \ + bus_if.h \ + clock_if.h \ + device_if.h \ + ofw_bus_if.h \ + +.include Property changes on: stable/11/sys/modules/imx/imx6_snvs/Makefile ___________________________________________________________________ Added: svn:eol-style ## -0,0 +1 ## +native \ No newline at end of property Added: svn:keywords ## -0,0 +1 ## +FreeBSD=%H \ No newline at end of property Added: svn:mime-type ## -0,0 +1 ## +text/plain \ No newline at end of property Index: stable/11 =================================================================== --- stable/11 (revision 346525) +++ stable/11 (revision 346526) Property changes on: stable/11 ___________________________________________________________________ Modified: svn:mergeinfo ## -0,0 +0,1 ## Merged /head:r336094,336096