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