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