Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

cpufreq: cpufreq: Demote lots of function headers unworthy of kerneldoc status

Also provide missing function parameter description for 'cpu' and 'policy'.

Fixes the following W=1 kernel build warning(s):

drivers/cpufreq/cpufreq.c:60: warning: cannot understand function prototype: 'struct cpufreq_driver *cpufreq_driver; '
drivers/cpufreq/cpufreq.c:90: warning: Function parameter or member 'cpufreq_policy_notifier_list' not described in 'BLOCKING_NOTIFIER_HEAD'
drivers/cpufreq/cpufreq.c:312: warning: Function parameter or member 'val' not described in 'adjust_jiffies'
drivers/cpufreq/cpufreq.c:312: warning: Function parameter or member 'ci' not described in 'adjust_jiffies'
drivers/cpufreq/cpufreq.c:538: warning: Function parameter or member 'policy' not described in 'cpufreq_driver_resolve_freq'
drivers/cpufreq/cpufreq.c:686: warning: Function parameter or member 'file_name' not described in 'show_one'
drivers/cpufreq/cpufreq.c:686: warning: Function parameter or member 'object' not described in 'show_one'
drivers/cpufreq/cpufreq.c:731: warning: Function parameter or member 'file_name' not described in 'store_one'
drivers/cpufreq/cpufreq.c:731: warning: Function parameter or member 'object' not described in 'store_one'
drivers/cpufreq/cpufreq.c:741: warning: Function parameter or member 'policy' not described in 'show_cpuinfo_cur_freq'
drivers/cpufreq/cpufreq.c:741: warning: Function parameter or member 'buf' not described in 'show_cpuinfo_cur_freq'
drivers/cpufreq/cpufreq.c:754: warning: Function parameter or member 'policy' not described in 'show_scaling_governor'
drivers/cpufreq/cpufreq.c:754: warning: Function parameter or member 'buf' not described in 'show_scaling_governor'
drivers/cpufreq/cpufreq.c:770: warning: Function parameter or member 'policy' not described in 'store_scaling_governor'
drivers/cpufreq/cpufreq.c:770: warning: Function parameter or member 'buf' not described in 'store_scaling_governor'
drivers/cpufreq/cpufreq.c:770: warning: Function parameter or member 'count' not described in 'store_scaling_governor'
drivers/cpufreq/cpufreq.c:806: warning: Function parameter or member 'policy' not described in 'show_scaling_driver'
drivers/cpufreq/cpufreq.c:806: warning: Function parameter or member 'buf' not described in 'show_scaling_driver'
drivers/cpufreq/cpufreq.c:815: warning: Function parameter or member 'policy' not described in 'show_scaling_available_governors'
drivers/cpufreq/cpufreq.c:815: warning: Function parameter or member 'buf' not described in 'show_scaling_available_governors'
drivers/cpufreq/cpufreq.c:859: warning: Function parameter or member 'policy' not described in 'show_related_cpus'
drivers/cpufreq/cpufreq.c:859: warning: Function parameter or member 'buf' not described in 'show_related_cpus'
drivers/cpufreq/cpufreq.c:867: warning: Function parameter or member 'policy' not described in 'show_affected_cpus'
drivers/cpufreq/cpufreq.c:867: warning: Function parameter or member 'buf' not described in 'show_affected_cpus'
drivers/cpufreq/cpufreq.c:901: warning: Function parameter or member 'policy' not described in 'show_bios_limit'
drivers/cpufreq/cpufreq.c:901: warning: Function parameter or member 'buf' not described in 'show_bios_limit'
drivers/cpufreq/cpufreq.c:1625: warning: Function parameter or member 'dev' not described in 'cpufreq_remove_dev'
drivers/cpufreq/cpufreq.c:1625: warning: Function parameter or member 'sif' not described in 'cpufreq_remove_dev'
drivers/cpufreq/cpufreq.c:2380: warning: Function parameter or member 'cpu' not described in 'cpufreq_get_policy'
drivers/cpufreq/cpufreq.c:2771: warning: Function parameter or member 'driver' not described in 'cpufreq_unregister_driver'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

authored by

Lee Jones and committed by
Rafael J. Wysocki
a9909c21 19231a87

