xref: /freebsd/sys/powerpc/include/rtas.h (revision 1db64f89363c97858961c4df0b7d02f3223723cf)
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 #ifndef _MACHINE_RTAS_H_
30 #define _MACHINE_RTAS_H_
31 
32 #include <sys/types.h>
33 #include <dev/ofw/openfirm.h>
34 
35 /*
36  * RTAS functions are defined by 32-bit integer tokens. These vary from
37  * system to system, and can be looked up from their standardized names
38  * using rtas_token_lookup(). If RTAS is not available, rtas_token_lookup()
39  * and rtas_call_method() return -1; this can be checked in advance using
40  * rtas_exists(). Otherwise, rtas_call_method() returns one of the RTAS
41  * status codes from the bottom of this file.
42  */
43 
44 int rtas_exists(void);
45 int rtas_call_method(cell_t token, int nargs, int nreturns, ...);
46 cell_t rtas_token_lookup(const char *method);
47 
48 /* RTAS Status Codes: see CHRP or PAPR specification */
49 #define	RTAS_OK				0
50 #define	RTAS_HW_ERROR			-1
51 #define	RTAS_BUSY			-2
52 #define	RTAS_PARAM_ERROR		-3
53 #define	RTAS_STATE_CHANGE		-7
54 #define	RTAS_VENDOR_BEGIN		9000
55 #define	RTAS_EXTENDED_DELAY		9900
56 #define	RTAS_ISOLATION_ERROR		-9000
57 #define	RTAS_VENDOR_ERROR_BEGIN		-9004
58 
59 #endif /* _MACHINE_RTAS_H_ */
60