include/linux/scpi_protocol.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * SCPI Message Protocol driver header
   4  *
   5  * Copyright (C) 2014 ARM Ltd.
   6  */
   7 #include <linux/types.h>
   8
   9 struct scpi_opp {
  10         u32 freq;
  11         u32 m_volt;
  12 } __packed;
  13
  14 struct scpi_dvfs_info {
  15         unsigned int count;
  16         unsigned int latency; /* in nanoseconds */
  17         struct scpi_opp *opps;
  18 };
  19
  20 enum scpi_sensor_class {
  21         TEMPERATURE,
  22         VOLTAGE,
  23         CURRENT,
  24         POWER,
  25         ENERGY,
  26 };
  27
  28 struct scpi_sensor_info {
  29         u16 sensor_id;
  30         u8 class;
  31         u8 trigger_type;
  32         char name[20];
  33 } __packed;
  34
  35 /**
  36  * struct scpi_ops - represents the various operations provided
  37  *      by SCP through SCPI message protocol
  38  * @get_version: returns the major and minor revision on the SCPI
  39  *      message protocol
  40  * @clk_get_range: gets clock range limit(min - max in Hz)
  41  * @clk_get_val: gets clock value(in Hz)
  42  * @clk_set_val: sets the clock value, setting to 0 will disable the
  43  *      clock (if supported)
  44  * @dvfs_get_idx: gets the Operating Point of the given power domain.
  45  *      OPP is an index to the list return by @dvfs_get_info
  46  * @dvfs_set_idx: sets the Operating Point of the given power domain.
  47  *      OPP is an index to the list return by @dvfs_get_info
  48  * @dvfs_get_info: returns the DVFS capabilities of the given power
  49  *      domain. It includes the OPP list and the latency information
  50  */
  51 struct scpi_ops {
  52         u32 (*get_version)(void);
  53         int (*clk_get_range)(u16, unsigned long *, unsigned long *);
  54         unsigned long (*clk_get_val)(u16);
  55         int (*clk_set_val)(u16, unsigned long);
  56         int (*dvfs_get_idx)(u8);
  57         int (*dvfs_set_idx)(u8, u8);
  58         struct scpi_dvfs_info *(*dvfs_get_info)(u8);
  59         int (*device_domain_id)(struct device *);
  60         int (*get_transition_latency)(struct device *);
  61         int (*add_opps_to_device)(struct device *);
  62         int (*sensor_get_capability)(u16 *sensors);
  63         int (*sensor_get_info)(u16 sensor_id, struct scpi_sensor_info *);
  64         int (*sensor_get_value)(u16, u64 *);
  65         int (*device_get_power_state)(u16);
  66         int (*device_set_power_state)(u16, u8);
  67 };
  68
  69 #if IS_REACHABLE(CONFIG_ARM_SCPI_PROTOCOL)
  70 struct scpi_ops *get_scpi_ops(void);
  71 #else
  72 static inline struct scpi_ops *get_scpi_ops(void) { return NULL; }
  73 #endif