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