1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * SCMI Message Protocol driver header 4 * 5 * Copyright (C) 2018-2021 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 64 17 #define SCMI_SHORT_NAME_MAX_SIZE 16 18 #define SCMI_MAX_NUM_RATES 16 19 20 /** 21 * struct scmi_revision_info - version information structure 22 * 23 * @major_ver: Major ABI version. Change here implies risk of backward 24 * compatibility break. 25 * @minor_ver: Minor ABI version. Change here implies new feature addition, 26 * or compatible change in ABI. 27 * @num_protocols: Number of protocols that are implemented, excluding the 28 * base protocol. 29 * @num_agents: Number of agents in the system. 30 * @impl_ver: A vendor-specific implementation version. 31 * @vendor_id: A vendor identifier(Null terminated ASCII string) 32 * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string) 33 */ 34 struct scmi_revision_info { 35 u16 major_ver; 36 u16 minor_ver; 37 u8 num_protocols; 38 u8 num_agents; 39 u32 impl_ver; 40 char vendor_id[SCMI_SHORT_NAME_MAX_SIZE]; 41 char sub_vendor_id[SCMI_SHORT_NAME_MAX_SIZE]; 42 }; 43 44 struct scmi_clock_info { 45 char name[SCMI_MAX_STR_SIZE]; 46 unsigned int enable_latency; 47 bool rate_discrete; 48 bool rate_changed_notifications; 49 bool rate_change_requested_notifications; 50 bool state_ctrl_forbidden; 51 bool rate_ctrl_forbidden; 52 bool parent_ctrl_forbidden; 53 bool extended_config; 54 union { 55 struct { 56 int num_rates; 57 u64 rates[SCMI_MAX_NUM_RATES]; 58 } list; 59 struct { 60 u64 min_rate; 61 u64 max_rate; 62 u64 step_size; 63 } range; 64 }; 65 int num_parents; 66 u32 *parents; 67 }; 68 69 enum scmi_power_scale { 70 SCMI_POWER_BOGOWATTS, 71 SCMI_POWER_MILLIWATTS, 72 SCMI_POWER_MICROWATTS 73 }; 74 75 struct scmi_handle; 76 struct scmi_device; 77 struct scmi_protocol_handle; 78 79 /** 80 * struct scmi_clk_proto_ops - represents the various operations provided 81 * by SCMI Clock Protocol 82 * 83 * @count_get: get the count of clocks provided by SCMI 84 * @info_get: get the information of the specified clock 85 * @rate_get: request the current clock rate of a clock 86 * @rate_set: set the clock rate of a clock 87 * @enable: enables the specified clock 88 * @disable: disables the specified clock 89 * @state_get: get the status of the specified clock 90 * @config_oem_get: get the value of an OEM specific clock config 91 * @config_oem_set: set the value of an OEM specific clock config 92 * @parent_get: get the parent id of a clk 93 * @parent_set: set the parent of a clock 94 */ 95 struct scmi_clk_proto_ops { 96 int (*count_get)(const struct scmi_protocol_handle *ph); 97 98 const struct scmi_clock_info __must_check *(*info_get) 99 (const struct scmi_protocol_handle *ph, u32 clk_id); 100 int (*rate_get)(const struct scmi_protocol_handle *ph, u32 clk_id, 101 u64 *rate); 102 int (*rate_set)(const struct scmi_protocol_handle *ph, u32 clk_id, 103 u64 rate); 104 int (*enable)(const struct scmi_protocol_handle *ph, u32 clk_id, 105 bool atomic); 106 int (*disable)(const struct scmi_protocol_handle *ph, u32 clk_id, 107 bool atomic); 108 int (*state_get)(const struct scmi_protocol_handle *ph, u32 clk_id, 109 bool *enabled, bool atomic); 110 int (*config_oem_get)(const struct scmi_protocol_handle *ph, u32 clk_id, 111 u8 oem_type, u32 *oem_val, u32 *attributes, 112 bool atomic); 113 int (*config_oem_set)(const struct scmi_protocol_handle *ph, u32 clk_id, 114 u8 oem_type, u32 oem_val, bool atomic); 115 int (*parent_get)(const struct scmi_protocol_handle *ph, u32 clk_id, u32 *parent_id); 116 int (*parent_set)(const struct scmi_protocol_handle *ph, u32 clk_id, u32 parent_id); 117 }; 118 119 struct scmi_perf_domain_info { 120 char name[SCMI_MAX_STR_SIZE]; 121 bool set_perf; 122 }; 123 124 /** 125 * struct scmi_perf_proto_ops - represents the various operations provided 126 * by SCMI Performance Protocol 127 * 128 * @num_domains_get: gets the number of supported performance domains 129 * @info_get: get the information of a performance domain 130 * @limits_set: sets limits on the performance level of a domain 131 * @limits_get: gets limits on the performance level of a domain 132 * @level_set: sets the performance level of a domain 133 * @level_get: gets the performance level of a domain 134 * @transition_latency_get: gets the DVFS transition latency for a given device 135 * @device_opps_add: adds all the OPPs for a given device 136 * @freq_set: sets the frequency for a given device using sustained frequency 137 * to sustained performance level mapping 138 * @freq_get: gets the frequency for a given device using sustained frequency 139 * to sustained performance level mapping 140 * @est_power_get: gets the estimated power cost for a given performance domain 141 * at a given frequency 142 * @fast_switch_possible: indicates if fast DVFS switching is possible or not 143 * for a given device 144 * @power_scale_mw_get: indicates if the power values provided are in milliWatts 145 * or in some other (abstract) scale 146 */ 147 struct scmi_perf_proto_ops { 148 int (*num_domains_get)(const struct scmi_protocol_handle *ph); 149 const struct scmi_perf_domain_info __must_check *(*info_get) 150 (const struct scmi_protocol_handle *ph, u32 domain); 151 int (*limits_set)(const struct scmi_protocol_handle *ph, u32 domain, 152 u32 max_perf, u32 min_perf); 153 int (*limits_get)(const struct scmi_protocol_handle *ph, u32 domain, 154 u32 *max_perf, u32 *min_perf); 155 int (*level_set)(const struct scmi_protocol_handle *ph, u32 domain, 156 u32 level, bool poll); 157 int (*level_get)(const struct scmi_protocol_handle *ph, u32 domain, 158 u32 *level, bool poll); 159 int (*transition_latency_get)(const struct scmi_protocol_handle *ph, 160 u32 domain); 161 int (*device_opps_add)(const struct scmi_protocol_handle *ph, 162 struct device *dev, u32 domain); 163 int (*freq_set)(const struct scmi_protocol_handle *ph, u32 domain, 164 unsigned long rate, bool poll); 165 int (*freq_get)(const struct scmi_protocol_handle *ph, u32 domain, 166 unsigned long *rate, bool poll); 167 int (*est_power_get)(const struct scmi_protocol_handle *ph, u32 domain, 168 unsigned long *rate, unsigned long *power); 169 bool (*fast_switch_possible)(const struct scmi_protocol_handle *ph, 170 u32 domain); 171 enum scmi_power_scale (*power_scale_get)(const struct scmi_protocol_handle *ph); 172 }; 173 174 /** 175 * struct scmi_power_proto_ops - represents the various operations provided 176 * by SCMI Power Protocol 177 * 178 * @num_domains_get: get the count of power domains provided by SCMI 179 * @name_get: gets the name of a power domain 180 * @state_set: sets the power state of a power domain 181 * @state_get: gets the power state of a power domain 182 */ 183 struct scmi_power_proto_ops { 184 int (*num_domains_get)(const struct scmi_protocol_handle *ph); 185 const char *(*name_get)(const struct scmi_protocol_handle *ph, 186 u32 domain); 187 #define SCMI_POWER_STATE_TYPE_SHIFT 30 188 #define SCMI_POWER_STATE_ID_MASK (BIT(28) - 1) 189 #define SCMI_POWER_STATE_PARAM(type, id) \ 190 ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \ 191 ((id) & SCMI_POWER_STATE_ID_MASK)) 192 #define SCMI_POWER_STATE_GENERIC_ON SCMI_POWER_STATE_PARAM(0, 0) 193 #define SCMI_POWER_STATE_GENERIC_OFF SCMI_POWER_STATE_PARAM(1, 0) 194 int (*state_set)(const struct scmi_protocol_handle *ph, u32 domain, 195 u32 state); 196 int (*state_get)(const struct scmi_protocol_handle *ph, u32 domain, 197 u32 *state); 198 }; 199 200 /** 201 * struct scmi_sensor_reading - represent a timestamped read 202 * 203 * Used by @reading_get_timestamped method. 204 * 205 * @value: The signed value sensor read. 206 * @timestamp: An unsigned timestamp for the sensor read, as provided by 207 * SCMI platform. Set to zero when not available. 208 */ 209 struct scmi_sensor_reading { 210 long long value; 211 unsigned long long timestamp; 212 }; 213 214 /** 215 * struct scmi_range_attrs - specifies a sensor or axis values' range 216 * @min_range: The minimum value which can be represented by the sensor/axis. 217 * @max_range: The maximum value which can be represented by the sensor/axis. 218 */ 219 struct scmi_range_attrs { 220 long long min_range; 221 long long max_range; 222 }; 223 224 /** 225 * struct scmi_sensor_axis_info - describes one sensor axes 226 * @id: The axes ID. 227 * @type: Axes type. Chosen amongst one of @enum scmi_sensor_class. 228 * @scale: Power-of-10 multiplier applied to the axis unit. 229 * @name: NULL-terminated string representing axes name as advertised by 230 * SCMI platform. 231 * @extended_attrs: Flag to indicate the presence of additional extended 232 * attributes for this axes. 233 * @resolution: Extended attribute representing the resolution of the axes. 234 * Set to 0 if not reported by this axes. 235 * @exponent: Extended attribute representing the power-of-10 multiplier that 236 * is applied to the resolution field. Set to 0 if not reported by 237 * this axes. 238 * @attrs: Extended attributes representing minimum and maximum values 239 * measurable by this axes. Set to 0 if not reported by this sensor. 240 */ 241 struct scmi_sensor_axis_info { 242 unsigned int id; 243 unsigned int type; 244 int scale; 245 char name[SCMI_MAX_STR_SIZE]; 246 bool extended_attrs; 247 unsigned int resolution; 248 int exponent; 249 struct scmi_range_attrs attrs; 250 }; 251 252 /** 253 * struct scmi_sensor_intervals_info - describes number and type of available 254 * update intervals 255 * @segmented: Flag for segmented intervals' representation. When True there 256 * will be exactly 3 intervals in @desc, with each entry 257 * representing a member of a segment in this order: 258 * {lowest update interval, highest update interval, step size} 259 * @count: Number of intervals described in @desc. 260 * @desc: Array of @count interval descriptor bitmask represented as detailed in 261 * the SCMI specification: it can be accessed using the accompanying 262 * macros. 263 * @prealloc_pool: A minimal preallocated pool of desc entries used to avoid 264 * lesser-than-64-bytes dynamic allocation for small @count 265 * values. 266 */ 267 struct scmi_sensor_intervals_info { 268 bool segmented; 269 unsigned int count; 270 #define SCMI_SENS_INTVL_SEGMENT_LOW 0 271 #define SCMI_SENS_INTVL_SEGMENT_HIGH 1 272 #define SCMI_SENS_INTVL_SEGMENT_STEP 2 273 unsigned int *desc; 274 #define SCMI_SENS_INTVL_GET_SECS(x) FIELD_GET(GENMASK(20, 5), (x)) 275 #define SCMI_SENS_INTVL_GET_EXP(x) \ 276 ({ \ 277 int __signed_exp = FIELD_GET(GENMASK(4, 0), (x)); \ 278 \ 279 if (__signed_exp & BIT(4)) \ 280 __signed_exp |= GENMASK(31, 5); \ 281 __signed_exp; \ 282 }) 283 #define SCMI_MAX_PREALLOC_POOL 16 284 unsigned int prealloc_pool[SCMI_MAX_PREALLOC_POOL]; 285 }; 286 287 /** 288 * struct scmi_sensor_info - represents information related to one of the 289 * available sensors. 290 * @id: Sensor ID. 291 * @type: Sensor type. Chosen amongst one of @enum scmi_sensor_class. 292 * @scale: Power-of-10 multiplier applied to the sensor unit. 293 * @num_trip_points: Number of maximum configurable trip points. 294 * @async: Flag for asynchronous read support. 295 * @update: Flag for continuouos update notification support. 296 * @timestamped: Flag for timestamped read support. 297 * @tstamp_scale: Power-of-10 multiplier applied to the sensor timestamps to 298 * represent it in seconds. 299 * @num_axis: Number of supported axis if any. Reported as 0 for scalar sensors. 300 * @axis: Pointer to an array of @num_axis descriptors. 301 * @intervals: Descriptor of available update intervals. 302 * @sensor_config: A bitmask reporting the current sensor configuration as 303 * detailed in the SCMI specification: it can accessed and 304 * modified through the accompanying macros. 305 * @name: NULL-terminated string representing sensor name as advertised by 306 * SCMI platform. 307 * @extended_scalar_attrs: Flag to indicate the presence of additional extended 308 * attributes for this sensor. 309 * @sensor_power: Extended attribute representing the average power 310 * consumed by the sensor in microwatts (uW) when it is active. 311 * Reported here only for scalar sensors. 312 * Set to 0 if not reported by this sensor. 313 * @resolution: Extended attribute representing the resolution of the sensor. 314 * Reported here only for scalar sensors. 315 * Set to 0 if not reported by this sensor. 316 * @exponent: Extended attribute representing the power-of-10 multiplier that is 317 * applied to the resolution field. 318 * Reported here only for scalar sensors. 319 * Set to 0 if not reported by this sensor. 320 * @scalar_attrs: Extended attributes representing minimum and maximum 321 * measurable values by this sensor. 322 * Reported here only for scalar sensors. 323 * Set to 0 if not reported by this sensor. 324 */ 325 struct scmi_sensor_info { 326 unsigned int id; 327 unsigned int type; 328 int scale; 329 unsigned int num_trip_points; 330 bool async; 331 bool update; 332 bool timestamped; 333 int tstamp_scale; 334 unsigned int num_axis; 335 struct scmi_sensor_axis_info *axis; 336 struct scmi_sensor_intervals_info intervals; 337 unsigned int sensor_config; 338 #define SCMI_SENS_CFG_UPDATE_SECS_MASK GENMASK(31, 16) 339 #define SCMI_SENS_CFG_GET_UPDATE_SECS(x) \ 340 FIELD_GET(SCMI_SENS_CFG_UPDATE_SECS_MASK, (x)) 341 342 #define SCMI_SENS_CFG_UPDATE_EXP_MASK GENMASK(15, 11) 343 #define SCMI_SENS_CFG_GET_UPDATE_EXP(x) \ 344 ({ \ 345 int __signed_exp = \ 346 FIELD_GET(SCMI_SENS_CFG_UPDATE_EXP_MASK, (x)); \ 347 \ 348 if (__signed_exp & BIT(4)) \ 349 __signed_exp |= GENMASK(31, 5); \ 350 __signed_exp; \ 351 }) 352 353 #define SCMI_SENS_CFG_ROUND_MASK GENMASK(10, 9) 354 #define SCMI_SENS_CFG_ROUND_AUTO 2 355 #define SCMI_SENS_CFG_ROUND_UP 1 356 #define SCMI_SENS_CFG_ROUND_DOWN 0 357 358 #define SCMI_SENS_CFG_TSTAMP_ENABLED_MASK BIT(1) 359 #define SCMI_SENS_CFG_TSTAMP_ENABLE 1 360 #define SCMI_SENS_CFG_TSTAMP_DISABLE 0 361 #define SCMI_SENS_CFG_IS_TSTAMP_ENABLED(x) \ 362 FIELD_GET(SCMI_SENS_CFG_TSTAMP_ENABLED_MASK, (x)) 363 364 #define SCMI_SENS_CFG_SENSOR_ENABLED_MASK BIT(0) 365 #define SCMI_SENS_CFG_SENSOR_ENABLE 1 366 #define SCMI_SENS_CFG_SENSOR_DISABLE 0 367 char name[SCMI_MAX_STR_SIZE]; 368 #define SCMI_SENS_CFG_IS_ENABLED(x) FIELD_GET(BIT(0), (x)) 369 bool extended_scalar_attrs; 370 unsigned int sensor_power; 371 unsigned int resolution; 372 int exponent; 373 struct scmi_range_attrs scalar_attrs; 374 }; 375 376 /* 377 * Partial list from Distributed Management Task Force (DMTF) specification: 378 * DSP0249 (Platform Level Data Model specification) 379 */ 380 enum scmi_sensor_class { 381 NONE = 0x0, 382 UNSPEC = 0x1, 383 TEMPERATURE_C = 0x2, 384 TEMPERATURE_F = 0x3, 385 TEMPERATURE_K = 0x4, 386 VOLTAGE = 0x5, 387 CURRENT = 0x6, 388 POWER = 0x7, 389 ENERGY = 0x8, 390 CHARGE = 0x9, 391 VOLTAMPERE = 0xA, 392 NITS = 0xB, 393 LUMENS = 0xC, 394 LUX = 0xD, 395 CANDELAS = 0xE, 396 KPA = 0xF, 397 PSI = 0x10, 398 NEWTON = 0x11, 399 CFM = 0x12, 400 RPM = 0x13, 401 HERTZ = 0x14, 402 SECS = 0x15, 403 MINS = 0x16, 404 HOURS = 0x17, 405 DAYS = 0x18, 406 WEEKS = 0x19, 407 MILS = 0x1A, 408 INCHES = 0x1B, 409 FEET = 0x1C, 410 CUBIC_INCHES = 0x1D, 411 CUBIC_FEET = 0x1E, 412 METERS = 0x1F, 413 CUBIC_CM = 0x20, 414 CUBIC_METERS = 0x21, 415 LITERS = 0x22, 416 FLUID_OUNCES = 0x23, 417 RADIANS = 0x24, 418 STERADIANS = 0x25, 419 REVOLUTIONS = 0x26, 420 CYCLES = 0x27, 421 GRAVITIES = 0x28, 422 OUNCES = 0x29, 423 POUNDS = 0x2A, 424 FOOT_POUNDS = 0x2B, 425 OUNCE_INCHES = 0x2C, 426 GAUSS = 0x2D, 427 GILBERTS = 0x2E, 428 HENRIES = 0x2F, 429 FARADS = 0x30, 430 OHMS = 0x31, 431 SIEMENS = 0x32, 432 MOLES = 0x33, 433 BECQUERELS = 0x34, 434 PPM = 0x35, 435 DECIBELS = 0x36, 436 DBA = 0x37, 437 DBC = 0x38, 438 GRAYS = 0x39, 439 SIEVERTS = 0x3A, 440 COLOR_TEMP_K = 0x3B, 441 BITS = 0x3C, 442 BYTES = 0x3D, 443 WORDS = 0x3E, 444 DWORDS = 0x3F, 445 QWORDS = 0x40, 446 PERCENTAGE = 0x41, 447 PASCALS = 0x42, 448 COUNTS = 0x43, 449 GRAMS = 0x44, 450 NEWTON_METERS = 0x45, 451 HITS = 0x46, 452 MISSES = 0x47, 453 RETRIES = 0x48, 454 OVERRUNS = 0x49, 455 UNDERRUNS = 0x4A, 456 COLLISIONS = 0x4B, 457 PACKETS = 0x4C, 458 MESSAGES = 0x4D, 459 CHARS = 0x4E, 460 ERRORS = 0x4F, 461 CORRECTED_ERRS = 0x50, 462 UNCORRECTABLE_ERRS = 0x51, 463 SQ_MILS = 0x52, 464 SQ_INCHES = 0x53, 465 SQ_FEET = 0x54, 466 SQ_CM = 0x55, 467 SQ_METERS = 0x56, 468 RADIANS_SEC = 0x57, 469 BPM = 0x58, 470 METERS_SEC_SQUARED = 0x59, 471 METERS_SEC = 0x5A, 472 CUBIC_METERS_SEC = 0x5B, 473 MM_MERCURY = 0x5C, 474 RADIANS_SEC_SQUARED = 0x5D, 475 OEM_UNIT = 0xFF 476 }; 477 478 /** 479 * struct scmi_sensor_proto_ops - represents the various operations provided 480 * by SCMI Sensor Protocol 481 * 482 * @count_get: get the count of sensors provided by SCMI 483 * @info_get: get the information of the specified sensor 484 * @trip_point_config: selects and configures a trip-point of interest 485 * @reading_get: gets the current value of the sensor 486 * @reading_get_timestamped: gets the current value and timestamp, when 487 * available, of the sensor. (as of v3.0 spec) 488 * Supports multi-axis sensors for sensors which 489 * supports it and if the @reading array size of 490 * @count entry equals the sensor num_axis 491 * @config_get: Get sensor current configuration 492 * @config_set: Set sensor current configuration 493 */ 494 struct scmi_sensor_proto_ops { 495 int (*count_get)(const struct scmi_protocol_handle *ph); 496 const struct scmi_sensor_info __must_check *(*info_get) 497 (const struct scmi_protocol_handle *ph, u32 sensor_id); 498 int (*trip_point_config)(const struct scmi_protocol_handle *ph, 499 u32 sensor_id, u8 trip_id, u64 trip_value); 500 int (*reading_get)(const struct scmi_protocol_handle *ph, u32 sensor_id, 501 u64 *value); 502 int (*reading_get_timestamped)(const struct scmi_protocol_handle *ph, 503 u32 sensor_id, u8 count, 504 struct scmi_sensor_reading *readings); 505 int (*config_get)(const struct scmi_protocol_handle *ph, 506 u32 sensor_id, u32 *sensor_config); 507 int (*config_set)(const struct scmi_protocol_handle *ph, 508 u32 sensor_id, u32 sensor_config); 509 }; 510 511 /** 512 * struct scmi_reset_proto_ops - represents the various operations provided 513 * by SCMI Reset Protocol 514 * 515 * @num_domains_get: get the count of reset domains provided by SCMI 516 * @name_get: gets the name of a reset domain 517 * @latency_get: gets the reset latency for the specified reset domain 518 * @reset: resets the specified reset domain 519 * @assert: explicitly assert reset signal of the specified reset domain 520 * @deassert: explicitly deassert reset signal of the specified reset domain 521 */ 522 struct scmi_reset_proto_ops { 523 int (*num_domains_get)(const struct scmi_protocol_handle *ph); 524 const char *(*name_get)(const struct scmi_protocol_handle *ph, 525 u32 domain); 526 int (*latency_get)(const struct scmi_protocol_handle *ph, u32 domain); 527 int (*reset)(const struct scmi_protocol_handle *ph, u32 domain); 528 int (*assert)(const struct scmi_protocol_handle *ph, u32 domain); 529 int (*deassert)(const struct scmi_protocol_handle *ph, u32 domain); 530 }; 531 532 enum scmi_voltage_level_mode { 533 SCMI_VOLTAGE_LEVEL_SET_AUTO, 534 SCMI_VOLTAGE_LEVEL_SET_SYNC, 535 }; 536 537 /** 538 * struct scmi_voltage_info - describe one available SCMI Voltage Domain 539 * 540 * @id: the domain ID as advertised by the platform 541 * @segmented: defines the layout of the entries of array @levels_uv. 542 * - when True the entries are to be interpreted as triplets, 543 * each defining a segment representing a range of equally 544 * space voltages: <lowest_volts>, <highest_volt>, <step_uV> 545 * - when False the entries simply represent a single discrete 546 * supported voltage level 547 * @negative_volts_allowed: True if any of the entries of @levels_uv represent 548 * a negative voltage. 549 * @async_level_set: True when the voltage domain supports asynchronous level 550 * set commands. 551 * @name: name assigned to the Voltage Domain by platform 552 * @num_levels: number of total entries in @levels_uv. 553 * @levels_uv: array of entries describing the available voltage levels for 554 * this domain. 555 */ 556 struct scmi_voltage_info { 557 unsigned int id; 558 bool segmented; 559 bool negative_volts_allowed; 560 bool async_level_set; 561 char name[SCMI_MAX_STR_SIZE]; 562 unsigned int num_levels; 563 #define SCMI_VOLTAGE_SEGMENT_LOW 0 564 #define SCMI_VOLTAGE_SEGMENT_HIGH 1 565 #define SCMI_VOLTAGE_SEGMENT_STEP 2 566 int *levels_uv; 567 }; 568 569 /** 570 * struct scmi_voltage_proto_ops - represents the various operations provided 571 * by SCMI Voltage Protocol 572 * 573 * @num_domains_get: get the count of voltage domains provided by SCMI 574 * @info_get: get the information of the specified domain 575 * @config_set: set the config for the specified domain 576 * @config_get: get the config of the specified domain 577 * @level_set: set the voltage level for the specified domain 578 * @level_get: get the voltage level of the specified domain 579 */ 580 struct scmi_voltage_proto_ops { 581 int (*num_domains_get)(const struct scmi_protocol_handle *ph); 582 const struct scmi_voltage_info __must_check *(*info_get) 583 (const struct scmi_protocol_handle *ph, u32 domain_id); 584 int (*config_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 585 u32 config); 586 #define SCMI_VOLTAGE_ARCH_STATE_OFF 0x0 587 #define SCMI_VOLTAGE_ARCH_STATE_ON 0x7 588 int (*config_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 589 u32 *config); 590 int (*level_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 591 enum scmi_voltage_level_mode mode, s32 volt_uV); 592 int (*level_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 593 s32 *volt_uV); 594 }; 595 596 /** 597 * struct scmi_powercap_info - Describe one available Powercap domain 598 * 599 * @id: Domain ID as advertised by the platform. 600 * @notify_powercap_cap_change: CAP change notification support. 601 * @notify_powercap_measurement_change: MEASUREMENTS change notifications 602 * support. 603 * @async_powercap_cap_set: Asynchronous CAP set support. 604 * @powercap_cap_config: CAP configuration support. 605 * @powercap_monitoring: Monitoring (measurements) support. 606 * @powercap_pai_config: PAI configuration support. 607 * @powercap_scale_mw: Domain reports power data in milliwatt units. 608 * @powercap_scale_uw: Domain reports power data in microwatt units. 609 * Note that, when both @powercap_scale_mw and 610 * @powercap_scale_uw are set to false, the domain 611 * reports power data on an abstract linear scale. 612 * @name: name assigned to the Powercap Domain by platform. 613 * @min_pai: Minimum configurable PAI. 614 * @max_pai: Maximum configurable PAI. 615 * @pai_step: Step size between two consecutive PAI values. 616 * @min_power_cap: Minimum configurable CAP. 617 * @max_power_cap: Maximum configurable CAP. 618 * @power_cap_step: Step size between two consecutive CAP values. 619 * @sustainable_power: Maximum sustainable power consumption for this domain 620 * under normal conditions. 621 * @accuracy: The accuracy with which the power is measured and reported in 622 * integral multiples of 0.001 percent. 623 * @parent_id: Identifier of the containing parent power capping domain, or the 624 * value 0xFFFFFFFF if this powercap domain is a root domain not 625 * contained in any other domain. 626 */ 627 struct scmi_powercap_info { 628 unsigned int id; 629 bool notify_powercap_cap_change; 630 bool notify_powercap_measurement_change; 631 bool async_powercap_cap_set; 632 bool powercap_cap_config; 633 bool powercap_monitoring; 634 bool powercap_pai_config; 635 bool powercap_scale_mw; 636 bool powercap_scale_uw; 637 bool fastchannels; 638 char name[SCMI_MAX_STR_SIZE]; 639 unsigned int min_pai; 640 unsigned int max_pai; 641 unsigned int pai_step; 642 unsigned int min_power_cap; 643 unsigned int max_power_cap; 644 unsigned int power_cap_step; 645 unsigned int sustainable_power; 646 unsigned int accuracy; 647 #define SCMI_POWERCAP_ROOT_ZONE_ID 0xFFFFFFFFUL 648 unsigned int parent_id; 649 struct scmi_fc_info *fc_info; 650 }; 651 652 /** 653 * struct scmi_powercap_proto_ops - represents the various operations provided 654 * by SCMI Powercap Protocol 655 * 656 * @num_domains_get: get the count of powercap domains provided by SCMI. 657 * @info_get: get the information for the specified domain. 658 * @cap_get: get the current CAP value for the specified domain. 659 * On SCMI platforms supporting powercap zone disabling, this could 660 * report a zero value for a zone where powercapping is disabled. 661 * @cap_set: set the CAP value for the specified domain to the provided value; 662 * if the domain supports setting the CAP with an asynchronous command 663 * this request will finally trigger an asynchronous transfer, but, if 664 * @ignore_dresp here is set to true, this call will anyway return 665 * immediately without waiting for the related delayed response. 666 * Note that the powercap requested value must NOT be zero, even if 667 * the platform supports disabling a powercap by setting its cap to 668 * zero (since SCMI v3.2): there are dedicated operations that should 669 * be used for that. (@cap_enable_set/get) 670 * @cap_enable_set: enable or disable the powercapping on the specified domain, 671 * if supported by the SCMI platform implementation. 672 * Note that, by the SCMI specification, the platform can 673 * silently ignore our disable request and decide to enforce 674 * anyway some other powercap value requested by another agent 675 * on the system: for this reason @cap_get and @cap_enable_get 676 * will always report the final platform view of the powercaps. 677 * @cap_enable_get: get the current CAP enable status for the specified domain. 678 * @pai_get: get the current PAI value for the specified domain. 679 * @pai_set: set the PAI value for the specified domain to the provided value. 680 * @measurements_get: retrieve the current average power measurements for the 681 * specified domain and the related PAI upon which is 682 * calculated. 683 * @measurements_threshold_set: set the desired low and high power thresholds 684 * to be used when registering for notification 685 * of type POWERCAP_MEASUREMENTS_NOTIFY with this 686 * powercap domain. 687 * Note that this must be called at least once 688 * before registering any callback with the usual 689 * @scmi_notify_ops; moreover, in case this method 690 * is called with measurement notifications already 691 * enabled it will also trigger, transparently, a 692 * proper update of the power thresholds configured 693 * in the SCMI backend server. 694 * @measurements_threshold_get: get the currently configured low and high power 695 * thresholds used when registering callbacks for 696 * notification POWERCAP_MEASUREMENTS_NOTIFY. 697 */ 698 struct scmi_powercap_proto_ops { 699 int (*num_domains_get)(const struct scmi_protocol_handle *ph); 700 const struct scmi_powercap_info __must_check *(*info_get) 701 (const struct scmi_protocol_handle *ph, u32 domain_id); 702 int (*cap_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 703 u32 *power_cap); 704 int (*cap_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 705 u32 power_cap, bool ignore_dresp); 706 int (*cap_enable_set)(const struct scmi_protocol_handle *ph, 707 u32 domain_id, bool enable); 708 int (*cap_enable_get)(const struct scmi_protocol_handle *ph, 709 u32 domain_id, bool *enable); 710 int (*pai_get)(const struct scmi_protocol_handle *ph, u32 domain_id, 711 u32 *pai); 712 int (*pai_set)(const struct scmi_protocol_handle *ph, u32 domain_id, 713 u32 pai); 714 int (*measurements_get)(const struct scmi_protocol_handle *ph, 715 u32 domain_id, u32 *average_power, u32 *pai); 716 int (*measurements_threshold_set)(const struct scmi_protocol_handle *ph, 717 u32 domain_id, u32 power_thresh_low, 718 u32 power_thresh_high); 719 int (*measurements_threshold_get)(const struct scmi_protocol_handle *ph, 720 u32 domain_id, u32 *power_thresh_low, 721 u32 *power_thresh_high); 722 }; 723 724 /** 725 * struct scmi_notify_ops - represents notifications' operations provided by 726 * SCMI core 727 * @devm_event_notifier_register: Managed registration of a notifier_block for 728 * the requested event 729 * @devm_event_notifier_unregister: Managed unregistration of a notifier_block 730 * for the requested event 731 * @event_notifier_register: Register a notifier_block for the requested event 732 * @event_notifier_unregister: Unregister a notifier_block for the requested 733 * event 734 * 735 * A user can register/unregister its own notifier_block against the wanted 736 * platform instance regarding the desired event identified by the 737 * tuple: (proto_id, evt_id, src_id) using the provided register/unregister 738 * interface where: 739 * 740 * @sdev: The scmi_device to use when calling the devres managed ops devm_ 741 * @handle: The handle identifying the platform instance to use, when not 742 * calling the managed ops devm_ 743 * @proto_id: The protocol ID as in SCMI Specification 744 * @evt_id: The message ID of the desired event as in SCMI Specification 745 * @src_id: A pointer to the desired source ID if different sources are 746 * possible for the protocol (like domain_id, sensor_id...etc) 747 * 748 * @src_id can be provided as NULL if it simply does NOT make sense for 749 * the protocol at hand, OR if the user is explicitly interested in 750 * receiving notifications from ANY existent source associated to the 751 * specified proto_id / evt_id. 752 * 753 * Received notifications are finally delivered to the registered users, 754 * invoking the callback provided with the notifier_block *nb as follows: 755 * 756 * int user_cb(nb, evt_id, report) 757 * 758 * with: 759 * 760 * @nb: The notifier block provided by the user 761 * @evt_id: The message ID of the delivered event 762 * @report: A custom struct describing the specific event delivered 763 */ 764 struct scmi_notify_ops { 765 int (*devm_event_notifier_register)(struct scmi_device *sdev, 766 u8 proto_id, u8 evt_id, 767 const u32 *src_id, 768 struct notifier_block *nb); 769 int (*devm_event_notifier_unregister)(struct scmi_device *sdev, 770 u8 proto_id, u8 evt_id, 771 const u32 *src_id, 772 struct notifier_block *nb); 773 int (*event_notifier_register)(const struct scmi_handle *handle, 774 u8 proto_id, u8 evt_id, 775 const u32 *src_id, 776 struct notifier_block *nb); 777 int (*event_notifier_unregister)(const struct scmi_handle *handle, 778 u8 proto_id, u8 evt_id, 779 const u32 *src_id, 780 struct notifier_block *nb); 781 }; 782 783 /** 784 * struct scmi_handle - Handle returned to ARM SCMI clients for usage. 785 * 786 * @dev: pointer to the SCMI device 787 * @version: pointer to the structure containing SCMI version information 788 * @devm_protocol_acquire: devres managed method to get hold of a protocol, 789 * causing its initialization and related resource 790 * accounting 791 * @devm_protocol_get: devres managed method to acquire a protocol and get specific 792 * operations and a dedicated protocol handler 793 * @devm_protocol_put: devres managed method to release a protocol 794 * @is_transport_atomic: method to check if the underlying transport for this 795 * instance handle is configured to support atomic 796 * transactions for commands. 797 * Some users of the SCMI stack in the upper layers could 798 * be interested to know if they can assume SCMI 799 * command transactions associated to this handle will 800 * never sleep and act accordingly. 801 * An optional atomic threshold value could be returned 802 * where configured. 803 * @notify_ops: pointer to set of notifications related operations 804 */ 805 struct scmi_handle { 806 struct device *dev; 807 struct scmi_revision_info *version; 808 809 int __must_check (*devm_protocol_acquire)(struct scmi_device *sdev, 810 u8 proto); 811 const void __must_check * 812 (*devm_protocol_get)(struct scmi_device *sdev, u8 proto, 813 struct scmi_protocol_handle **ph); 814 void (*devm_protocol_put)(struct scmi_device *sdev, u8 proto); 815 bool (*is_transport_atomic)(const struct scmi_handle *handle, 816 unsigned int *atomic_threshold); 817 818 const struct scmi_notify_ops *notify_ops; 819 }; 820 821 enum scmi_std_protocol { 822 SCMI_PROTOCOL_BASE = 0x10, 823 SCMI_PROTOCOL_POWER = 0x11, 824 SCMI_PROTOCOL_SYSTEM = 0x12, 825 SCMI_PROTOCOL_PERF = 0x13, 826 SCMI_PROTOCOL_CLOCK = 0x14, 827 SCMI_PROTOCOL_SENSOR = 0x15, 828 SCMI_PROTOCOL_RESET = 0x16, 829 SCMI_PROTOCOL_VOLTAGE = 0x17, 830 SCMI_PROTOCOL_POWERCAP = 0x18, 831 }; 832 833 enum scmi_system_events { 834 SCMI_SYSTEM_SHUTDOWN, 835 SCMI_SYSTEM_COLDRESET, 836 SCMI_SYSTEM_WARMRESET, 837 SCMI_SYSTEM_POWERUP, 838 SCMI_SYSTEM_SUSPEND, 839 SCMI_SYSTEM_MAX 840 }; 841 842 struct scmi_device { 843 u32 id; 844 u8 protocol_id; 845 const char *name; 846 struct device dev; 847 struct scmi_handle *handle; 848 }; 849 850 #define to_scmi_dev(d) container_of(d, struct scmi_device, dev) 851 852 struct scmi_device_id { 853 u8 protocol_id; 854 const char *name; 855 }; 856 857 struct scmi_driver { 858 const char *name; 859 int (*probe)(struct scmi_device *sdev); 860 void (*remove)(struct scmi_device *sdev); 861 const struct scmi_device_id *id_table; 862 863 struct device_driver driver; 864 }; 865 866 #define to_scmi_driver(d) container_of(d, struct scmi_driver, driver) 867 868 #if IS_REACHABLE(CONFIG_ARM_SCMI_PROTOCOL) 869 int scmi_driver_register(struct scmi_driver *driver, 870 struct module *owner, const char *mod_name); 871 void scmi_driver_unregister(struct scmi_driver *driver); 872 #else 873 static inline int 874 scmi_driver_register(struct scmi_driver *driver, struct module *owner, 875 const char *mod_name) 876 { 877 return -EINVAL; 878 } 879 880 static inline void scmi_driver_unregister(struct scmi_driver *driver) {} 881 #endif /* CONFIG_ARM_SCMI_PROTOCOL */ 882 883 #define scmi_register(driver) \ 884 scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME) 885 #define scmi_unregister(driver) \ 886 scmi_driver_unregister(driver) 887 888 /** 889 * module_scmi_driver() - Helper macro for registering a scmi driver 890 * @__scmi_driver: scmi_driver structure 891 * 892 * Helper macro for scmi drivers to set up proper module init / exit 893 * functions. Replaces module_init() and module_exit() and keeps people from 894 * printing pointless things to the kernel log when their driver is loaded. 895 */ 896 #define module_scmi_driver(__scmi_driver) \ 897 module_driver(__scmi_driver, scmi_register, scmi_unregister) 898 899 /** 900 * module_scmi_protocol() - Helper macro for registering a scmi protocol 901 * @__scmi_protocol: scmi_protocol structure 902 * 903 * Helper macro for scmi drivers to set up proper module init / exit 904 * functions. Replaces module_init() and module_exit() and keeps people from 905 * printing pointless things to the kernel log when their driver is loaded. 906 */ 907 #define module_scmi_protocol(__scmi_protocol) \ 908 module_driver(__scmi_protocol, \ 909 scmi_protocol_register, scmi_protocol_unregister) 910 911 struct scmi_protocol; 912 int scmi_protocol_register(const struct scmi_protocol *proto); 913 void scmi_protocol_unregister(const struct scmi_protocol *proto); 914 915 /* SCMI Notification API - Custom Event Reports */ 916 enum scmi_notification_events { 917 SCMI_EVENT_POWER_STATE_CHANGED = 0x0, 918 SCMI_EVENT_CLOCK_RATE_CHANGED = 0x0, 919 SCMI_EVENT_CLOCK_RATE_CHANGE_REQUESTED = 0x1, 920 SCMI_EVENT_PERFORMANCE_LIMITS_CHANGED = 0x0, 921 SCMI_EVENT_PERFORMANCE_LEVEL_CHANGED = 0x1, 922 SCMI_EVENT_SENSOR_TRIP_POINT_EVENT = 0x0, 923 SCMI_EVENT_SENSOR_UPDATE = 0x1, 924 SCMI_EVENT_RESET_ISSUED = 0x0, 925 SCMI_EVENT_BASE_ERROR_EVENT = 0x0, 926 SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER = 0x0, 927 SCMI_EVENT_POWERCAP_CAP_CHANGED = 0x0, 928 SCMI_EVENT_POWERCAP_MEASUREMENTS_CHANGED = 0x1, 929 }; 930 931 struct scmi_power_state_changed_report { 932 ktime_t timestamp; 933 unsigned int agent_id; 934 unsigned int domain_id; 935 unsigned int power_state; 936 }; 937 938 struct scmi_clock_rate_notif_report { 939 ktime_t timestamp; 940 unsigned int agent_id; 941 unsigned int clock_id; 942 unsigned long long rate; 943 }; 944 945 struct scmi_system_power_state_notifier_report { 946 ktime_t timestamp; 947 unsigned int agent_id; 948 #define SCMI_SYSPOWER_IS_REQUEST_GRACEFUL(flags) ((flags) & BIT(0)) 949 unsigned int flags; 950 unsigned int system_state; 951 unsigned int timeout; 952 }; 953 954 struct scmi_perf_limits_report { 955 ktime_t timestamp; 956 unsigned int agent_id; 957 unsigned int domain_id; 958 unsigned int range_max; 959 unsigned int range_min; 960 unsigned long range_max_freq; 961 unsigned long range_min_freq; 962 }; 963 964 struct scmi_perf_level_report { 965 ktime_t timestamp; 966 unsigned int agent_id; 967 unsigned int domain_id; 968 unsigned int performance_level; 969 unsigned long performance_level_freq; 970 }; 971 972 struct scmi_sensor_trip_point_report { 973 ktime_t timestamp; 974 unsigned int agent_id; 975 unsigned int sensor_id; 976 unsigned int trip_point_desc; 977 }; 978 979 struct scmi_sensor_update_report { 980 ktime_t timestamp; 981 unsigned int agent_id; 982 unsigned int sensor_id; 983 unsigned int readings_count; 984 struct scmi_sensor_reading readings[]; 985 }; 986 987 struct scmi_reset_issued_report { 988 ktime_t timestamp; 989 unsigned int agent_id; 990 unsigned int domain_id; 991 unsigned int reset_state; 992 }; 993 994 struct scmi_base_error_report { 995 ktime_t timestamp; 996 unsigned int agent_id; 997 bool fatal; 998 unsigned int cmd_count; 999 unsigned long long reports[]; 1000 }; 1001 1002 struct scmi_powercap_cap_changed_report { 1003 ktime_t timestamp; 1004 unsigned int agent_id; 1005 unsigned int domain_id; 1006 unsigned int power_cap; 1007 unsigned int pai; 1008 }; 1009 1010 struct scmi_powercap_meas_changed_report { 1011 ktime_t timestamp; 1012 unsigned int agent_id; 1013 unsigned int domain_id; 1014 unsigned int power; 1015 }; 1016 #endif /* _LINUX_SCMI_PROTOCOL_H */ 1017