include/linux/scmi_protocol.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
5  * Copyright (C) 2018-2021 ARM Ltd.
21  * struct scmi_revision_info - version information structure
30  * @impl_ver: A vendor-specific implementation version.
32  * @sub_vendor_id: A sub-vendor identifier(Null terminated ASCII string)
76  * struct scmi_clk_proto_ops - represents the various operations provided
121  * struct scmi_perf_proto_ops - represents the various operations provided
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
133  *	to sustained performance level mapping
135  *	to sustained performance level mapping
152 			 u32 level, bool poll);
154 			 u32 *level, bool poll);
171  * struct scmi_power_proto_ops - represents the various operations provided
184 #define SCMI_POWER_STATE_ID_MASK	(BIT(28) - 1)
197  * struct scmi_sensor_reading  - represent a timestamped read
203  *	       SCMI platform. Set to zero when not available.
211  * struct scmi_range_attrs  - specifies a sensor or axis values' range
221  * struct scmi_sensor_axis_info  - describes one sensor axes
224  * @scale: Power-of-10 multiplier applied to the axis unit.
225  * @name: NULL-terminated string representing axes name as advertised by
226  *	  SCMI platform.
231  * @exponent: Extended attribute representing the power-of-10 multiplier that
249  * struct scmi_sensor_intervals_info  - describes number and type of available
260  *		   lesser-than-64-bytes dynamic allocation for small @count
284  * struct scmi_sensor_info - represents information related to one of the
288  * @scale: Power-of-10 multiplier applied to the sensor unit.
293  * @tstamp_scale: Power-of-10 multiplier applied to the sensor timestamps to
301  * @name: NULL-terminated string representing sensor name as advertised by
302  *	  SCMI platform.
312  * @exponent: Extended attribute representing the power-of-10 multiplier that is
374  * DSP0249 (Platform Level Data Model specification)
475  * struct scmi_sensor_proto_ops - represents the various operations provided
480  * @trip_point_config: selects and configures a trip-point of interest
484  *			     Supports multi-axis sensors for sensors which
508  * struct scmi_reset_proto_ops - represents the various operations provided
534  * struct scmi_voltage_info - describe one available SCMI Voltage Domain
536  * @id: the domain ID as advertised by the platform
538  *	       - when True the entries are to be interpreted as triplets,
541  *	       - when False the entries simply represent a single discrete
542  *	         supported voltage level
545  * @async_level_set: True when the voltage domain supports asynchronous level
547  * @name: name assigned to the Voltage Domain by platform
566  * struct scmi_voltage_proto_ops - represents the various operations provided
573  * @level_set: set the voltage level for the specified domain
574  * @level_get: get the voltage level of the specified domain
593  * struct scmi_powercap_info  - Describe one available Powercap domain
595  * @id: Domain ID as advertised by the platform.
608  * @name: name assigned to the Powercap Domain by platform.
649  * struct scmi_powercap_proto_ops - represents the various operations provided
663  *	     the platform supports disabling a powercap by setting its cap to
667  *		    if supported by the SCMI platform implementation.
668  *		    Note that, by the SCMI specification, the platform can
672  *		    will always report the final platform view of the powercaps.
721  * struct scmi_notify_ops  - represents notifications' operations provided by
732  * platform instance regarding the desired event identified by the
737  * @handle: The handle identifying the platform instance to use, when not
780  * struct scmi_handle - Handle returned to ARM SCMI clients for usage.
873 	return -EINVAL;  in scmi_driver_register()
885  * module_scmi_driver() - Helper macro for registering a scmi driver
896  * module_scmi_protocol() - Helper macro for registering a scmi protocol
911 /* SCMI Notification API - Custom Event Reports */