1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * SCMI Message Protocol driver header 4 * 5 * Copyright (C) 2018 ARM Ltd. 6 */ 7 8 #ifndef _LINUX_SCMI_PROTOCOL_H 9 #define _LINUX_SCMI_PROTOCOL_H 10 11 #include <linux/device.h> 12 #include <linux/notifier.h> 13 #include <linux/types.h> 14 15 #define SCMI_MAX_STR_SIZE 16 16 #define SCMI_MAX_NUM_RATES 16 17 18 /** 19 * struct scmi_revision_info - version information structure 20 * 21 * @major_ver: Major ABI version. Change here implies risk of backward 22 * compatibility break. 23 * @minor_ver: Minor ABI version. Change here implies new feature addition, 24 * or compatible change in ABI. 25 * @num_protocols: Number of protocols that are implemented, excluding the 26 * base protocol. 27 * @num_agents: Number of agents in the system. 28 * @impl_ver: A vendor-specific implementation version. 29 * @vendor_id: A vendor identifier(Null terminated ASCII string) 30 * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string) 31 */ 32 struct scmi_revision_info { 33 u16 major_ver; 34 u16 minor_ver; 35 u8 num_protocols; 36 u8 num_agents; 37 u32 impl_ver; 38 char vendor_id[SCMI_MAX_STR_SIZE]; 39 char sub_vendor_id[SCMI_MAX_STR_SIZE]; 40 }; 41 42 struct scmi_clock_info { 43 char name[SCMI_MAX_STR_SIZE]; 44 bool rate_discrete; 45 union { 46 struct { 47 int num_rates; 48 u64 rates[SCMI_MAX_NUM_RATES]; 49 } list; 50 struct { 51 u64 min_rate; 52 u64 max_rate; 53 u64 step_size; 54 } range; 55 }; 56 }; 57 58 struct scmi_handle; 59 60 /** 61 * struct scmi_clk_ops - represents the various operations provided 62 * by SCMI Clock Protocol 63 * 64 * @count_get: get the count of clocks provided by SCMI 65 * @info_get: get the information of the specified clock 66 * @rate_get: request the current clock rate of a clock 67 * @rate_set: set the clock rate of a clock 68 * @enable: enables the specified clock 69 * @disable: disables the specified clock 70 */ 71 struct scmi_clk_ops { 72 int (*count_get)(const struct scmi_handle *handle); 73 74 const struct scmi_clock_info *(*info_get) 75 (const struct scmi_handle *handle, u32 clk_id); 76 int (*rate_get)(const struct scmi_handle *handle, u32 clk_id, 77 u64 *rate); 78 int (*rate_set)(const struct scmi_handle *handle, u32 clk_id, 79 u64 rate); 80 int (*enable)(const struct scmi_handle *handle, u32 clk_id); 81 int (*disable)(const struct scmi_handle *handle, u32 clk_id); 82 }; 83 84 /** 85 * struct scmi_perf_ops - represents the various operations provided 86 * by SCMI Performance Protocol 87 * 88 * @limits_set: sets limits on the performance level of a domain 89 * @limits_get: gets limits on the performance level of a domain 90 * @level_set: sets the performance level of a domain 91 * @level_get: gets the performance level of a domain 92 * @device_domain_id: gets the scmi domain id for a given device 93 * @transition_latency_get: gets the DVFS transition latency for a given device 94 * @device_opps_add: adds all the OPPs for a given device 95 * @freq_set: sets the frequency for a given device using sustained frequency 96 * to sustained performance level mapping 97 * @freq_get: gets the frequency for a given device using sustained frequency 98 * to sustained performance level mapping 99 * @est_power_get: gets the estimated power cost for a given performance domain 100 * at a given frequency 101 */ 102 struct scmi_perf_ops { 103 int (*limits_set)(const struct scmi_handle *handle, u32 domain, 104 u32 max_perf, u32 min_perf); 105 int (*limits_get)(const struct scmi_handle *handle, u32 domain, 106 u32 *max_perf, u32 *min_perf); 107 int (*level_set)(const struct scmi_handle *handle, u32 domain, 108 u32 level, bool poll); 109 int (*level_get)(const struct scmi_handle *handle, u32 domain, 110 u32 *level, bool poll); 111 int (*device_domain_id)(struct device *dev); 112 int (*transition_latency_get)(const struct scmi_handle *handle, 113 struct device *dev); 114 int (*device_opps_add)(const struct scmi_handle *handle, 115 struct device *dev); 116 int (*freq_set)(const struct scmi_handle *handle, u32 domain, 117 unsigned long rate, bool poll); 118 int (*freq_get)(const struct scmi_handle *handle, u32 domain, 119 unsigned long *rate, bool poll); 120 int (*est_power_get)(const struct scmi_handle *handle, u32 domain, 121 unsigned long *rate, unsigned long *power); 122 bool (*fast_switch_possible)(const struct scmi_handle *handle, 123 struct device *dev); 124 }; 125 126 /** 127 * struct scmi_power_ops - represents the various operations provided 128 * by SCMI Power Protocol 129 * 130 * @num_domains_get: get the count of power domains provided by SCMI 131 * @name_get: gets the name of a power domain 132 * @state_set: sets the power state of a power domain 133 * @state_get: gets the power state of a power domain 134 */ 135 struct scmi_power_ops { 136 int (*num_domains_get)(const struct scmi_handle *handle); 137 char *(*name_get)(const struct scmi_handle *handle, u32 domain); 138 #define SCMI_POWER_STATE_TYPE_SHIFT 30 139 #define SCMI_POWER_STATE_ID_MASK (BIT(28) - 1) 140 #define SCMI_POWER_STATE_PARAM(type, id) \ 141 ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \ 142 ((id) & SCMI_POWER_STATE_ID_MASK)) 143 #define SCMI_POWER_STATE_GENERIC_ON SCMI_POWER_STATE_PARAM(0, 0) 144 #define SCMI_POWER_STATE_GENERIC_OFF SCMI_POWER_STATE_PARAM(1, 0) 145 int (*state_set)(const struct scmi_handle *handle, u32 domain, 146 u32 state); 147 int (*state_get)(const struct scmi_handle *handle, u32 domain, 148 u32 *state); 149 }; 150 151 struct scmi_sensor_info { 152 u32 id; 153 u8 type; 154 s8 scale; 155 u8 num_trip_points; 156 bool async; 157 char name[SCMI_MAX_STR_SIZE]; 158 }; 159 160 /* 161 * Partial list from Distributed Management Task Force (DMTF) specification: 162 * DSP0249 (Platform Level Data Model specification) 163 */ 164 enum scmi_sensor_class { 165 NONE = 0x0, 166 TEMPERATURE_C = 0x2, 167 VOLTAGE = 0x5, 168 CURRENT = 0x6, 169 POWER = 0x7, 170 ENERGY = 0x8, 171 }; 172 173 /** 174 * struct scmi_sensor_ops - represents the various operations provided 175 * by SCMI Sensor Protocol 176 * 177 * @count_get: get the count of sensors provided by SCMI 178 * @info_get: get the information of the specified sensor 179 * @trip_point_config: selects and configures a trip-point of interest 180 * @reading_get: gets the current value of the sensor 181 */ 182 struct scmi_sensor_ops { 183 int (*count_get)(const struct scmi_handle *handle); 184 const struct scmi_sensor_info *(*info_get) 185 (const struct scmi_handle *handle, u32 sensor_id); 186 int (*trip_point_config)(const struct scmi_handle *handle, 187 u32 sensor_id, u8 trip_id, u64 trip_value); 188 int (*reading_get)(const struct scmi_handle *handle, u32 sensor_id, 189 u64 *value); 190 }; 191 192 /** 193 * struct scmi_reset_ops - represents the various operations provided 194 * by SCMI Reset Protocol 195 * 196 * @num_domains_get: get the count of reset domains provided by SCMI 197 * @name_get: gets the name of a reset domain 198 * @latency_get: gets the reset latency for the specified reset domain 199 * @reset: resets the specified reset domain 200 * @assert: explicitly assert reset signal of the specified reset domain 201 * @deassert: explicitly deassert reset signal of the specified reset domain 202 */ 203 struct scmi_reset_ops { 204 int (*num_domains_get)(const struct scmi_handle *handle); 205 char *(*name_get)(const struct scmi_handle *handle, u32 domain); 206 int (*latency_get)(const struct scmi_handle *handle, u32 domain); 207 int (*reset)(const struct scmi_handle *handle, u32 domain); 208 int (*assert)(const struct scmi_handle *handle, u32 domain); 209 int (*deassert)(const struct scmi_handle *handle, u32 domain); 210 }; 211 212 /** 213 * struct scmi_voltage_info - describe one available SCMI Voltage Domain 214 * 215 * @id: the domain ID as advertised by the platform 216 * @segmented: defines the layout of the entries of array @levels_uv. 217 * - when True the entries are to be interpreted as triplets, 218 * each defining a segment representing a range of equally 219 * space voltages: <lowest_volts>, <highest_volt>, <step_uV> 220 * - when False the entries simply represent a single discrete 221 * supported voltage level 222 * @negative_volts_allowed: True if any of the entries of @levels_uv represent 223 * a negative voltage. 224 * @attributes: represents Voltage Domain advertised attributes 225 * @name: name assigned to the Voltage Domain by platform 226 * @num_levels: number of total entries in @levels_uv. 227 * @levels_uv: array of entries describing the available voltage levels for 228 * this domain. 229 */ 230 struct scmi_voltage_info { 231 unsigned int id; 232 bool segmented; 233 bool negative_volts_allowed; 234 unsigned int attributes; 235 char name[SCMI_MAX_STR_SIZE]; 236 unsigned int num_levels; 237 #define SCMI_VOLTAGE_SEGMENT_LOW 0 238 #define SCMI_VOLTAGE_SEGMENT_HIGH 1 239 #define SCMI_VOLTAGE_SEGMENT_STEP 2 240 int *levels_uv; 241 }; 242 243 /** 244 * struct scmi_voltage_ops - represents the various operations provided 245 * by SCMI Voltage Protocol 246 * 247 * @num_domains_get: get the count of voltage domains provided by SCMI 248 * @info_get: get the information of the specified domain 249 * @config_set: set the config for the specified domain 250 * @config_get: get the config of the specified domain 251 * @level_set: set the voltage level for the specified domain 252 * @level_get: get the voltage level of the specified domain 253 */ 254 struct scmi_voltage_ops { 255 int (*num_domains_get)(const struct scmi_handle *handle); 256 const struct scmi_voltage_info __must_check *(*info_get) 257 (const struct scmi_handle *handle, u32 domain_id); 258 int (*config_set)(const struct scmi_handle *handle, u32 domain_id, 259 u32 config); 260 #define SCMI_VOLTAGE_ARCH_STATE_OFF 0x0 261 #define SCMI_VOLTAGE_ARCH_STATE_ON 0x7 262 int (*config_get)(const struct scmi_handle *handle, u32 domain_id, 263 u32 *config); 264 int (*level_set)(const struct scmi_handle *handle, u32 domain_id, 265 u32 flags, s32 volt_uV); 266 int (*level_get)(const struct scmi_handle *handle, u32 domain_id, 267 s32 *volt_uV); 268 }; 269 270 /** 271 * struct scmi_notify_ops - represents notifications' operations provided by 272 * SCMI core 273 * @register_event_notifier: Register a notifier_block for the requested event 274 * @unregister_event_notifier: Unregister a notifier_block for the requested 275 * event 276 * 277 * A user can register/unregister its own notifier_block against the wanted 278 * platform instance regarding the desired event identified by the 279 * tuple: (proto_id, evt_id, src_id) using the provided register/unregister 280 * interface where: 281 * 282 * @handle: The handle identifying the platform instance to use 283 * @proto_id: The protocol ID as in SCMI Specification 284 * @evt_id: The message ID of the desired event as in SCMI Specification 285 * @src_id: A pointer to the desired source ID if different sources are 286 * possible for the protocol (like domain_id, sensor_id...etc) 287 * 288 * @src_id can be provided as NULL if it simply does NOT make sense for 289 * the protocol at hand, OR if the user is explicitly interested in 290 * receiving notifications from ANY existent source associated to the 291 * specified proto_id / evt_id. 292 * 293 * Received notifications are finally delivered to the registered users, 294 * invoking the callback provided with the notifier_block *nb as follows: 295 * 296 * int user_cb(nb, evt_id, report) 297 * 298 * with: 299 * 300 * @nb: The notifier block provided by the user 301 * @evt_id: The message ID of the delivered event 302 * @report: A custom struct describing the specific event delivered 303 */ 304 struct scmi_notify_ops { 305 int (*register_event_notifier)(const struct scmi_handle *handle, 306 u8 proto_id, u8 evt_id, u32 *src_id, 307 struct notifier_block *nb); 308 int (*unregister_event_notifier)(const struct scmi_handle *handle, 309 u8 proto_id, u8 evt_id, u32 *src_id, 310 struct notifier_block *nb); 311 }; 312 313 /** 314 * struct scmi_handle - Handle returned to ARM SCMI clients for usage. 315 * 316 * @dev: pointer to the SCMI device 317 * @version: pointer to the structure containing SCMI version information 318 * @power_ops: pointer to set of power protocol operations 319 * @perf_ops: pointer to set of performance protocol operations 320 * @clk_ops: pointer to set of clock protocol operations 321 * @sensor_ops: pointer to set of sensor protocol operations 322 * @reset_ops: pointer to set of reset protocol operations 323 * @voltage_ops: pointer to set of voltage protocol operations 324 * @notify_ops: pointer to set of notifications related operations 325 * @perf_priv: pointer to private data structure specific to performance 326 * protocol(for internal use only) 327 * @clk_priv: pointer to private data structure specific to clock 328 * protocol(for internal use only) 329 * @power_priv: pointer to private data structure specific to power 330 * protocol(for internal use only) 331 * @sensor_priv: pointer to private data structure specific to sensors 332 * protocol(for internal use only) 333 * @reset_priv: pointer to private data structure specific to reset 334 * protocol(for internal use only) 335 * @voltage_priv: pointer to private data structure specific to voltage 336 * protocol(for internal use only) 337 * @notify_priv: pointer to private data structure specific to notifications 338 * (for internal use only) 339 */ 340 struct scmi_handle { 341 struct device *dev; 342 struct scmi_revision_info *version; 343 const struct scmi_perf_ops *perf_ops; 344 const struct scmi_clk_ops *clk_ops; 345 const struct scmi_power_ops *power_ops; 346 const struct scmi_sensor_ops *sensor_ops; 347 const struct scmi_reset_ops *reset_ops; 348 const struct scmi_voltage_ops *voltage_ops; 349 const struct scmi_notify_ops *notify_ops; 350 /* for protocol internal use */ 351 void *perf_priv; 352 void *clk_priv; 353 void *power_priv; 354 void *sensor_priv; 355 void *reset_priv; 356 void *voltage_priv; 357 void *notify_priv; 358 void *system_priv; 359 }; 360 361 enum scmi_std_protocol { 362 SCMI_PROTOCOL_BASE = 0x10, 363 SCMI_PROTOCOL_POWER = 0x11, 364 SCMI_PROTOCOL_SYSTEM = 0x12, 365 SCMI_PROTOCOL_PERF = 0x13, 366 SCMI_PROTOCOL_CLOCK = 0x14, 367 SCMI_PROTOCOL_SENSOR = 0x15, 368 SCMI_PROTOCOL_RESET = 0x16, 369 SCMI_PROTOCOL_VOLTAGE = 0x17, 370 }; 371 372 enum scmi_system_events { 373 SCMI_SYSTEM_SHUTDOWN, 374 SCMI_SYSTEM_COLDRESET, 375 SCMI_SYSTEM_WARMRESET, 376 SCMI_SYSTEM_POWERUP, 377 SCMI_SYSTEM_SUSPEND, 378 SCMI_SYSTEM_MAX 379 }; 380 381 struct scmi_device { 382 u32 id; 383 u8 protocol_id; 384 const char *name; 385 struct device dev; 386 struct scmi_handle *handle; 387 }; 388 389 #define to_scmi_dev(d) container_of(d, struct scmi_device, dev) 390 391 struct scmi_device * 392 scmi_device_create(struct device_node *np, struct device *parent, int protocol, 393 const char *name); 394 void scmi_device_destroy(struct scmi_device *scmi_dev); 395 396 struct scmi_device_id { 397 u8 protocol_id; 398 const char *name; 399 }; 400 401 struct scmi_driver { 402 const char *name; 403 int (*probe)(struct scmi_device *sdev); 404 void (*remove)(struct scmi_device *sdev); 405 const struct scmi_device_id *id_table; 406 407 struct device_driver driver; 408 }; 409 410 #define to_scmi_driver(d) container_of(d, struct scmi_driver, driver) 411 412 #if IS_REACHABLE(CONFIG_ARM_SCMI_PROTOCOL) 413 int scmi_driver_register(struct scmi_driver *driver, 414 struct module *owner, const char *mod_name); 415 void scmi_driver_unregister(struct scmi_driver *driver); 416 #else 417 static inline int 418 scmi_driver_register(struct scmi_driver *driver, struct module *owner, 419 const char *mod_name) 420 { 421 return -EINVAL; 422 } 423 424 static inline void scmi_driver_unregister(struct scmi_driver *driver) {} 425 #endif /* CONFIG_ARM_SCMI_PROTOCOL */ 426 427 #define scmi_register(driver) \ 428 scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME) 429 #define scmi_unregister(driver) \ 430 scmi_driver_unregister(driver) 431 432 /** 433 * module_scmi_driver() - Helper macro for registering a scmi driver 434 * @__scmi_driver: scmi_driver structure 435 * 436 * Helper macro for scmi drivers to set up proper module init / exit 437 * functions. Replaces module_init() and module_exit() and keeps people from 438 * printing pointless things to the kernel log when their driver is loaded. 439 */ 440 #define module_scmi_driver(__scmi_driver) \ 441 module_driver(__scmi_driver, scmi_register, scmi_unregister) 442 443 typedef int (*scmi_prot_init_fn_t)(struct scmi_handle *); 444 int scmi_protocol_register(int protocol_id, scmi_prot_init_fn_t fn); 445 void scmi_protocol_unregister(int protocol_id); 446 447 /* SCMI Notification API - Custom Event Reports */ 448 enum scmi_notification_events { 449 SCMI_EVENT_POWER_STATE_CHANGED = 0x0, 450 SCMI_EVENT_PERFORMANCE_LIMITS_CHANGED = 0x0, 451 SCMI_EVENT_PERFORMANCE_LEVEL_CHANGED = 0x1, 452 SCMI_EVENT_SENSOR_TRIP_POINT_EVENT = 0x0, 453 SCMI_EVENT_RESET_ISSUED = 0x0, 454 SCMI_EVENT_BASE_ERROR_EVENT = 0x0, 455 SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER = 0x0, 456 }; 457 458 struct scmi_power_state_changed_report { 459 ktime_t timestamp; 460 unsigned int agent_id; 461 unsigned int domain_id; 462 unsigned int power_state; 463 }; 464 465 struct scmi_system_power_state_notifier_report { 466 ktime_t timestamp; 467 unsigned int agent_id; 468 unsigned int flags; 469 unsigned int system_state; 470 }; 471 472 struct scmi_perf_limits_report { 473 ktime_t timestamp; 474 unsigned int agent_id; 475 unsigned int domain_id; 476 unsigned int range_max; 477 unsigned int range_min; 478 }; 479 480 struct scmi_perf_level_report { 481 ktime_t timestamp; 482 unsigned int agent_id; 483 unsigned int domain_id; 484 unsigned int performance_level; 485 }; 486 487 struct scmi_sensor_trip_point_report { 488 ktime_t timestamp; 489 unsigned int agent_id; 490 unsigned int sensor_id; 491 unsigned int trip_point_desc; 492 }; 493 494 struct scmi_reset_issued_report { 495 ktime_t timestamp; 496 unsigned int agent_id; 497 unsigned int domain_id; 498 unsigned int reset_state; 499 }; 500 501 struct scmi_base_error_report { 502 ktime_t timestamp; 503 unsigned int agent_id; 504 bool fatal; 505 unsigned int cmd_count; 506 unsigned long long reports[]; 507 }; 508 509 #endif /* _LINUX_SCMI_PROTOCOL_H */ 510