[linux-2.6-block.git] / include / linux / scmi_protocol.h

// SPDX-License-Identifier: GPL-2.0
/*
 * SCMI Message Protocol driver header
 *
 * Copyright (C) 2018 ARM Ltd.
 */
#include <linux/device.h>
#include <linux/types.h>

#define SCMI_MAX_STR_SIZE	16
#define SCMI_MAX_NUM_RATES	16

/**
 * struct scmi_revision_info - version information structure
 *
 * @major_ver: Major ABI version. Change here implies risk of backward
 *	compatibility break.
 * @minor_ver: Minor ABI version. Change here implies new feature addition,
 *	or compatible change in ABI.
 * @num_protocols: Number of protocols that are implemented, excluding the
 *	base protocol.
 * @num_agents: Number of agents in the system.
 * @impl_ver: A vendor-specific implementation version.
 * @vendor_id: A vendor identifier(Null terminated ASCII string)
 * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string)
 */
struct scmi_revision_info {
	u16 major_ver;
	u16 minor_ver;
	u8 num_protocols;
	u8 num_agents;
	u32 impl_ver;
	char vendor_id[SCMI_MAX_STR_SIZE];
	char sub_vendor_id[SCMI_MAX_STR_SIZE];
};

struct scmi_clock_info {
	char name[SCMI_MAX_STR_SIZE];
	bool rate_discrete;
	union {
		struct {
			int num_rates;
			u64 rates[SCMI_MAX_NUM_RATES];
		} list;
		struct {
			u64 min_rate;
			u64 max_rate;
			u64 step_size;
		} range;
	};
};

struct scmi_handle;

/**
 * struct scmi_clk_ops - represents the various operations provided
 *	by SCMI Clock Protocol
 *
 * @count_get: get the count of clocks provided by SCMI
 * @info_get: get the information of the specified clock
 * @rate_get: request the current clock rate of a clock
 * @rate_set: set the clock rate of a clock
 * @enable: enables the specified clock
 * @disable: disables the specified clock
 */
struct scmi_clk_ops {
	int (*count_get)(const struct scmi_handle *handle);

	const struct scmi_clock_info *(*info_get)
		(const struct scmi_handle *handle, u32 clk_id);
	int (*rate_get)(const struct scmi_handle *handle, u32 clk_id,
			u64 *rate);
	int (*rate_set)(const struct scmi_handle *handle, u32 clk_id,
			u32 config, u64 rate);
	int (*enable)(const struct scmi_handle *handle, u32 clk_id);
	int (*disable)(const struct scmi_handle *handle, u32 clk_id);
};

/**
 * struct scmi_perf_ops - represents the various operations provided
 *	by SCMI Performance Protocol
 *
 * @limits_set: sets limits on the performance level of a domain
 * @limits_get: gets limits on the performance level of a domain
 * @level_set: sets the performance level of a domain
 * @level_get: gets the performance level of a domain
 * @device_domain_id: gets the scmi domain id for a given device
 * @get_transition_latency: gets the DVFS transition latency for a given device
 * @add_opps_to_device: adds all the OPPs for a given device
 * @freq_set: sets the frequency for a given device using sustained frequency
 *	to sustained performance level mapping
 * @freq_get: gets the frequency for a given device using sustained frequency
 *	to sustained performance level mapping
 */
struct scmi_perf_ops {
	int (*limits_set)(const struct scmi_handle *handle, u32 domain,
			  u32 max_perf, u32 min_perf);
	int (*limits_get)(const struct scmi_handle *handle, u32 domain,
			  u32 *max_perf, u32 *min_perf);
	int (*level_set)(const struct scmi_handle *handle, u32 domain,
			 u32 level);
	int (*level_get)(const struct scmi_handle *handle, u32 domain,
			 u32 *level);
	int (*device_domain_id)(struct device *dev);
	int (*get_transition_latency)(const struct scmi_handle *handle,
				      struct device *dev);
	int (*add_opps_to_device)(const struct scmi_handle *handle,
				  struct device *dev);
	int (*freq_set)(const struct scmi_handle *handle, u32 domain,
			unsigned long rate);
	int (*freq_get)(const struct scmi_handle *handle, u32 domain,
			unsigned long *rate);
};

/**
 * struct scmi_power_ops - represents the various operations provided
 *	by SCMI Power Protocol
 *
 * @num_domains_get: get the count of power domains provided by SCMI
 * @name_get: gets the name of a power domain
 * @state_set: sets the power state of a power domain
 * @state_get: gets the power state of a power domain
 */
