[linux-block.git] / include / linux / psp-platform-access.h

/* SPDX-License-Identifier: GPL-2.0-only */

#ifndef __PSP_PLATFORM_ACCESS_H
#define __PSP_PLATFORM_ACCESS_H

#include <linux/psp.h>

enum psp_platform_access_msg {
	PSP_CMD_NONE = 0x0,
	PSP_I2C_REQ_BUS_CMD = 0x64,
};

struct psp_req_buffer_hdr {
	u32 payload_size;
	u32 status;
} __packed;

struct psp_request {
	struct psp_req_buffer_hdr header;
	void *buf;
} __packed;

/**
 * psp_send_platform_access_msg() - Send a message to control platform features
 *
 * This function is intended to be used by drivers outside of ccp to communicate
 * with the platform.
 *
 * Returns:
 *  0:           success
 *  -%EBUSY:     mailbox in recovery or in use
 *  -%ENODEV:    driver not bound with PSP device
 *  -%ETIMEDOUT: request timed out
 *  -%EIO:       unknown error (see kernel log)
 */
int psp_send_platform_access_msg(enum psp_platform_access_msg, struct psp_request *req);

/**
 * psp_ring_platform_doorbell() - Ring platform doorbell
 *
 * This function is intended to be used by drivers outside of ccp to ring the
 * platform doorbell with a message.
 *
 * Returns:
 *  0:           success
 *  -%EBUSY:     mailbox in recovery or in use
 *  -%ENODEV:    driver not bound with PSP device
 *  -%ETIMEDOUT: request timed out
 *  -%EIO:       error will be stored in result argument
 */
int psp_ring_platform_doorbell(int msg, u32 *result);

/**
 * psp_check_platform_access_status() - Checks whether platform features is ready
 *
 * This function is intended to be used by drivers outside of ccp to determine
 * if platform features has initialized.
 *
 * Returns:
 * 0          platform features is ready
 * -%ENODEV   platform features is not ready or present
 */
int psp_check_platform_access_status(void);

#endif /* __PSP_PLATFORM_ACCESS_H */
Commit	Line	Data
7ccc4f4e ML	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,
440da737	10	PSP_I2C_REQ_BUS_CMD = 0x64,
7ccc4f4e ML	11	};
	12
	13	struct psp_req_buffer_hdr {
	14	u32 payload_size;
	15	u32 status;
	16	} __packed;
	17
	18	struct psp_request {
	19	struct psp_req_buffer_hdr header;
	20	void *buf;
	21	} __packed;
	22
	23	/**
	24	* psp_send_platform_access_msg() - Send a message to control platform features
	25	*
	26	* This function is intended to be used by drivers outside of ccp to communicate
	27	* with the platform.
	28	*
	29	* Returns:
	30	* 0: success
	31	* -%EBUSY: mailbox in recovery or in use
	32	* -%ENODEV: driver not bound with PSP device
	33	* -%ETIMEDOUT: request timed out
	34	* -%EIO: unknown error (see kernel log)
	35	*/
	36	int psp_send_platform_access_msg(enum psp_platform_access_msg, struct psp_request *req);
	37
d5812571 ML	38	/**
	39	* psp_ring_platform_doorbell() - Ring platform doorbell
	40	*
	41	* This function is intended to be used by drivers outside of ccp to ring the
	42	* platform doorbell with a message.
	43	*
	44	* Returns:
	45	* 0: success
	46	* -%EBUSY: mailbox in recovery or in use
	47	* -%ENODEV: driver not bound with PSP device
	48	* -%ETIMEDOUT: request timed out
a19c61b0	49	* -%EIO: error will be stored in result argument
d5812571	50	*/
a19c61b0	51	int psp_ring_platform_doorbell(int msg, u32 *result);
d5812571	52
7ccc4f4e ML	53	/**
	54	* psp_check_platform_access_status() - Checks whether platform features is ready
	55	*
	56	* This function is intended to be used by drivers outside of ccp to determine
	57	* if platform features has initialized.
	58	*
	59	* Returns:
	60	* 0 platform features is ready
	61	* -%ENODEV platform features is not ready or present
	62	*/
	63	int psp_check_platform_access_status(void);
	64
	65	#endif /* __PSP_PLATFORM_ACCESS_H */