LXR linux/include/linux/scpi

   1/*
   2 * SCPI Message Protocol driver header
   3 *
   4 * Copyright (C) 2014 ARM Ltd.
   5 *
   6 * This program is free software; you can redistribute it and/or modify it
   7 * under the terms and conditions of the GNU General Public License,
   8 * version 2, as published by the Free Software Foundation.
   9 *
  10 * This program is distributed in the hope it will be useful, but WITHOUT
  11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13 * more details.
  14 *
  15 * You should have received a copy of the GNU General Public License along with
  16 * this program. If not, see <http://www.gnu.org/licenses/>.
  17 */
  18#include <linux/types.h>
  19
  20struct scpi_opp {
  21        u32 freq;
  22        u32 m_volt;
  23} __packed;
  24
  25struct scpi_dvfs_info {
  26        unsigned int count;
  27        unsigned int latency; /* in nanoseconds */
  28        struct scpi_opp *opps;
  29};
  30
  31enum scpi_sensor_class {
  32        TEMPERATURE,
  33        VOLTAGE,
  34        CURRENT,
  35        POWER,
  36        ENERGY,
  37};
  38
  39struct scpi_sensor_info {
  40        u16 sensor_id;
  41        u8 class;
  42        u8 trigger_type;
  43        char name[20];
  44} __packed;
  45
  46/**
  47 * struct scpi_ops - represents the various operations provided
  48 *      by SCP through SCPI message protocol
  49 * @get_version: returns the major and minor revision on the SCPI
  50 *      message protocol
  51 * @clk_get_range: gets clock range limit(min - max in Hz)
  52 * @clk_get_val: gets clock value(in Hz)
  53 * @clk_set_val: sets the clock value, setting to 0 will disable the
  54 *      clock (if supported)
  55 * @dvfs_get_idx: gets the Operating Point of the given power domain.
  56 *      OPP is an index to the list return by @dvfs_get_info
  57 * @dvfs_set_idx: sets the Operating Point of the given power domain.
  58 *      OPP is an index to the list return by @dvfs_get_info
  59 * @dvfs_get_info: returns the DVFS capabilities of the given power
  60 *      domain. It includes the OPP list and the latency information
  61 */
  62struct scpi_ops {
  63        u32 (*get_version)(void);
  64        int (*clk_get_range)(u16, unsigned long *, unsigned long *);
  65        unsigned long (*clk_get_val)(u16);
  66        int (*clk_set_val)(u16, unsigned long);
  67        int (*dvfs_get_idx)(u8);
  68        int (*dvfs_set_idx)(u8, u8);
  69        struct scpi_dvfs_info *(*dvfs_get_info)(u8);
  70        int (*sensor_get_capability)(u16 *sensors);
  71        int (*sensor_get_info)(u16 sensor_id, struct scpi_sensor_info *);
  72        int (*sensor_get_value)(u16, u64 *);
  73};
  74
  75#if IS_REACHABLE(CONFIG_ARM_SCPI_PROTOCOL)
  76struct scpi_ops *get_scpi_ops(void);
  77#else
  78static inline struct scpi_ops *get_scpi_ops(void) { return NULL; }
  79#endif
  80