xref: /freebsd/sys/powerpc/pseries/rtas_dev.c (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2011 Nathan Whitehorn
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 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/module.h>
35 #include <sys/bus.h>
36 #include <sys/conf.h>
37 #include <sys/clock.h>
38 #include <sys/cpu.h>
39 #include <sys/eventhandler.h>
40 #include <sys/kernel.h>
41 #include <sys/reboot.h>
42 #include <sys/sysctl.h>
43 
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/openfirm.h>
46 
47 #include <machine/rtas.h>
48 
49 #include "clock_if.h"
50 
51 static int	rtasdev_probe(device_t);
52 static int	rtasdev_attach(device_t);
53 /* clock interface */
54 static int	rtas_gettime(device_t dev, struct timespec *ts);
55 static int	rtas_settime(device_t dev, struct timespec *ts);
56 
57 static void	rtas_shutdown(void *arg, int howto);
58 
59 static device_method_t  rtasdev_methods[] = {
60 	/* Device interface */
61 	DEVMETHOD(device_probe,		rtasdev_probe),
62 	DEVMETHOD(device_attach,	rtasdev_attach),
63 
64 	/* clock interface */
65 	DEVMETHOD(clock_gettime,	rtas_gettime),
66 	DEVMETHOD(clock_settime,	rtas_settime),
67 
68 	{ 0, 0 },
69 };
70 
71 static driver_t rtasdev_driver = {
72 	"rtas",
73 	rtasdev_methods,
74 	0
75 };
76 
77 DRIVER_MODULE(rtasdev, ofwbus, rtasdev_driver, 0, 0);
78 
79 static int
80 rtasdev_probe(device_t dev)
81 {
82 	const char *name = ofw_bus_get_name(dev);
83 
84 	if (strcmp(name, "rtas") != 0)
85 		return (ENXIO);
86 	if (!rtas_exists())
87 		return (ENXIO);
88 
89 	device_set_desc(dev, "Run-Time Abstraction Services");
90 	return (0);
91 }
92 
93 static int
94 rtasdev_attach(device_t dev)
95 {
96 	if (rtas_token_lookup("get-time-of-day") != -1)
97 		clock_register(dev, 2000);
98 
99 	EVENTHANDLER_REGISTER(shutdown_final, rtas_shutdown, NULL,
100 	    SHUTDOWN_PRI_LAST);
101 
102 	return (0);
103 }
104 
105 static int
106 rtas_gettime(device_t dev, struct timespec *ts) {
107 	struct clocktime ct;
108 	cell_t tod[8];
109 	cell_t token;
110 	int error;
111 
112 	token = rtas_token_lookup("get-time-of-day");
113 	if (token == -1)
114 		return (ENXIO);
115 	error = rtas_call_method(token, 0, 8, &tod[0], &tod[1], &tod[2],
116 	    &tod[3], &tod[4], &tod[5], &tod[6], &tod[7]);
117 	if (error < 0)
118 		return (ENXIO);
119 	if (tod[0] != 0)
120 		return ((tod[0] == -1) ? ENXIO : EAGAIN);
121 
122 	ct.year = tod[1];
123 	ct.mon  = tod[2];
124 	ct.day  = tod[3];
125 	ct.hour = tod[4];
126 	ct.min  = tod[5];
127 	ct.sec  = tod[6];
128 	ct.nsec = tod[7];
129 
130 	return (clock_ct_to_ts(&ct, ts));
131 }
132 
133 static int
134 rtas_settime(device_t dev, struct timespec *ts)
135 {
136 	struct clocktime ct;
137 	cell_t token, status;
138 	int error;
139 
140 	token = rtas_token_lookup("set-time-of-day");
141 	if (token == -1)
142 		return (ENXIO);
143 
144 	clock_ts_to_ct(ts, &ct);
145 	error = rtas_call_method(token, 7, 1, ct.year, ct.mon, ct.day, ct.hour,
146 	    ct.min, ct.sec, ct.nsec, &status);
147 	if (error < 0)
148 		return (ENXIO);
149 	if (status != 0)
150 		return (((int)status < 0) ? ENXIO : EAGAIN);
151 
152 	return (0);
153 }
154 
155 static void
156 rtas_shutdown(void *arg, int howto)
157 {
158 	cell_t token, status;
159 
160 	if (howto & RB_HALT) {
161 		token = rtas_token_lookup("power-off");
162 		if (token == -1)
163 			return;
164 
165 		rtas_call_method(token, 2, 1, 0, 0, &status);
166 	} else {
167 		token = rtas_token_lookup("system-reboot");
168 		if (token == -1)
169 			return;
170 
171 		rtas_call_method(token, 0, 1, &status);
172 	}
173 }
174