freebsd-skq/sys/dev/psci/smccc.h
br 1ec287f9c9 Add generic arm/arm64 secure-monitor SMCCC interface and switch
PSCI code to use it.

This interface will also be used by Intel Stratix 10 platform.

This was not tested on arm due to lack of PSCI-enabled arm hardware
lying around.

Reviewed by:	andrew
Sponsored by:	DARPA, AFRL
Differential Revision:	https://reviews.freebsd.org/D21439
2019-09-13 15:56:33 +00:00

95 lines
3.4 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2018 Andrew Turner
*
* This software was developed by SRI International and the University of
* Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
* ("CTSRD"), as part of the DARPA CRASH research programme.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _PSCI_SMCCC_H_
#define _PSCI_SMCCC_H_
#define SMCCC_VERSION_MAJOR(ver) (((ver) >> 16) & 0x7fff)
#define SMCCC_VERSION_MINOR(ver) ((ver) & 0xffff)
#define SMCCC_FUNC_ID(type, call_conv, range, func) \
(((type) << 31) | \
((call_conv) << 30) | \
(((range) & 0x3f) << 24) | \
((func) & 0xffff))
#define SMCCC_YIELDING_CALL 0
#define SMCCC_FAST_CALL 1
#define SMCCC_32BIT_CALL 0
#define SMCCC_64BIT_CALL 1
#define SMCCC_ARM_ARCH_CALLS 0
#define SMCCC_CPU_SERVICE_CALLS 1
#define SMCCC_SIP_SERVICE_CALLS 2
#define SMCCC_OEM_SERVICE_CALLS 3
#define SMCCC_STD_SECURE_SERVICE_CALLS 4
#define SMCCC_STD_HYP_SERVICE_CALLS 5
#define SMCCC_VENDOR_HYP_SERVICE_CALLS 6
struct arm_smccc_res {
register_t a0;
register_t a1;
register_t a2;
register_t a3;
};
/*
* Arm Architecture Calls.
* These are documented in the document ARM DEN 0070A.
*/
#define SMCCC_VERSION \
SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 0)
#define SMCCC_ARCH_FEATURES \
SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 1)
#define SMCCC_ARCH_WORKAROUND_1 \
SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 0x8000)
#define SMCCC_ARCH_WORKAROUND_2 \
SMCCC_FUNC_ID(SMCCC_FAST_CALL, SMCCC_32BIT_CALL, 0, 0x7fff)
/* The return values from ARM DEN 0070A. */
#define SMCCC_RET_SUCCESS 0
#define SMCCC_RET_NOT_SUPPORTED -1
#define SMCCC_RET_NOT_REQUIRED -2
int32_t smccc_arch_features(uint32_t);
int smccc_arch_workaround_1(void);
int smccc_arch_workaround_2(int);
int arm_smccc_smc(register_t, register_t, register_t, register_t, register_t,
register_t, register_t, register_t, struct arm_smccc_res *res);
int arm_smccc_hvc(register_t, register_t, register_t, register_t, register_t,
register_t, register_t, register_t, struct arm_smccc_res *res);
#endif /* _PSCI_SMCCC_H_ */