sys/mips/cavium/octeon_rtc.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2010 Juli Mallett <jmallett@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35 #include <sys/systm.h>
  36 #include <sys/bus.h>
  37 #include <sys/clock.h>
  38 #include <sys/kernel.h>
  39 #include <sys/lock.h>
  40 #include <sys/module.h>
  41
  42 #include <contrib/octeon-sdk/cvmx.h>
  43 #include <contrib/octeon-sdk/cvmx-rtc.h>
  44
  45 #include "clock_if.h"
  46
  47 static int      octeon_rtc_attach(device_t dev);
  48 static int      octeon_rtc_probe(device_t dev);
  49
  50 static int      octeon_rtc_settime(device_t dev, struct timespec *ts);
  51 static int      octeon_rtc_gettime(device_t dev, struct timespec *ts);
  52
  53 static device_method_t octeon_rtc_methods[] = {
  54         /* Device interface */
  55         DEVMETHOD(device_probe,         octeon_rtc_probe),
  56         DEVMETHOD(device_attach,        octeon_rtc_attach),
  57
  58         /* clock interface */
  59         DEVMETHOD(clock_gettime,        octeon_rtc_gettime),
  60         DEVMETHOD(clock_settime,        octeon_rtc_settime),
  61
  62         { 0, 0 }
  63 };
  64
  65 static driver_t octeon_rtc_driver = {
  66         "rtc",
  67         octeon_rtc_methods,
  68         0
  69 };
  70 static devclass_t octeon_rtc_devclass;
  71 DRIVER_MODULE(rtc, nexus, octeon_rtc_driver, octeon_rtc_devclass, 0, 0);
  72
  73 static int
  74 octeon_rtc_probe(device_t dev)
  75 {
  76         cvmx_rtc_options_t supported;
  77
  78         if (device_get_unit(dev) != 0)
  79                 return (ENXIO);
  80
  81         supported = cvmx_rtc_supported();
  82         if (supported == 0)
  83                 return (ENXIO);
  84
  85         device_set_desc(dev, "Cavium Octeon Realtime Clock");
  86         return (BUS_PROBE_NOWILDCARD);
  87 }
  88
  89 static int
  90 octeon_rtc_attach(device_t dev)
  91 {
  92         cvmx_rtc_options_t supported;
  93
  94         supported = cvmx_rtc_supported();
  95         if ((supported & CVMX_RTC_READ) == 0)
  96                 return (ENXIO);
  97
  98         clock_register(dev, 1000000);
  99         return (0);
 100 }
 101
 102 static int
 103 octeon_rtc_settime(device_t dev, struct timespec *ts)
 104 {
 105         cvmx_rtc_options_t supported;
 106         uint32_t status;
 107
 108         supported = cvmx_rtc_supported();
 109         if ((supported & CVMX_RTC_WRITE) == 0)
 110                 return (ENOTSUP);
 111
 112         status = cvmx_rtc_write(ts->tv_sec);
 113         if (status != 0)
 114                 return (EINVAL);
 115
 116         return (0);
 117 }
 118
 119 static int
 120 octeon_rtc_gettime(device_t dev, struct timespec *ts)
 121 {
 122         uint32_t secs;
 123
 124         secs = cvmx_rtc_read();
 125         if (secs == 0)
 126                 return (ENOTSUP);
 127
 128         ts->tv_sec = secs;
 129         ts->tv_nsec = 0;
 130
 131         return (0);
 132 }