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