+17 -15
+17 -15
drivers/cpufreq/cpufreq.c
··· 52 52 53 53 static char default_governor[CPUFREQ_NAME_LEN]; 54 54 55 - /** 55 + /* 56 56 * The "cpufreq driver" - the arch- or hardware-dependent low 57 57 * level driver of CPUFreq support, and its spinlock. This lock 58 58 * also protects the cpufreq_cpu_data array. ··· 80 80 struct cpufreq_governor *new_gov, 81 81 unsigned int new_pol); 82 82 83 - /** 83 + /* 84 84 * Two notifier lists: the "policy" list is involved in the 85 85 * validation process for a new CPU frequency policy; the 86 86 * "transition" list for kernel code that needs to handle ··· 300 300 * EXTERNALLY AFFECTING FREQUENCY CHANGES * 301 301 *********************************************************************/ 302 302 303 - /** 303 + /* 304 304 * adjust_jiffies - adjust the system "loops_per_jiffy" 305 305 * 306 306 * This function alters the system "loops_per_jiffy" for the clock ··· 526 526 /** 527 527 * cpufreq_driver_resolve_freq - Map a target frequency to a driver-supported 528 528 * one. 529 + * @policy: associated policy to interrogate 529 530 * @target_freq: target frequency to resolve. 530 531 * 531 532 * The target to driver frequency mapping is cached in the policy. ··· 671 670 return get_governor(str_governor); 672 671 } 673 672 674 - /** 673 + /* 675 674 * cpufreq_per_cpu_attr_read() / show_##file_name() - 676 675 * print out cpufreq information 677 676 * ··· 713 712 return ret; 714 713 } 715 714 716 - /** 715 + /* 717 716 * cpufreq_per_cpu_attr_write() / store_##file_name() - sysfs write access 718 717 */ 719 718 #define store_one(file_name, object) \ ··· 734 733 store_one(scaling_min_freq, min); 735 734 store_one(scaling_max_freq, max); 736 735 737 - /** 736 + /* 738 737 * show_cpuinfo_cur_freq - current CPU frequency as detected by hardware 739 738 */ 740 739 static ssize_t show_cpuinfo_cur_freq(struct cpufreq_policy *policy, ··· 748 747 return sprintf(buf, "<unknown>\n"); 749 748 } 750 749 751 - /** 750 + /* 752 751 * show_scaling_governor - show the current policy for the specified CPU 753 752 */ 754 753 static ssize_t show_scaling_governor(struct cpufreq_policy *policy, char *buf) ··· 763 762 return -EINVAL; 764 763 } 765 764 766 - /** 765 + /* 767 766 * store_scaling_governor - store policy for the specified CPU 768 767 */ 769 768 static ssize_t store_scaling_governor(struct cpufreq_policy *policy, ··· 800 799 return ret ? ret : count; 801 800 } 802 801 803 - /** 802 + /* 804 803 * show_scaling_driver - show the cpufreq driver currently loaded 805 804 */ 806 805 static ssize_t show_scaling_driver(struct cpufreq_policy *policy, char *buf) ··· 808 807 return scnprintf(buf, CPUFREQ_NAME_PLEN, "%s\n", cpufreq_driver->name); 809 808 } 810 809 811 - /** 810 + /* 812 811 * show_scaling_available_governors - show the available CPUfreq governors 813 812 */ 814 813 static ssize_t show_scaling_available_governors(struct cpufreq_policy *policy, ··· 852 851 } 853 852 EXPORT_SYMBOL_GPL(cpufreq_show_cpus); 854 853 855 - /** 854 + /* 856 855 * show_related_cpus - show the CPUs affected by each transition even if 857 856 * hw coordination is in use 858 857 */ ··· 861 860 return cpufreq_show_cpus(policy->related_cpus, buf); 862 861 } 863 862 864 - /** 863 + /* 865 864 * show_affected_cpus - show the CPUs affected by each transition 866 865 */ 867 866 static ssize_t show_affected_cpus(struct cpufreq_policy *policy, char *buf) ··· 895 894 return policy->governor->show_setspeed(policy, buf); 896 895 } 897 896 898 - /** 897 + /* 899 898 * show_bios_limit - show the current cpufreq HW/BIOS limitation 900 899 */ 901 900 static ssize_t show_bios_limit(struct cpufreq_policy *policy, char *buf) ··· 1617 1616 return 0; 1618 1617 } 1619 1618 1620 - /** 1619 + /* 1621 1620 * cpufreq_remove_dev - remove a CPU device 1622 1621 * 1623 1622 * Removes the cpufreq interface for a CPU device. ··· 2374 2373 * cpufreq_get_policy - get the current cpufreq_policy 2375 2374 * @policy: struct cpufreq_policy into which the current cpufreq_policy 2376 2375 * is written 2376 + * @cpu: CPU to find the policy for 2377 2377 * 2378 2378 * Reads the current cpufreq policy. 2379 2379 */ ··· 2761 2759 } 2762 2760 EXPORT_SYMBOL_GPL(cpufreq_register_driver); 2763 2761 2764 - /** 2762 + /* 2765 2763 * cpufreq_unregister_driver - unregister the current CPUFreq driver 2766 2764 * 2767 2765 * Unregister the current CPUFreq driver. Only call this if you have