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