xref: /freebsd/sys/powerpc/include/rtas.h (revision fdafd315ad0d0f28a11b9fb4476a9ab059c62b92)
117879090SNathan Whitehorn /*-
2*4d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
371e3c308SPedro F. Giffuni  *
417879090SNathan Whitehorn  * Copyright (c) 2011 Nathan Whitehorn
517879090SNathan Whitehorn  * All rights reserved.
617879090SNathan Whitehorn  *
717879090SNathan Whitehorn  * Redistribution and use in source and binary forms, with or without
817879090SNathan Whitehorn  * modification, are permitted provided that the following conditions
917879090SNathan Whitehorn  * are met:
1017879090SNathan Whitehorn  * 1. Redistributions of source code must retain the above copyright
1117879090SNathan Whitehorn  *    notice, this list of conditions and the following disclaimer.
1217879090SNathan Whitehorn  * 2. Redistributions in binary form must reproduce the above copyright
1317879090SNathan Whitehorn  *    notice, this list of conditions and the following disclaimer in the
1417879090SNathan Whitehorn  *    documentation and/or other materials provided with the distribution.
1517879090SNathan Whitehorn  *
1617879090SNathan Whitehorn  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1717879090SNathan Whitehorn  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1817879090SNathan Whitehorn  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1917879090SNathan Whitehorn  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
2017879090SNathan Whitehorn  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2117879090SNathan Whitehorn  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2217879090SNathan Whitehorn  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2317879090SNathan Whitehorn  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2417879090SNathan Whitehorn  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2517879090SNathan Whitehorn  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2617879090SNathan Whitehorn  * SUCH DAMAGE.
2717879090SNathan Whitehorn  */
2817879090SNathan Whitehorn 
2917879090SNathan Whitehorn #ifndef _MACHINE_RTAS_H_
3017879090SNathan Whitehorn #define _MACHINE_RTAS_H_
3117879090SNathan Whitehorn 
3217879090SNathan Whitehorn #include <sys/types.h>
3317879090SNathan Whitehorn #include <dev/ofw/openfirm.h>
3417879090SNathan Whitehorn 
3517879090SNathan Whitehorn /*
3617879090SNathan Whitehorn  * RTAS functions are defined by 32-bit integer tokens. These vary from
3717879090SNathan Whitehorn  * system to system, and can be looked up from their standardized names
3817879090SNathan Whitehorn  * using rtas_token_lookup(). If RTAS is not available, rtas_token_lookup()
3917879090SNathan Whitehorn  * and rtas_call_method() return -1; this can be checked in advance using
4017879090SNathan Whitehorn  * rtas_exists(). Otherwise, rtas_call_method() returns one of the RTAS
4117879090SNathan Whitehorn  * status codes from the bottom of this file.
4217879090SNathan Whitehorn  */
4317879090SNathan Whitehorn 
4417879090SNathan Whitehorn int rtas_exists(void);
4517879090SNathan Whitehorn int rtas_call_method(cell_t token, int nargs, int nreturns, ...);
4617879090SNathan Whitehorn cell_t rtas_token_lookup(const char *method);
4717879090SNathan Whitehorn 
4817879090SNathan Whitehorn /* RTAS Status Codes: see CHRP or PAPR specification */
4917879090SNathan Whitehorn #define	RTAS_OK				0
5017879090SNathan Whitehorn #define	RTAS_HW_ERROR			-1
5117879090SNathan Whitehorn #define	RTAS_BUSY			-2
5217879090SNathan Whitehorn #define	RTAS_PARAM_ERROR		-3
5317879090SNathan Whitehorn #define	RTAS_STATE_CHANGE		-7
5417879090SNathan Whitehorn #define	RTAS_VENDOR_BEGIN		9000
5517879090SNathan Whitehorn #define	RTAS_EXTENDED_DELAY		9900
5617879090SNathan Whitehorn #define	RTAS_ISOLATION_ERROR		-9000
5717879090SNathan Whitehorn #define	RTAS_VENDOR_ERROR_BEGIN		-9004
5817879090SNathan Whitehorn 
5917879090SNathan Whitehorn #endif /* _MACHINE_RTAS_H_ */
60