kybaaz/linux-xiaomi-chiron
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

cpufreq: qcom-hw: Add kerneldoc to some functions

Browse source 
Some functions may not be very straightforward to understand:
add kerneldoc to some ones in order to improve readability.

Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@somainline.org>
This commit is contained in:
AngeloGioacchino Del Regno 2021-06-17 22:35:49 +02:00 • committed by Jami Kettunen
parent 39b3fc7fd8
commit cec8ad3aa2
1 changed files with 54 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

54
drivers/cpufreq/qcom-cpufreq-hw.c
View file

@ -62,6 +62,13 @@ struct qcom_cpufreq_data {
static unsigned long cpu_hw_rate, xo_rate;
static bool icc_scaling_enabled;
/**
* qcom_cpufreq_set_bw() - Set interconnect bandwidth
* @policy: CPUFreq policy structure
* @freq_khz: CPU Frequency in KHz
*
* Returns: Zero for success, otherwise negative value on errors
*/
static int qcom_cpufreq_set_bw(struct cpufreq_policy *policy,
unsigned long freq_khz)
{
@ -83,6 +90,20 @@ static int qcom_cpufreq_set_bw(struct cpufreq_policy *policy,
return ret;
}
/**
* qcom_cpufreq_update_opp() - Update CPU OPP tables
* @policy: CPUFreq policy structure
* @freq_khz: CPU Frequency for OPP entry in KHz
* @volt: CPU Voltage for OPP entry in microvolts
*
* The CPU frequencies and voltages are being read from the Operating
* State Manager (OSM) and the related OPPs, read from DT, need to be
* updated to reflect what the hardware will set for each p-state.
* If there is no OPP table specified in DT, then this function will
* add dynamic ones.
*
* Returns: Zero for success, otherwise negative value on errors
*/
static int qcom_cpufreq_update_opp(struct device *cpu_dev,
unsigned long freq_khz,
unsigned long volt)
@ -103,6 +124,17 @@ static int qcom_cpufreq_update_opp(struct device *cpu_dev,
return dev_pm_opp_enable(cpu_dev, freq_hz);
}
/**
* qcom_cpufreq_hw_target_index() - Set frequency/voltage
* @policy: CPUFreq policy structure
* @index: Performance state index to be set
*
* This function sends a request to the Operating State Manager
* to set a Performance State index, so, to set frequency and
* voltage for the target CPU/cluster.
*
* Returns: Always zero
*/
static int qcom_cpufreq_hw_target_index(struct cpufreq_policy *policy,
unsigned int index)
{
@ -123,6 +155,12 @@ static int qcom_cpufreq_hw_target_index(struct cpufreq_policy *policy,
return 0;
}
/**
* qcom_cpufreq_hw_get() - Get current Performance State from OSM
* @cpu: CPU number
*
* Returns: Current CPU/Cluster frequency or zero
*/
static unsigned int qcom_cpufreq_hw_get(unsigned int cpu)
{
struct qcom_cpufreq_data *data;
@ -161,6 +199,17 @@ static unsigned int qcom_cpufreq_hw_fast_switch(struct cpufreq_policy *policy,
return policy->freq_table[index].frequency;
}
/**
* qcom_cpufreq_hw_read_lut() - Read Lookup Table from the OSM
* @cpu_dev: CPU device
* @policy: CPUFreq policy structure
*
* The Operating State Manager Lookup Table can always be read, even
* in case it was pre-programmed by the bootloader or by TrustZone.
* Read the LUT from it in order to build OPPs containing DVFS info.
*
* Returns: Zero for success, otherwise negative number on errors.
*/
static int qcom_cpufreq_hw_read_lut(struct device *cpu_dev,
struct cpufreq_policy *policy)
{
@ -261,6 +310,11 @@ static int qcom_cpufreq_hw_read_lut(struct device *cpu_dev,
return 0;
}
/*
* qcom_get_related_cpus - Get mask of CPUs in the same frequency domain
* @index: CPU number
* @m: Returned CPU mask
*/
static void qcom_get_related_cpus(int index, struct cpumask *m)
{
struct device_node *cpu_np;