xref: /linux/include/linux/psp-platform-access.h (revision a1ff5a7d78a036d6c2178ee5acd6ba4946243800)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 
3 #ifndef __PSP_PLATFORM_ACCESS_H
4 #define __PSP_PLATFORM_ACCESS_H
5 
6 #include <linux/psp.h>
7 
8 enum psp_platform_access_msg {
9 	PSP_CMD_NONE			= 0x0,
10 	PSP_CMD_HSTI_QUERY		= 0x14,
11 	PSP_I2C_REQ_BUS_CMD		= 0x64,
12 	PSP_DYNAMIC_BOOST_GET_NONCE,
13 	PSP_DYNAMIC_BOOST_SET_UID,
14 	PSP_DYNAMIC_BOOST_GET_PARAMETER,
15 	PSP_DYNAMIC_BOOST_SET_PARAMETER,
16 };
17 
18 struct psp_req_buffer_hdr {
19 	u32 payload_size;
20 	u32 status;
21 } __packed;
22 
23 struct psp_request {
24 	struct psp_req_buffer_hdr header;
25 	void *buf;
26 } __packed;
27 
28 /**
29  * psp_send_platform_access_msg() - Send a message to control platform features
30  *
31  * This function is intended to be used by drivers outside of ccp to communicate
32  * with the platform.
33  *
34  * Returns:
35  *  0:           success
36  *  -%EBUSY:     mailbox in recovery or in use
37  *  -%ENODEV:    driver not bound with PSP device
38  *  -%ETIMEDOUT: request timed out
39  *  -%EIO:       unknown error (see kernel log)
40  */
41 int psp_send_platform_access_msg(enum psp_platform_access_msg, struct psp_request *req);
42 
43 /**
44  * psp_ring_platform_doorbell() - Ring platform doorbell
45  *
46  * This function is intended to be used by drivers outside of ccp to ring the
47  * platform doorbell with a message.
48  *
49  * Returns:
50  *  0:           success
51  *  -%EBUSY:     mailbox in recovery or in use
52  *  -%ENODEV:    driver not bound with PSP device
53  *  -%ETIMEDOUT: request timed out
54  *  -%EIO:       error will be stored in result argument
55  */
56 int psp_ring_platform_doorbell(int msg, u32 *result);
57 
58 /**
59  * psp_check_platform_access_status() - Checks whether platform features is ready
60  *
61  * This function is intended to be used by drivers outside of ccp to determine
62  * if platform features has initialized.
63  *
64  * Returns:
65  * 0          platform features is ready
66  * -%ENODEV   platform features is not ready or present
67  */
68 int psp_check_platform_access_status(void);
69 
70 #endif /* __PSP_PLATFORM_ACCESS_H */
71