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)
87  * struct scmi_clk_proto_ops - represents the various operations provided
133  * struct scmi_perf_proto_ops - represents the various operations provided
150  * @est_power_get: gets the estimated power cost for a given performance domain
156  * @power_scale_mw_get: indicates if the power values provided are in milliWatts
182 			     unsigned long *rate, unsigned long *power);
191  * struct scmi_power_proto_ops - represents the various operations provided
192  *	by SCMI Power Protocol
194  * @num_domains_get: get the count of power domains provided by SCMI
195  * @name_get: gets the name of a power domain
196  * @state_set: sets the power state of a power domain
197  * @state_get: gets the power state of a power domain
204 #define SCMI_POWER_STATE_ID_MASK	(BIT(28) - 1)
217  * struct scmi_sensor_reading  - represent a timestamped read
231  * struct scmi_range_attrs  - specifies a sensor or axis values' range
241  * struct scmi_sensor_axis_info  - describes one sensor axes
244  * @scale: Power-of-10 multiplier applied to the axis unit.
245  * @name: NULL-terminated string representing axes name as advertised by
251  * @exponent: Extended attribute representing the power-of-10 multiplier that
269  * struct scmi_sensor_intervals_info  - describes number and type of available
280  *		   lesser-than-64-bytes dynamic allocation for small @count
304  * struct scmi_sensor_info - represents information related to one of the
308  * @scale: Power-of-10 multiplier applied to the sensor unit.
313  * @tstamp_scale: Power-of-10 multiplier applied to the sensor timestamps to
321  * @name: NULL-terminated string representing sensor name as advertised by
325  * @sensor_power: Extended attribute representing the average power
332  * @exponent: Extended attribute representing the power-of-10 multiplier that is
404 	POWER = 0x7,  enumerator
495  * struct scmi_sensor_proto_ops - represents the various operations provided
500  * @trip_point_config: selects and configures a trip-point of interest
504  *			     Supports multi-axis sensors for sensors which
528  * struct scmi_reset_proto_ops - represents the various operations provided
554  * struct scmi_voltage_info - describe one available SCMI Voltage Domain
558  *	       - when True the entries are to be interpreted as triplets,
561  *	       - when False the entries simply represent a single discrete
586  * struct scmi_voltage_proto_ops - represents the various operations provided
613  * struct scmi_powercap_info  - Describe one available Powercap domain
623  * @powercap_scale_mw: Domain reports power data in milliwatt units.
624  * @powercap_scale_uw: Domain reports power data in microwatt units.
627  *		       reports power data on an abstract linear scale.
635  * @sustainable_power: Maximum sustainable power consumption for this domain
637  * @accuracy: The accuracy with which the power is measured and reported in
639  * @parent_id: Identifier of the containing parent power capping domain, or the
669  * struct scmi_powercap_proto_ops - represents the various operations provided
696  * @measurements_get: retrieve the current average power measurements for the
699  * @measurements_threshold_set: set the desired low and high power thresholds
708  *				proper update of the power thresholds configured
710  * @measurements_threshold_get: get the currently configured low and high power
773  * struct scmi_pinctrl_proto_ops - represents the various operations provided
824  * struct scmi_notify_ops  - represents notifications' operations provided by
826  * @devm_event_notifier_register: Managed registration of a notifier_block for
828  * @devm_event_notifier_unregister: Managed unregistration of a notifier_block
839  * @sdev: The scmi_device to use when calling the devres managed ops devm_
841  *	    calling the managed ops devm_
881  * struct scmi_handle - Handle returned to ARM SCMI clients for usage.
885  * @devm_protocol_acquire: devres managed method to get hold of a protocol,
888  * @devm_protocol_get: devres managed method to acquire a protocol and get specific
890  * @devm_protocol_put: devres managed method to release a protocol
975 	return -EINVAL;  in scmi_driver_register()
987  * module_scmi_driver() - Helper macro for registering a scmi driver
998  * module_scmi_protocol() - Helper macro for registering a scmi protocol
1013 /* SCMI Notification API - Custom Event Reports */
1112 	unsigned int	power;  member