struct scmi_power_ops {
	int (*num_domains_get)(const struct scmi_handle *handle);
	char *(*name_get)(const struct scmi_handle *handle, u32 domain);
#define SCMI_POWER_STATE_TYPE_SHIFT	30
#define SCMI_POWER_STATE_ID_MASK	(BIT(28) - 1)
#define SCMI_POWER_STATE_PARAM(type, id) \
	((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \
		((id) & SCMI_POWER_STATE_ID_MASK))
#define SCMI_POWER_STATE_GENERIC_ON	SCMI_POWER_STATE_PARAM(0, 0)
#define SCMI_POWER_STATE_GENERIC_OFF	SCMI_POWER_STATE_PARAM(1, 0)
	int (*state_set)(const struct scmi_handle *handle, u32 domain,
			 u32 state);
	int (*state_get)(const struct scmi_handle *handle, u32 domain,
			 u32 *state);
};

/**
 * struct scmi_handle - Handle returned to ARM SCMI clients for usage.
 *
 * @dev: pointer to the SCMI device
 * @version: pointer to the structure containing SCMI version information
 * @power_ops: pointer to set of power protocol operations
 * @perf_ops: pointer to set of performance protocol operations
 * @clk_ops: pointer to set of clock protocol operations
 */
struct scmi_handle {
	struct device *dev;
	struct scmi_revision_info *version;
	struct scmi_perf_ops *perf_ops;
	struct scmi_clk_ops *clk_ops;
	struct scmi_power_ops *power_ops;
	/* for protocol internal use */
	void *perf_priv;
	void *clk_priv;
	void *power_priv;
};

enum scmi_std_protocol {
	SCMI_PROTOCOL_BASE = 0x10,
	SCMI_PROTOCOL_POWER = 0x11,
	SCMI_PROTOCOL_SYSTEM = 0x12,
	SCMI_PROTOCOL_PERF = 0x13,
	SCMI_PROTOCOL_CLOCK = 0x14,
	SCMI_PROTOCOL_SENSOR = 0x15,
};

struct scmi_device {
	u32 id;
	u8 protocol_id;
	struct device dev;
	struct scmi_handle *handle;
};

#define to_scmi_dev(d) container_of(d, struct scmi_device, dev)

struct scmi_device *
scmi_device_create(struct device_node *np, struct device *parent, int protocol);
void scmi_device_destroy(struct scmi_device *scmi_dev);

struct scmi_device_id {
	u8 protocol_id;
};

struct scmi_driver {
	const char *name;
	int (*probe)(struct scmi_device *sdev);
	void (*remove)(struct scmi_device *sdev);
	const struct scmi_device_id *id_table;

