include/linux/scmi_protocol.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * SCMI Message Protocol driver header
   4  *
   5  * Copyright (C) 2018 ARM Ltd.
   6  */
   7
   8 #ifndef _LINUX_SCMI_PROTOCOL_H
   9 #define _LINUX_SCMI_PROTOCOL_H
  10
  11 #include <linux/bitfield.h>
  12 #include <linux/device.h>
  13 #include <linux/notifier.h>
  14 #include <linux/types.h>
  15
  16 #define SCMI_MAX_STR_SIZE       16
  17 #define SCMI_MAX_NUM_RATES      16
  18
  19 /**
  20  * struct scmi_revision_info - version information structure
  21  *
  22  * @major_ver: Major ABI version. Change here implies risk of backward
  23  *      compatibility break.
  24  * @minor_ver: Minor ABI version. Change here implies new feature addition,
  25  *      or compatible change in ABI.
  26  * @num_protocols: Number of protocols that are implemented, excluding the
  27  *      base protocol.
  28  * @num_agents: Number of agents in the system.
  29  * @impl_ver: A vendor-specific implementation version.
  30  * @vendor_id: A vendor identifier(Null terminated ASCII string)
  31  * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string)
  32  */
  33 struct scmi_revision_info {
  34         u16 major_ver;
  35         u16 minor_ver;
  36         u8 num_protocols;
  37         u8 num_agents;
  38         u32 impl_ver;
  39         char vendor_id[SCMI_MAX_STR_SIZE];
  40         char sub_vendor_id[SCMI_MAX_STR_SIZE];
  41 };
  42
  43 struct scmi_clock_info {
  44         char name[SCMI_MAX_STR_SIZE];
  45         bool rate_discrete;
  46         union {
  47                 struct {
  48                         int num_rates;
  49                         u64 rates[SCMI_MAX_NUM_RATES];
  50                 } list;
  51                 struct {
  52                         u64 min_rate;
  53                         u64 max_rate;
  54                         u64 step_size;
  55                 } range;
  56         };
  57 };
  58
  59 struct scmi_handle;
  60
  61 /**
  62  * struct scmi_clk_ops - represents the various operations provided
  63  *      by SCMI Clock Protocol
  64  *
  65  * @count_get: get the count of clocks provided by SCMI
  66  * @info_get: get the information of the specified clock
  67  * @rate_get: request the current clock rate of a clock
  68  * @rate_set: set the clock rate of a clock
  69  * @enable: enables the specified clock
  70  * @disable: disables the specified clock
  71  */
  72 struct scmi_clk_ops {
  73         int (*count_get)(const struct scmi_handle *handle);
  74
  75         const struct scmi_clock_info *(*info_get)
  76                 (const struct scmi_handle *handle, u32 clk_id);
  77         int (*rate_get)(const struct scmi_handle *handle, u32 clk_id,
  78                         u64 *rate);
  79         int (*rate_set)(const struct scmi_handle *handle, u32 clk_id,
  80                         u64 rate);
  81         int (*enable)(const struct scmi_handle *handle, u32 clk_id);
  82         int (*disable)(const struct scmi_handle *handle, u32 clk_id);
  83 };
  84
  85 /**
  86  * struct scmi_perf_ops - represents the various operations provided
  87  *      by SCMI Performance Protocol
  88  *
  89  * @limits_set: sets limits on the performance level of a domain
  90  * @limits_get: gets limits on the performance level of a domain
  91  * @level_set: sets the performance level of a domain
  92  * @level_get: gets the performance level of a domain
  93  * @device_domain_id: gets the scmi domain id for a given device
  94  * @transition_latency_get: gets the DVFS transition latency for a given device
  95  * @device_opps_add: adds all the OPPs for a given device
  96  * @freq_set: sets the frequency for a given device using sustained frequency
  97  *      to sustained performance level mapping
  98  * @freq_get: gets the frequency for a given device using sustained frequency
  99  *      to sustained performance level mapping
 100  * @est_power_get: gets the estimated power cost for a given performance domain
 101  *      at a given frequency
 102  */
 103 struct scmi_perf_ops {
 104         int (*limits_set)(const struct scmi_handle *handle, u32 domain,
 105                           u32 max_perf, u32 min_perf);
 106         int (*limits_get)(const struct scmi_handle *handle, u32 domain,
 107                           u32 *max_perf, u32 *min_perf);
 108         int (*level_set)(const struct scmi_handle *handle, u32 domain,
 109                          u32 level, bool poll);
 110         int (*level_get)(const struct scmi_handle *handle, u32 domain,
 111                          u32 *level, bool poll);
 112         int (*device_domain_id)(struct device *dev);
 113         int (*transition_latency_get)(const struct scmi_handle *handle,
 114                                       struct device *dev);
 115         int (*device_opps_add)(const struct scmi_handle *handle,
 116                                struct device *dev);
 117         int (*freq_set)(const struct scmi_handle *handle, u32 domain,
 118                         unsigned long rate, bool poll);
 119         int (*freq_get)(const struct scmi_handle *handle, u32 domain,
 120                         unsigned long *rate, bool poll);
 121         int (*est_power_get)(const struct scmi_handle *handle, u32 domain,
 122                              unsigned long *rate, unsigned long *power);
 123         bool (*fast_switch_possible)(const struct scmi_handle *handle,
 124                                      struct device *dev);
 125 };
 126
 127 /**
 128  * struct scmi_power_ops - represents the various operations provided
 129  *      by SCMI Power Protocol
 130  *
 131  * @num_domains_get: get the count of power domains provided by SCMI
 132  * @name_get: gets the name of a power domain
 133  * @state_set: sets the power state of a power domain
 134  * @state_get: gets the power state of a power domain
 135  */
 136 struct scmi_power_ops {
 137         int (*num_domains_get)(const struct scmi_handle *handle);
 138         char *(*name_get)(const struct scmi_handle *handle, u32 domain);
 139 #define SCMI_POWER_STATE_TYPE_SHIFT     30
 140 #define SCMI_POWER_STATE_ID_MASK        (BIT(28) - 1)
 141 #define SCMI_POWER_STATE_PARAM(type, id) \
 142         ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \
 143                 ((id) & SCMI_POWER_STATE_ID_MASK))
 144 #define SCMI_POWER_STATE_GENERIC_ON     SCMI_POWER_STATE_PARAM(0, 0)
 145 #define SCMI_POWER_STATE_GENERIC_OFF    SCMI_POWER_STATE_PARAM(1, 0)
 146         int (*state_set)(const struct scmi_handle *handle, u32 domain,
 147                          u32 state);
 148         int (*state_get)(const struct scmi_handle *handle, u32 domain,
 149                          u32 *state);
 150 };
 151
 152 /**
 153  * scmi_sensor_reading  - represent a timestamped read
 154  *
 155  * Used by @reading_get_timestamped method.
 156  *
 157  * @value: The signed value sensor read.
 158  * @timestamp: An unsigned timestamp for the sensor read, as provided by
 159  *             SCMI platform. Set to zero when not available.
 160  */
 161 struct scmi_sensor_reading {
 162         long long value;
 163         unsigned long long timestamp;
 164 };
 165
 166 /**
 167  * scmi_range_attrs  - specifies a sensor or axis values' range
 168  * @min_range: The minimum value which can be represented by the sensor/axis.
 169  * @max_range: The maximum value which can be represented by the sensor/axis.
 170  */
 171 struct scmi_range_attrs {
 172         long long min_range;
 173         long long max_range;
 174 };
 175
 176 /**
 177  * scmi_sensor_axis_info  - describes one sensor axes
 178  * @id: The axes ID.
 179  * @type: Axes type. Chosen amongst one of @enum scmi_sensor_class.
 180  * @scale: Power-of-10 multiplier applied to the axis unit.
 181  * @name: NULL-terminated string representing axes name as advertised by
 182  *        SCMI platform.
 183  * @extended_attrs: Flag to indicate the presence of additional extended
 184  *                  attributes for this axes.
 185  * @resolution: Extended attribute representing the resolution of the axes.
 186  *              Set to 0 if not reported by this axes.
 187  * @exponent: Extended attribute representing the power-of-10 multiplier that
 188  *            is applied to the resolution field. Set to 0 if not reported by
 189  *            this axes.
 190  * @attrs: Extended attributes representing minimum and maximum values
 191  *         measurable by this axes. Set to 0 if not reported by this sensor.
 192  */
 193 struct scmi_sensor_axis_info {
 194         unsigned int id;
 195         unsigned int type;
 196         int scale;
 197         char name[SCMI_MAX_STR_SIZE];
 198         bool extended_attrs;
 199         unsigned int resolution;
 200         int exponent;
 201         struct scmi_range_attrs attrs;
 202 };
 203
 204 /**
 205  * scmi_sensor_intervals_info  - describes number and type of available update
 206  * intervals
 207  * @segmented: Flag for segmented intervals' representation. When True there
 208  *             will be exactly 3 intervals in @desc, with each entry
 209  *             representing a member of a segment in this order:
 210  *             {lowest update interval, highest update interval, step size}
 211  * @count: Number of intervals described in @desc.
 212  * @desc: Array of @count interval descriptor bitmask represented as detailed in
 213  *        the SCMI specification: it can be accessed using the accompanying
 214  *        macros.
 215  * @prealloc_pool: A minimal preallocated pool of desc entries used to avoid
 216  *                 lesser-than-64-bytes dynamic allocation for small @count
 217  *                 values.
 218  */
 219 struct scmi_sensor_intervals_info {
 220         bool segmented;
 221         unsigned int count;
 222 #define SCMI_SENS_INTVL_SEGMENT_LOW     0
 223 #define SCMI_SENS_INTVL_SEGMENT_HIGH    1
 224 #define SCMI_SENS_INTVL_SEGMENT_STEP    2
 225         unsigned int *desc;
 226 #define SCMI_SENS_INTVL_GET_SECS(x)             FIELD_GET(GENMASK(20, 5), (x))
 227 #define SCMI_SENS_INTVL_GET_EXP(x)                                      \
 228         ({                                                              \
 229                 int __signed_exp = FIELD_GET(GENMASK(4, 0), (x));       \
 230                                                                         \
 231                 if (__signed_exp & BIT(4))                              \
 232                         __signed_exp |= GENMASK(31, 5);                 \
 233                 __signed_exp;                                           \
 234         })
 235 #define SCMI_MAX_PREALLOC_POOL                  16
 236         unsigned int prealloc_pool[SCMI_MAX_PREALLOC_POOL];
 237 };
 238
 239 /**
 240  * struct scmi_sensor_info - represents information related to one of the
 241  * available sensors.
 242  * @id: Sensor ID.
 243  * @type: Sensor type. Chosen amongst one of @enum scmi_sensor_class.
 244  * @scale: Power-of-10 multiplier applied to the sensor unit.
 245  * @num_trip_points: Number of maximum configurable trip points.
 246  * @async: Flag for asynchronous read support.
 247  * @update: Flag for continuouos update notification support.
 248  * @timestamped: Flag for timestamped read support.
 249  * @tstamp_scale: Power-of-10 multiplier applied to the sensor timestamps to
 250  *                represent it in seconds.
 251  * @num_axis: Number of supported axis if any. Reported as 0 for scalar sensors.
 252  * @axis: Pointer to an array of @num_axis descriptors.
 253  * @intervals: Descriptor of available update intervals.
 254  * @sensor_config: A bitmask reporting the current sensor configuration as
 255  *                 detailed in the SCMI specification: it can accessed and
 256  *                 modified through the accompanying macros.
 257  * @name: NULL-terminated string representing sensor name as advertised by
 258  *        SCMI platform.
 259  * @extended_scalar_attrs: Flag to indicate the presence of additional extended
 260  *                         attributes for this sensor.
 261  * @sensor_power: Extended attribute representing the average power
 262  *                consumed by the sensor in microwatts (uW) when it is active.
 263  *                Reported here only for scalar sensors.
 264  *                Set to 0 if not reported by this sensor.
 265  * @resolution: Extended attribute representing the resolution of the sensor.
 266  *              Reported here only for scalar sensors.
 267  *              Set to 0 if not reported by this sensor.
 268  * @exponent: Extended attribute representing the power-of-10 multiplier that is
 269  *            applied to the resolution field.
 270  *            Reported here only for scalar sensors.
 271  *            Set to 0 if not reported by this sensor.
 272  * @scalar_attrs: Extended attributes representing minimum and maximum
 273  *                measurable values by this sensor.
 274  *                Reported here only for scalar sensors.
 275  *                Set to 0 if not reported by this sensor.
 276  */
 277 struct scmi_sensor_info {
 278         unsigned int id;
 279         unsigned int type;
 280         int scale;
 281         unsigned int num_trip_points;
 282         bool async;
 283         bool update;
 284         bool timestamped;
 285         int tstamp_scale;
 286         unsigned int num_axis;
 287         struct scmi_sensor_axis_info *axis;
 288         struct scmi_sensor_intervals_info intervals;
 289         unsigned int sensor_config;
 290 #define SCMI_SENS_CFG_UPDATE_SECS_MASK          GENMASK(31, 16)
 291 #define SCMI_SENS_CFG_GET_UPDATE_SECS(x)                                \
 292         FIELD_GET(SCMI_SENS_CFG_UPDATE_SECS_MASK, (x))
 293
 294 #define SCMI_SENS_CFG_UPDATE_EXP_MASK           GENMASK(15, 11)
 295 #define SCMI_SENS_CFG_GET_UPDATE_EXP(x)                                 \
 296         ({                                                              \
 297                 int __signed_exp =                                      \
 298                         FIELD_GET(SCMI_SENS_CFG_UPDATE_EXP_MASK, (x));  \
 299                                                                         \
 300                 if (__signed_exp & BIT(4))                              \
 301                         __signed_exp |= GENMASK(31, 5);                 \
 302                 __signed_exp;                                           \
 303         })
 304
 305 #define SCMI_SENS_CFG_ROUND_MASK                GENMASK(10, 9)
 306 #define SCMI_SENS_CFG_ROUND_AUTO                2
 307 #define SCMI_SENS_CFG_ROUND_UP                  1
 308 #define SCMI_SENS_CFG_ROUND_DOWN                0
 309
 310 #define SCMI_SENS_CFG_TSTAMP_ENABLED_MASK       BIT(1)
 311 #define SCMI_SENS_CFG_TSTAMP_ENABLE             1
 312 #define SCMI_SENS_CFG_TSTAMP_DISABLE            0
 313 #define SCMI_SENS_CFG_IS_TSTAMP_ENABLED(x)                              \
 314         FIELD_GET(SCMI_SENS_CFG_TSTAMP_ENABLED_MASK, (x))
 315
 316 #define SCMI_SENS_CFG_SENSOR_ENABLED_MASK       BIT(0)
 317 #define SCMI_SENS_CFG_SENSOR_ENABLE             1
 318 #define SCMI_SENS_CFG_SENSOR_DISABLE            0
 319         char name[SCMI_MAX_STR_SIZE];
 320 #define SCMI_SENS_CFG_IS_ENABLED(x)             FIELD_GET(BIT(0), (x))
 321         bool extended_scalar_attrs;
 322         unsigned int sensor_power;
 323         unsigned int resolution;
 324         int exponent;
 325         struct scmi_range_attrs scalar_attrs;
 326 };
 327
 328 /*
 329  * Partial list from Distributed Management Task Force (DMTF) specification:
 330  * DSP0249 (Platform Level Data Model specification)
 331  */
 332 enum scmi_sensor_class {
 333         NONE = 0x0,
 334         UNSPEC = 0x1,
 335         TEMPERATURE_C = 0x2,
 336         TEMPERATURE_F = 0x3,
 337         TEMPERATURE_K = 0x4,
 338         VOLTAGE = 0x5,
 339         CURRENT = 0x6,
 340         POWER = 0x7,
 341         ENERGY = 0x8,
 342         CHARGE = 0x9,
 343         VOLTAMPERE = 0xA,
 344         NITS = 0xB,
 345         LUMENS = 0xC,
 346         LUX = 0xD,
 347         CANDELAS = 0xE,
 348         KPA = 0xF,
 349         PSI = 0x10,
 350         NEWTON = 0x11,
 351         CFM = 0x12,
 352         RPM = 0x13,
 353         HERTZ = 0x14,
 354         SECS = 0x15,
 355         MINS = 0x16,
 356         HOURS = 0x17,
 357         DAYS = 0x18,
 358         WEEKS = 0x19,
 359         MILS = 0x1A,
 360         INCHES = 0x1B,
 361         FEET = 0x1C,
 362         CUBIC_INCHES = 0x1D,
 363         CUBIC_FEET = 0x1E,
 364         METERS = 0x1F,
 365         CUBIC_CM = 0x20,
 366         CUBIC_METERS = 0x21,
 367         LITERS = 0x22,
 368         FLUID_OUNCES = 0x23,
 369         RADIANS = 0x24,
 370         STERADIANS = 0x25,
 371         REVOLUTIONS = 0x26,
 372         CYCLES = 0x27,
 373         GRAVITIES = 0x28,
 374         OUNCES = 0x29,
 375         POUNDS = 0x2A,
 376         FOOT_POUNDS = 0x2B,
 377         OUNCE_INCHES = 0x2C,
 378         GAUSS = 0x2D,
 379         GILBERTS = 0x2E,
 380         HENRIES = 0x2F,
 381         FARADS = 0x30,
 382         OHMS = 0x31,
 383         SIEMENS = 0x32,
 384         MOLES = 0x33,
 385         BECQUERELS = 0x34,
 386         PPM = 0x35,
 387         DECIBELS = 0x36,
 388         DBA = 0x37,
 389         DBC = 0x38,
 390         GRAYS = 0x39,
 391         SIEVERTS = 0x3A,
 392         COLOR_TEMP_K = 0x3B,
 393         BITS = 0x3C,
 394         BYTES = 0x3D,
 395         WORDS = 0x3E,
 396         DWORDS = 0x3F,
 397         QWORDS = 0x40,
 398         PERCENTAGE = 0x41,
 399         PASCALS = 0x42,
 400         COUNTS = 0x43,
 401         GRAMS = 0x44,
 402         NEWTON_METERS = 0x45,
 403         HITS = 0x46,
 404         MISSES = 0x47,
 405         RETRIES = 0x48,
 406         OVERRUNS = 0x49,
 407         UNDERRUNS = 0x4A,
 408         COLLISIONS = 0x4B,
 409         PACKETS = 0x4C,
 410         MESSAGES = 0x4D,
 411         CHARS = 0x4E,
 412         ERRORS = 0x4F,
 413         CORRECTED_ERRS = 0x50,
 414         UNCORRECTABLE_ERRS = 0x51,
 415         SQ_MILS = 0x52,
 416         SQ_INCHES = 0x53,
 417         SQ_FEET = 0x54,
 418         SQ_CM = 0x55,
 419         SQ_METERS = 0x56,
 420         RADIANS_SEC = 0x57,
 421         BPM = 0x58,
 422         METERS_SEC_SQUARED = 0x59,
 423         METERS_SEC = 0x5A,
 424         CUBIC_METERS_SEC = 0x5B,
 425         MM_MERCURY = 0x5C,
 426         RADIANS_SEC_SQUARED = 0x5D,
 427         OEM_UNIT = 0xFF
 428 };
 429
 430 /**
 431  * struct scmi_sensor_ops - represents the various operations provided
 432  *      by SCMI Sensor Protocol
 433  *
 434  * @count_get: get the count of sensors provided by SCMI
 435  * @info_get: get the information of the specified sensor
 436  * @trip_point_config: selects and configures a trip-point of interest
 437  * @reading_get: gets the current value of the sensor
 438  * @reading_get_timestamped: gets the current value and timestamp, when
 439  *                           available, of the sensor. (as of v3.0 spec)
 440  *                           Supports multi-axis sensors for sensors which
 441  *                           supports it and if the @reading array size of
 442  *                           @count entry equals the sensor num_axis
 443  * @config_get: Get sensor current configuration
 444  * @config_set: Set sensor current configuration
 445  */
 446 struct scmi_sensor_ops {
 447         int (*count_get)(const struct scmi_handle *handle);
 448         const struct scmi_sensor_info *(*info_get)
 449                 (const struct scmi_handle *handle, u32 sensor_id);
 450         int (*trip_point_config)(const struct scmi_handle *handle,
 451                                  u32 sensor_id, u8 trip_id, u64 trip_value);
 452         int (*reading_get)(const struct scmi_handle *handle, u32 sensor_id,
 453                            u64 *value);
 454         int (*reading_get_timestamped)(const struct scmi_handle *handle,
 455                                        u32 sensor_id, u8 count,
 456                                        struct scmi_sensor_reading *readings);
 457         int (*config_get)(const struct scmi_handle *handle,
 458                           u32 sensor_id, u32 *sensor_config);
 459         int (*config_set)(const struct scmi_handle *handle,
 460                           u32 sensor_id, u32 sensor_config);
 461 };
 462
 463 /**
 464  * struct scmi_reset_ops - represents the various operations provided
 465  *      by SCMI Reset Protocol
 466  *
 467  * @num_domains_get: get the count of reset domains provided by SCMI
 468  * @name_get: gets the name of a reset domain
 469  * @latency_get: gets the reset latency for the specified reset domain
 470  * @reset: resets the specified reset domain
 471  * @assert: explicitly assert reset signal of the specified reset domain
 472  * @deassert: explicitly deassert reset signal of the specified reset domain
 473  */
 474 struct scmi_reset_ops {
 475         int (*num_domains_get)(const struct scmi_handle *handle);
 476         char *(*name_get)(const struct scmi_handle *handle, u32 domain);
 477         int (*latency_get)(const struct scmi_handle *handle, u32 domain);
 478         int (*reset)(const struct scmi_handle *handle, u32 domain);
 479         int (*assert)(const struct scmi_handle *handle, u32 domain);
 480         int (*deassert)(const struct scmi_handle *handle, u32 domain);
 481 };
 482
 483 /**
 484  * struct scmi_voltage_info - describe one available SCMI Voltage Domain
 485  *
 486  * @id: the domain ID as advertised by the platform
 487  * @segmented: defines the layout of the entries of array @levels_uv.
 488  *             - when True the entries are to be interpreted as triplets,
 489  *               each defining a segment representing a range of equally
 490  *               space voltages: <lowest_volts>, <highest_volt>, <step_uV>
 491  *             - when False the entries simply represent a single discrete
 492  *               supported voltage level
 493  * @negative_volts_allowed: True if any of the entries of @levels_uv represent
 494  *                          a negative voltage.
 495  * @attributes: represents Voltage Domain advertised attributes
 496  * @name: name assigned to the Voltage Domain by platform
 497  * @num_levels: number of total entries in @levels_uv.
 498  * @levels_uv: array of entries describing the available voltage levels for
 499  *             this domain.
 500  */
 501 struct scmi_voltage_info {
 502         unsigned int id;
 503         bool segmented;
 504         bool negative_volts_allowed;
 505         unsigned int attributes;
 506         char name[SCMI_MAX_STR_SIZE];
 507         unsigned int num_levels;
 508 #define SCMI_VOLTAGE_SEGMENT_LOW        0
 509 #define SCMI_VOLTAGE_SEGMENT_HIGH       1
 510 #define SCMI_VOLTAGE_SEGMENT_STEP       2
 511         int *levels_uv;
 512 };
 513
 514 /**
 515  * struct scmi_voltage_ops - represents the various operations provided
 516  * by SCMI Voltage Protocol
 517  *
 518  * @num_domains_get: get the count of voltage domains provided by SCMI
 519  * @info_get: get the information of the specified domain
 520  * @config_set: set the config for the specified domain
 521  * @config_get: get the config of the specified domain
 522  * @level_set: set the voltage level for the specified domain
 523  * @level_get: get the voltage level of the specified domain
 524  */
 525 struct scmi_voltage_ops {
 526         int (*num_domains_get)(const struct scmi_handle *handle);
 527         const struct scmi_voltage_info __must_check *(*info_get)
 528                 (const struct scmi_handle *handle, u32 domain_id);
 529         int (*config_set)(const struct scmi_handle *handle, u32 domain_id,
 530                           u32 config);
 531 #define SCMI_VOLTAGE_ARCH_STATE_OFF             0x0
 532 #define SCMI_VOLTAGE_ARCH_STATE_ON              0x7
 533         int (*config_get)(const struct scmi_handle *handle, u32 domain_id,
 534                           u32 *config);
 535         int (*level_set)(const struct scmi_handle *handle, u32 domain_id,
 536                          u32 flags, s32 volt_uV);
 537         int (*level_get)(const struct scmi_handle *handle, u32 domain_id,
 538                          s32 *volt_uV);
 539 };
 540
 541 /**
 542  * struct scmi_notify_ops  - represents notifications' operations provided by
 543  * SCMI core
 544  * @register_event_notifier: Register a notifier_block for the requested event
 545  * @unregister_event_notifier: Unregister a notifier_block for the requested
 546  *                             event
 547  *
 548  * A user can register/unregister its own notifier_block against the wanted
 549  * platform instance regarding the desired event identified by the
 550  * tuple: (proto_id, evt_id, src_id) using the provided register/unregister
 551  * interface where:
 552  *
 553  * @handle: The handle identifying the platform instance to use
 554  * @proto_id: The protocol ID as in SCMI Specification
 555  * @evt_id: The message ID of the desired event as in SCMI Specification
 556  * @src_id: A pointer to the desired source ID if different sources are
 557  *          possible for the protocol (like domain_id, sensor_id...etc)
 558  *
 559  * @src_id can be provided as NULL if it simply does NOT make sense for
 560  * the protocol at hand, OR if the user is explicitly interested in
 561  * receiving notifications from ANY existent source associated to the
 562  * specified proto_id / evt_id.
 563  *
 564  * Received notifications are finally delivered to the registered users,
 565  * invoking the callback provided with the notifier_block *nb as follows:
 566  *
 567  *      int user_cb(nb, evt_id, report)
 568  *
 569  * with:
 570  *
 571  * @nb: The notifier block provided by the user
 572  * @evt_id: The message ID of the delivered event
 573  * @report: A custom struct describing the specific event delivered
 574  */
 575 struct scmi_notify_ops {
 576         int (*register_event_notifier)(const struct scmi_handle *handle,
 577                                        u8 proto_id, u8 evt_id, u32 *src_id,
 578                                        struct notifier_block *nb);
 579         int (*unregister_event_notifier)(const struct scmi_handle *handle,
 580                                          u8 proto_id, u8 evt_id, u32 *src_id,
 581                                          struct notifier_block *nb);
 582 };
 583
 584 /**
 585  * struct scmi_handle - Handle returned to ARM SCMI clients for usage.
 586  *
 587  * @dev: pointer to the SCMI device
 588  * @version: pointer to the structure containing SCMI version information
 589  * @power_ops: pointer to set of power protocol operations
 590  * @perf_ops: pointer to set of performance protocol operations
 591  * @clk_ops: pointer to set of clock protocol operations
 592  * @sensor_ops: pointer to set of sensor protocol operations
 593  * @reset_ops: pointer to set of reset protocol operations
 594  * @voltage_ops: pointer to set of voltage protocol operations
 595  * @notify_ops: pointer to set of notifications related operations
 596  * @perf_priv: pointer to private data structure specific to performance
 597  *      protocol(for internal use only)
 598  * @clk_priv: pointer to private data structure specific to clock
 599  *      protocol(for internal use only)
 600  * @power_priv: pointer to private data structure specific to power
 601  *      protocol(for internal use only)
 602  * @sensor_priv: pointer to private data structure specific to sensors
 603  *      protocol(for internal use only)
 604  * @reset_priv: pointer to private data structure specific to reset
 605  *      protocol(for internal use only)
 606  * @voltage_priv: pointer to private data structure specific to voltage
 607  *      protocol(for internal use only)
 608  * @notify_priv: pointer to private data structure specific to notifications
 609  *      (for internal use only)
 610  */
 611 struct scmi_handle {
 612         struct device *dev;
 613         struct scmi_revision_info *version;
 614         const struct scmi_perf_ops *perf_ops;
 615         const struct scmi_clk_ops *clk_ops;
 616         const struct scmi_power_ops *power_ops;
 617         const struct scmi_sensor_ops *sensor_ops;
 618         const struct scmi_reset_ops *reset_ops;
 619         const struct scmi_voltage_ops *voltage_ops;
 620         const struct scmi_notify_ops *notify_ops;
 621         /* for protocol internal use */
 622         void *perf_priv;
 623         void *clk_priv;
 624         void *power_priv;
 625         void *sensor_priv;
 626         void *reset_priv;
 627         void *voltage_priv;
 628         void *notify_priv;
 629         void *system_priv;
 630 };
 631
 632 enum scmi_std_protocol {
 633         SCMI_PROTOCOL_BASE = 0x10,
 634         SCMI_PROTOCOL_POWER = 0x11,
 635         SCMI_PROTOCOL_SYSTEM = 0x12,
 636         SCMI_PROTOCOL_PERF = 0x13,
 637         SCMI_PROTOCOL_CLOCK = 0x14,
 638         SCMI_PROTOCOL_SENSOR = 0x15,
 639         SCMI_PROTOCOL_RESET = 0x16,
 640         SCMI_PROTOCOL_VOLTAGE = 0x17,
 641 };
 642
 643 enum scmi_system_events {
 644         SCMI_SYSTEM_SHUTDOWN,
 645         SCMI_SYSTEM_COLDRESET,
 646         SCMI_SYSTEM_WARMRESET,
 647         SCMI_SYSTEM_POWERUP,
 648         SCMI_SYSTEM_SUSPEND,
 649         SCMI_SYSTEM_MAX
 650 };
 651
 652 struct scmi_device {
 653         u32 id;
 654         u8 protocol_id;
 655         const char *name;
 656         struct device dev;
 657         struct scmi_handle *handle;
 658 };
 659
 660 #define to_scmi_dev(d) container_of(d, struct scmi_device, dev)
 661
 662 struct scmi_device *
 663 scmi_device_create(struct device_node *np, struct device *parent, int protocol,
 664                    const char *name);
 665 void scmi_device_destroy(struct scmi_device *scmi_dev);
 666
 667 struct scmi_device_id {
 668         u8 protocol_id;
 669         const char *name;
 670 };
 671
 672 struct scmi_driver {
 673         const char *name;
 674         int (*probe)(struct scmi_device *sdev);
 675         void (*remove)(struct scmi_device *sdev);
 676         const struct scmi_device_id *id_table;
 677
 678         struct device_driver driver;
 679 };
 680
 681 #define to_scmi_driver(d) container_of(d, struct scmi_driver, driver)
 682
 683 #if IS_REACHABLE(CONFIG_ARM_SCMI_PROTOCOL)
 684 int scmi_driver_register(struct scmi_driver *driver,
 685                          struct module *owner, const char *mod_name);
 686 void scmi_driver_unregister(struct scmi_driver *driver);
 687 #else
 688 static inline int
 689 scmi_driver_register(struct scmi_driver *driver, struct module *owner,
 690                      const char *mod_name)
 691 {
 692         return -EINVAL;
 693 }
 694
 695 static inline void scmi_driver_unregister(struct scmi_driver *driver) {}
 696 #endif /* CONFIG_ARM_SCMI_PROTOCOL */
 697
 698 #define scmi_register(driver) \
 699         scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
 700 #define scmi_unregister(driver) \
 701         scmi_driver_unregister(driver)
 702
 703 /**
 704  * module_scmi_driver() - Helper macro for registering a scmi driver
 705  * @__scmi_driver: scmi_driver structure
 706  *
 707  * Helper macro for scmi drivers to set up proper module init / exit
 708  * functions.  Replaces module_init() and module_exit() and keeps people from
 709  * printing pointless things to the kernel log when their driver is loaded.
 710  */
 711 #define module_scmi_driver(__scmi_driver)       \
 712         module_driver(__scmi_driver, scmi_register, scmi_unregister)
 713
 714 typedef int (*scmi_prot_init_fn_t)(struct scmi_handle *);
 715 int scmi_protocol_register(int protocol_id, scmi_prot_init_fn_t fn);
 716 void scmi_protocol_unregister(int protocol_id);
 717
 718 /* SCMI Notification API - Custom Event Reports */
 719 enum scmi_notification_events {
 720         SCMI_EVENT_POWER_STATE_CHANGED = 0x0,
 721         SCMI_EVENT_PERFORMANCE_LIMITS_CHANGED = 0x0,
 722         SCMI_EVENT_PERFORMANCE_LEVEL_CHANGED = 0x1,
 723         SCMI_EVENT_SENSOR_TRIP_POINT_EVENT = 0x0,
 724         SCMI_EVENT_SENSOR_UPDATE = 0x1,
 725         SCMI_EVENT_RESET_ISSUED = 0x0,
 726         SCMI_EVENT_BASE_ERROR_EVENT = 0x0,
 727         SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER = 0x0,
 728 };
 729
 730 struct scmi_power_state_changed_report {
 731         ktime_t         timestamp;
 732         unsigned int    agent_id;
 733         unsigned int    domain_id;
 734         unsigned int    power_state;
 735 };
 736
 737 struct scmi_system_power_state_notifier_report {
 738         ktime_t         timestamp;
 739         unsigned int    agent_id;
 740         unsigned int    flags;
 741         unsigned int    system_state;
 742 };
 743
 744 struct scmi_perf_limits_report {
 745         ktime_t         timestamp;
 746         unsigned int    agent_id;
 747         unsigned int    domain_id;
 748         unsigned int    range_max;
 749         unsigned int    range_min;
 750 };
 751
 752 struct scmi_perf_level_report {
 753         ktime_t         timestamp;
 754         unsigned int    agent_id;
 755         unsigned int    domain_id;
 756         unsigned int    performance_level;
 757 };
 758
 759 struct scmi_sensor_trip_point_report {
 760         ktime_t         timestamp;
 761         unsigned int    agent_id;
 762         unsigned int    sensor_id;
 763         unsigned int    trip_point_desc;
 764 };
 765
 766 struct scmi_sensor_update_report {
 767         ktime_t                         timestamp;
 768         unsigned int                    agent_id;
 769         unsigned int                    sensor_id;
 770         unsigned int                    readings_count;
 771         struct scmi_sensor_reading      readings[];
 772 };
 773
 774 struct scmi_reset_issued_report {
 775         ktime_t         timestamp;
 776         unsigned int    agent_id;
 777         unsigned int    domain_id;
 778         unsigned int    reset_state;
 779 };
 780
 781 struct scmi_base_error_report {
 782         ktime_t                 timestamp;
 783         unsigned int            agent_id;
 784         bool                    fatal;
 785         unsigned int            cmd_count;
 786         unsigned long long      reports[];
 787 };
 788
 789 #endif /* _LINUX_SCMI_PROTOCOL_H */