// SPDX-License-Identifier: GPL-2.0 /* * devfreq_cooling: Thermal cooling device implementation for devices using * devfreq * * Copyright (C) 2014-2015 ARM Limited * * TODO: * - If OPPs are added or removed after devfreq cooling has * registered, the devfreq cooling won't react to it. */ #include <linux/devfreq.h> #include <linux/devfreq_cooling.h> #include <linux/energy_model.h> #include <linux/export.h> #include <linux/slab.h> #include <linux/pm_opp.h> #include <linux/pm_qos.h> #include <linux/thermal.h> #include <linux/units.h> #include "thermal_trace.h" #define SCALE_ERROR_MITIGATION … /** * struct devfreq_cooling_device - Devfreq cooling device * devfreq_cooling_device registered. * @cdev: Pointer to associated thermal cooling device. * @cooling_ops: devfreq callbacks to thermal cooling device ops * @devfreq: Pointer to associated devfreq device. * @cooling_state: Current cooling state. * @freq_table: Pointer to a table with the frequencies sorted in descending * order. You can index the table by cooling device state * @max_state: It is the last index, that is, one less than the number of the * OPPs * @power_ops: Pointer to devfreq_cooling_power, a more precised model. * @res_util: Resource utilization scaling factor for the power. * It is multiplied by 100 to minimize the error. It is used * for estimation of the power budget instead of using * 'utilization' (which is 'busy_time' / 'total_time'). * The 'res_util' range is from 100 to power * 100 for the * corresponding 'state'. * @capped_state: index to cooling state with in dynamic power budget * @req_max_freq: PM QoS request for limiting the maximum frequency * of the devfreq device. * @em_pd: Energy Model for the associated Devfreq device */ struct devfreq_cooling_device { … }; static int devfreq_cooling_get_max_state(struct thermal_cooling_device *cdev, unsigned long *state) { … } static int devfreq_cooling_get_cur_state(struct thermal_cooling_device *cdev, unsigned long *state) { … } static int devfreq_cooling_set_cur_state(struct thermal_cooling_device *cdev, unsigned long state) { … } /** * get_perf_idx() - get the performance index corresponding to a frequency * @em_pd: Pointer to device's Energy Model * @freq: frequency in kHz * * Return: the performance index associated with the @freq, or * -EINVAL if it wasn't found. */ static int get_perf_idx(struct em_perf_domain *em_pd, unsigned long freq) { … } static unsigned long get_voltage(struct devfreq *df, unsigned long freq) { … } static void _normalize_load(struct devfreq_dev_status *status) { … } static int devfreq_cooling_get_requested_power(struct thermal_cooling_device *cdev, u32 *power) { … } static int devfreq_cooling_state2power(struct thermal_cooling_device *cdev, unsigned long state, u32 *power) { … } static int devfreq_cooling_power2state(struct thermal_cooling_device *cdev, u32 power, unsigned long *state) { … } /** * devfreq_cooling_gen_tables() - Generate frequency table. * @dfc: Pointer to devfreq cooling device. * @num_opps: Number of OPPs * * Generate frequency table which holds the frequencies in descending * order. That way its indexed by cooling device state. This is for * compatibility with drivers which do not register Energy Model. * * Return: 0 on success, negative error code on failure. */ static int devfreq_cooling_gen_tables(struct devfreq_cooling_device *dfc, int num_opps) { … } /** * of_devfreq_cooling_register_power() - Register devfreq cooling device, * with OF and power information. * @np: Pointer to OF device_node. * @df: Pointer to devfreq device. * @dfc_power: Pointer to devfreq_cooling_power. * * Register a devfreq cooling device. The available OPPs must be * registered on the device. * * If @dfc_power is provided, the cooling device is registered with the * power extensions. For the power extensions to work correctly, * devfreq should use the simple_ondemand governor, other governors * are not currently supported. */ struct thermal_cooling_device * of_devfreq_cooling_register_power(struct device_node *np, struct devfreq *df, struct devfreq_cooling_power *dfc_power) { … } EXPORT_SYMBOL_GPL(…); /** * of_devfreq_cooling_register() - Register devfreq cooling device, * with OF information. * @np: Pointer to OF device_node. * @df: Pointer to devfreq device. */ struct thermal_cooling_device * of_devfreq_cooling_register(struct device_node *np, struct devfreq *df) { … } EXPORT_SYMBOL_GPL(…); /** * devfreq_cooling_register() - Register devfreq cooling device. * @df: Pointer to devfreq device. */ struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df) { … } EXPORT_SYMBOL_GPL(…); /** * devfreq_cooling_em_register() - Register devfreq cooling device with * power information and automatically register Energy Model (EM) * @df: Pointer to devfreq device. * @dfc_power: Pointer to devfreq_cooling_power. * * Register a devfreq cooling device and automatically register EM. The * available OPPs must be registered for the device. * * If @dfc_power is provided, the cooling device is registered with the * power extensions. It is using the simple Energy Model which requires * "dynamic-power-coefficient" a devicetree property. To not break drivers * which miss that DT property, the function won't bail out when the EM * registration failed. The cooling device will be registered if everything * else is OK. */ struct thermal_cooling_device * devfreq_cooling_em_register(struct devfreq *df, struct devfreq_cooling_power *dfc_power) { … } EXPORT_SYMBOL_GPL(…); /** * devfreq_cooling_unregister() - Unregister devfreq cooling device. * @cdev: Pointer to devfreq cooling device to unregister. * * Unregisters devfreq cooling device and related Energy Model if it was * present. */ void devfreq_cooling_unregister(struct thermal_cooling_device *cdev) { … } EXPORT_SYMBOL_GPL(…);