	struct device_driver driver;
};

#define to_scmi_driver(d) container_of(d, struct scmi_driver, driver)

#ifdef CONFIG_ARM_SCMI_PROTOCOL
int scmi_driver_register(struct scmi_driver *driver,
			 struct module *owner, const char *mod_name);
void scmi_driver_unregister(struct scmi_driver *driver);
#else
static inline int
scmi_driver_register(struct scmi_driver *driver, struct module *owner,
		     const char *mod_name)
{
	return -EINVAL;
}

static inline void scmi_driver_unregister(struct scmi_driver *driver) {}
#endif /* CONFIG_ARM_SCMI_PROTOCOL */

#define scmi_register(driver) \
	scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
#define scmi_unregister(driver) \
	scmi_driver_unregister(driver)

/**
 * module_scmi_driver() - Helper macro for registering a scmi driver
 * @__scmi_driver: scmi_driver structure
 *
 * Helper macro for scmi drivers to set up proper module init / exit
 * functions.  Replaces module_init() and module_exit() and keeps people from
 * printing pointless things to the kernel log when their driver is loaded.
 */
#define module_scmi_driver(__scmi_driver)	\
	module_driver(__scmi_driver, scmi_register, scmi_unregister)

typedef int (*scmi_prot_init_fn_t)(struct scmi_handle *);
int scmi_protocol_register(int protocol_id, scmi_prot_init_fn_t fn);
void scmi_protocol_unregister(int protocol_id);
Commit	Line	Data
aa4f886f SH	1	// SPDX-License-Identifier: GPL-2.0
	2	/*
	3	* SCMI Message Protocol driver header
	4	*
	5	* Copyright (C) 2018 ARM Ltd.
	6	*/
933c5044	7	#include <linux/device.h>
aa4f886f SH	8	#include <linux/types.h>
aa4f886f SH	9
b6f20ff8	10	#define SCMI_MAX_STR_SIZE 16
5f6c6430	11	#define SCMI_MAX_NUM_RATES 16
b6f20ff8 SH	12
	13	/**
	14	* struct scmi_revision_info - version information structure
	15	*
	16	* @major_ver: Major ABI version. Change here implies risk of backward
	17	* compatibility break.
	18	* @minor_ver: Minor ABI version. Change here implies new feature addition,
	19	* or compatible change in ABI.
	20	* @num_protocols: Number of protocols that are implemented, excluding the
	21	* base protocol.
	22	* @num_agents: Number of agents in the system.
	23	* @impl_ver: A vendor-specific implementation version.
	24	* @vendor_id: A vendor identifier(Null terminated ASCII string)
	25	* @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string)
	26	*/
	27	struct scmi_revision_info {
	28	u16 major_ver;
	29	u16 minor_ver;
	30	u8 num_protocols;
	31	u8 num_agents;
	32	u32 impl_ver;
	33	char vendor_id[SCMI_MAX_STR_SIZE];
	34	char sub_vendor_id[SCMI_MAX_STR_SIZE];
	35	};
	36
5f6c6430 SH	37	struct scmi_clock_info {
	38	char name[SCMI_MAX_STR_SIZE];
	39	bool rate_discrete;
	40	union {
	41	struct {
	42	int num_rates;
	43	u64 rates[SCMI_MAX_NUM_RATES];
	44	} list;
	45	struct {
	46	u64 min_rate;
	47	u64 max_rate;
	48	u64 step_size;
	49	} range;
	50	};
	51	};
	52
a9e3fbfa SH	53	struct scmi_handle;
a9e3fbfa SH	54
5f6c6430 SH	55	/**
	56	* struct scmi_clk_ops - represents the various operations provided
	57	* by SCMI Clock Protocol
	58	*
	59	* @count_get: get the count of clocks provided by SCMI
	60	* @info_get: get the information of the specified clock
	61	* @rate_get: request the current clock rate of a clock
	62	* @rate_set: set the clock rate of a clock
	63	* @enable: enables the specified clock
	64	* @disable: disables the specified clock
	65	*/
	66	struct scmi_clk_ops {
	67	int (count_get)(const struct scmi_handle handle);
	68
	69	const struct scmi_clock_info (info_get)
	70	(const struct scmi_handle *handle, u32 clk_id);
	71	int (rate_get)(const struct scmi_handle handle, u32 clk_id,
	72	u64 *rate);
	73	int (rate_set)(const struct scmi_handle handle, u32 clk_id,
	74	u32 config, u64 rate);
	75	int (enable)(const struct scmi_handle handle, u32 clk_id);
	76	int (disable)(const struct scmi_handle handle, u32 clk_id);
	77	};
	78
a9e3fbfa SH	79	/**
	80	* struct scmi_perf_ops - represents the various operations provided
	81	* by SCMI Performance Protocol
	82	*
	83	* @limits_set: sets limits on the performance level of a domain
	84	* @limits_get: gets limits on the performance level of a domain
	85	* @level_set: sets the performance level of a domain
	86	* @level_get: gets the performance level of a domain
	87	* @device_domain_id: gets the scmi domain id for a given device
	88	* @get_transition_latency: gets the DVFS transition latency for a given device
	89	* @add_opps_to_device: adds all the OPPs for a given device
	90	* @freq_set: sets the frequency for a given device using sustained frequency
	91	* to sustained performance level mapping
	92	* @freq_get: gets the frequency for a given device using sustained frequency
	93	* to sustained performance level mapping
	94	*/
	95	struct scmi_perf_ops {
	96	int (limits_set)(const struct scmi_handle handle, u32 domain,
	97	u32 max_perf, u32 min_perf);
	98	int (limits_get)(const struct scmi_handle handle, u32 domain,
	99	u32 max_perf, u32 min_perf);
	100	int (level_set)(const struct scmi_handle handle, u32 domain,
	101	u32 level);
	102	int (level_get)(const struct scmi_handle handle, u32 domain,
	103	u32 *level);
	104	int (device_domain_id)(struct device dev);
	105	int (get_transition_latency)(const struct scmi_handle handle,
	106	struct device *dev);
	107	int (add_opps_to_device)(const struct scmi_handle handle,
	108	struct device *dev);
	109	int (freq_set)(const struct scmi_handle handle, u32 domain,
	110	unsigned long rate);
	111	int (freq_get)(const struct scmi_handle handle, u32 domain,
	112	unsigned long *rate);
	113	};
	114
76a65509 SH	115	/**
	116	* struct scmi_power_ops - represents the various operations provided
	117	* by SCMI Power Protocol
	118	*
	119	* @num_domains_get: get the count of power domains provided by SCMI
	120	* @name_get: gets the name of a power domain
	121	* @state_set: sets the power state of a power domain
	122	* @state_get: gets the power state of a power domain
	123	*/
	124	struct scmi_power_ops {
	125	int (num_domains_get)(const struct scmi_handle handle);
	126	char (name_get)(const struct scmi_handle *handle, u32 domain);
	127	#define SCMI_POWER_STATE_TYPE_SHIFT 30
	128	#define SCMI_POWER_STATE_ID_MASK (BIT(28) - 1)
	129	#define SCMI_POWER_STATE_PARAM(type, id) \
	130	((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) \| \
	131	((id) & SCMI_POWER_STATE_ID_MASK))
	132	#define SCMI_POWER_STATE_GENERIC_ON SCMI_POWER_STATE_PARAM(0, 0)
	133	#define SCMI_POWER_STATE_GENERIC_OFF SCMI_POWER_STATE_PARAM(1, 0)
	134	int (state_set)(const struct scmi_handle handle, u32 domain,
	135	u32 state);
	136	int (state_get)(const struct scmi_handle handle, u32 domain,
	137	u32 *state);
	138	};
	139
aa4f886f SH	140	/**
	141	* struct scmi_handle - Handle returned to ARM SCMI clients for usage.
	142	*
	143	* @dev: pointer to the SCMI device
b6f20ff8	144	* @version: pointer to the structure containing SCMI version information
76a65509	145	* @power_ops: pointer to set of power protocol operations
a9e3fbfa	146	* @perf_ops: pointer to set of performance protocol operations
5f6c6430	147	* @clk_ops: pointer to set of clock protocol operations
aa4f886f SH	148	*/
	149	struct scmi_handle {
	150	struct device *dev;
b6f20ff8	151	struct scmi_revision_info *version;
a9e3fbfa	152	struct scmi_perf_ops *perf_ops;
5f6c6430	153	struct scmi_clk_ops *clk_ops;
76a65509	154	struct scmi_power_ops *power_ops;
a9e3fbfa SH	155	/* for protocol internal use */
a9e3fbfa SH	156	void *perf_priv;
5f6c6430	157	void *clk_priv;
76a65509	158	void *power_priv;
b6f20ff8 SH	159	};
	160
	161	enum scmi_std_protocol {
	162	SCMI_PROTOCOL_BASE = 0x10,
	163	SCMI_PROTOCOL_POWER = 0x11,
	164	SCMI_PROTOCOL_SYSTEM = 0x12,
	165	SCMI_PROTOCOL_PERF = 0x13,
	166	SCMI_PROTOCOL_CLOCK = 0x14,
	167	SCMI_PROTOCOL_SENSOR = 0x15,
aa4f886f	168	};
933c5044 SH	169
	170	struct scmi_device {
	171	u32 id;
	172	u8 protocol_id;
	173	struct device dev;
	174	struct scmi_handle *handle;
	175	};
	176
	177	#define to_scmi_dev(d) container_of(d, struct scmi_device, dev)
	178
	179	struct scmi_device *
	180	scmi_device_create(struct device_node np, struct device parent, int protocol);
	181	void scmi_device_destroy(struct scmi_device *scmi_dev);
	182
	183	struct scmi_device_id {
	184	u8 protocol_id;
	185	};
	186
	187	struct scmi_driver {
	188	const char *name;
	189	int (probe)(struct scmi_device sdev);
	190	void (remove)(struct scmi_device sdev);
	191	const struct scmi_device_id *id_table;
	192
	193	struct device_driver driver;
	194	};
	195
	196	#define to_scmi_driver(d) container_of(d, struct scmi_driver, driver)
	197
	198	#ifdef CONFIG_ARM_SCMI_PROTOCOL
	199	int scmi_driver_register(struct scmi_driver *driver,
	200	struct module owner, const char mod_name);
	201	void scmi_driver_unregister(struct scmi_driver *driver);
	202	#else
	203	static inline int
	204	scmi_driver_register(struct scmi_driver driver, struct module owner,
	205	const char *mod_name)
	206	{
	207	return -EINVAL;
	208	}
	209
	210	static inline void scmi_driver_unregister(struct scmi_driver *driver) {}
	211	#endif /* CONFIG_ARM_SCMI_PROTOCOL */
	212
	213	#define scmi_register(driver) \
	214	scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
	215	#define scmi_unregister(driver) \
	216	scmi_driver_unregister(driver)
	217
	218	/**
	219	* module_scmi_driver() - Helper macro for registering a scmi driver
	220	* @__scmi_driver: scmi_driver structure
	221	*
	222	* Helper macro for scmi drivers to set up proper module init / exit
	223	* functions. Replaces module_init() and module_exit() and keeps people from
	224	* printing pointless things to the kernel log when their driver is loaded.
	225	*/
	226	#define module_scmi_driver(__scmi_driver) \
	227	module_driver(__scmi_driver, scmi_register, scmi_unregister)
	228
	229	typedef int (scmi_prot_init_fn_t)(struct scmi_handle );
	230	int scmi_protocol_register(int protocol_id, scmi_prot_init_fn_t fn);
	231	void scmi_protocol_unregister(int protocol_id);