19952f691SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
28cb7cf56SSudeep Holla /*
38cb7cf56SSudeep Holla * SCPI Message Protocol driver header
48cb7cf56SSudeep Holla *
58cb7cf56SSudeep Holla * Copyright (C) 2014 ARM Ltd.
68cb7cf56SSudeep Holla */
723818b3dSSudeep Holla
823818b3dSSudeep Holla #ifndef _LINUX_SCPI_PROTOCOL_H
923818b3dSSudeep Holla #define _LINUX_SCPI_PROTOCOL_H
1023818b3dSSudeep Holla
118cb7cf56SSudeep Holla #include <linux/types.h>
128cb7cf56SSudeep Holla
138cb7cf56SSudeep Holla struct scpi_opp {
148cb7cf56SSudeep Holla u32 freq;
158cb7cf56SSudeep Holla u32 m_volt;
168cb7cf56SSudeep Holla } __packed;
178cb7cf56SSudeep Holla
188cb7cf56SSudeep Holla struct scpi_dvfs_info {
198cb7cf56SSudeep Holla unsigned int count;
208cb7cf56SSudeep Holla unsigned int latency; /* in nanoseconds */
218cb7cf56SSudeep Holla struct scpi_opp *opps;
228cb7cf56SSudeep Holla };
238cb7cf56SSudeep Holla
2438a1bdc9SPunit Agrawal enum scpi_sensor_class {
2538a1bdc9SPunit Agrawal TEMPERATURE,
2638a1bdc9SPunit Agrawal VOLTAGE,
2738a1bdc9SPunit Agrawal CURRENT,
2838a1bdc9SPunit Agrawal POWER,
29fb3b07efSSudeep Holla ENERGY,
3038a1bdc9SPunit Agrawal };
3138a1bdc9SPunit Agrawal
3238a1bdc9SPunit Agrawal struct scpi_sensor_info {
3338a1bdc9SPunit Agrawal u16 sensor_id;
3438a1bdc9SPunit Agrawal u8 class;
3538a1bdc9SPunit Agrawal u8 trigger_type;
3638a1bdc9SPunit Agrawal char name[20];
3738a1bdc9SPunit Agrawal } __packed;
3838a1bdc9SPunit Agrawal
398cb7cf56SSudeep Holla /**
408cb7cf56SSudeep Holla * struct scpi_ops - represents the various operations provided
418cb7cf56SSudeep Holla * by SCP through SCPI message protocol
428cb7cf56SSudeep Holla * @get_version: returns the major and minor revision on the SCPI
438cb7cf56SSudeep Holla * message protocol
448cb7cf56SSudeep Holla * @clk_get_range: gets clock range limit(min - max in Hz)
458cb7cf56SSudeep Holla * @clk_get_val: gets clock value(in Hz)
468cb7cf56SSudeep Holla * @clk_set_val: sets the clock value, setting to 0 will disable the
478cb7cf56SSudeep Holla * clock (if supported)
488cb7cf56SSudeep Holla * @dvfs_get_idx: gets the Operating Point of the given power domain.
498cb7cf56SSudeep Holla * OPP is an index to the list return by @dvfs_get_info
508cb7cf56SSudeep Holla * @dvfs_set_idx: sets the Operating Point of the given power domain.
518cb7cf56SSudeep Holla * OPP is an index to the list return by @dvfs_get_info
528cb7cf56SSudeep Holla * @dvfs_get_info: returns the DVFS capabilities of the given power
538cb7cf56SSudeep Holla * domain. It includes the OPP list and the latency information
54*5ff6319dSSudeep Holla * @device_domain_id: gets the scpi domain id for a given device
55*5ff6319dSSudeep Holla * @get_transition_latency: gets the DVFS transition latency for a given device
56*5ff6319dSSudeep Holla * @add_opps_to_device: adds all the OPPs for a given device
57*5ff6319dSSudeep Holla * @sensor_get_capability: get the list of capabilities for the sensors
58*5ff6319dSSudeep Holla * @sensor_get_info: get the information of the specified sensor
59*5ff6319dSSudeep Holla * @sensor_get_value: gets the current value of the sensor
60*5ff6319dSSudeep Holla * @device_get_power_state: gets the power state of a power domain
61*5ff6319dSSudeep Holla * @device_set_power_state: sets the power state of a power domain
628cb7cf56SSudeep Holla */
638cb7cf56SSudeep Holla struct scpi_ops {
648cb7cf56SSudeep Holla u32 (*get_version)(void);
658cb7cf56SSudeep Holla int (*clk_get_range)(u16, unsigned long *, unsigned long *);
668cb7cf56SSudeep Holla unsigned long (*clk_get_val)(u16);
678cb7cf56SSudeep Holla int (*clk_set_val)(u16, unsigned long);
688cb7cf56SSudeep Holla int (*dvfs_get_idx)(u8);
698cb7cf56SSudeep Holla int (*dvfs_set_idx)(u8, u8);
708cb7cf56SSudeep Holla struct scpi_dvfs_info *(*dvfs_get_info)(u8);
7145ca7df7SSudeep Holla int (*device_domain_id)(struct device *);
7245ca7df7SSudeep Holla int (*get_transition_latency)(struct device *);
7345ca7df7SSudeep Holla int (*add_opps_to_device)(struct device *);
7438a1bdc9SPunit Agrawal int (*sensor_get_capability)(u16 *sensors);
7538a1bdc9SPunit Agrawal int (*sensor_get_info)(u16 sensor_id, struct scpi_sensor_info *);
762e874159SSudeep Holla int (*sensor_get_value)(u16, u64 *);
7737a441dcSSudeep Holla int (*device_get_power_state)(u16);
7837a441dcSSudeep Holla int (*device_set_power_state)(u16, u8);
798cb7cf56SSudeep Holla };
808cb7cf56SSudeep Holla
81851df3dcSArnd Bergmann #if IS_REACHABLE(CONFIG_ARM_SCPI_PROTOCOL)
828cb7cf56SSudeep Holla struct scpi_ops *get_scpi_ops(void);
838cb7cf56SSudeep Holla #else
get_scpi_ops(void)848cb7cf56SSudeep Holla static inline struct scpi_ops *get_scpi_ops(void) { return NULL; }
858cb7cf56SSudeep Holla #endif
8623818b3dSSudeep Holla
8723818b3dSSudeep Holla #endif /* _LINUX_SCPI_PROTOCOL_H */
88