xref: /freebsd/sys/dev/firmware/arm/scmi_protocols.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2022 Ruslan Bukin <br@bsdpad.com>
5  *
6  * This work was supported by Innovate UK project 105694, "Digital Security
7  * by Design (DSbD) Technology Platform Prototype".
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef	_ARM64_SCMI_SCMI_PROTOCOLS_H_
32 #define	_ARM64_SCMI_SCMI_PROTOCOLS_H_
33 
34 enum scmi_std_protocol {
35 	SCMI_PROTOCOL_ID_BASE = 0x10,
36 	SCMI_PROTOCOL_ID_POWER_DOMAIN = 0x11,
37 	SCMI_PROTOCOL_ID_SYSTEM = 0x12,
38 	SCMI_PROTOCOL_ID_PERF = 0x13,
39 	SCMI_PROTOCOL_ID_CLOCK = 0x14,
40 	SCMI_PROTOCOL_ID_SENSOR = 0x15,
41 	SCMI_PROTOCOL_ID_RESET_DOMAIN = 0x16,
42 	SCMI_PROTOCOL_ID_VOLTAGE_DOMAIN = 0x17,
43 };
44 
45 enum scmi_status_code {
46 	SCMI_SUCCESS =  0,
47 	SCMI_NOT_SUPPORTED = -1,
48 	SCMI_INVALID_PARAMETERS = -2,
49 	SCMI_DENIED = -3,
50 	SCMI_NOT_FOUND = -4,
51 	SCMI_OUT_OF_RANGE = -5,
52 	SCMI_BUSY = -6,
53 	SCMI_COMMS_ERROR = -7,
54 	SCMI_GENERIC_ERROR = -8,
55 	SCMI_HARDWARE_ERROR = -9,
56 	SCMI_PROTOCOL_ERROR = -10,
57 };
58 
59 #define	SCMI_PROTOCOL_ATTRIBUTES	0x1
60 
61 #endif /* !_ARM64_SCMI_SCMI_PROTOCOLS_H_ */
62