PM / devfreq: Get rid of some doc warnings
[linux-2.6-microblaze.git] / include / linux / devfreq.h
index c6f82d4..57e871a 100644 (file)
@@ -158,7 +158,7 @@ struct devfreq_stats {
  * functions except for the context of callbacks defined in struct
  * devfreq_governor, the governor should protect its access with the
  * struct mutex lock in struct devfreq. A governor may use this mutex
- * to protect its own private data in void *data as well.
+ * to protect its own private data in ``void *data`` as well.
  */
 struct devfreq {
        struct list_head node;
@@ -201,24 +201,23 @@ struct devfreq_freqs {
 };
 
 #if defined(CONFIG_PM_DEVFREQ)
-extern struct devfreq *devfreq_add_device(struct device *dev,
-                                 struct devfreq_dev_profile *profile,
-                                 const char *governor_name,
-                                 void *data);
-extern int devfreq_remove_device(struct devfreq *devfreq);
-extern struct devfreq *devm_devfreq_add_device(struct device *dev,
-                                 struct devfreq_dev_profile *profile,
-                                 const char *governor_name,
-                                 void *data);
-extern void devm_devfreq_remove_device(struct device *dev,
-                                 struct devfreq *devfreq);
+struct devfreq *devfreq_add_device(struct device *dev,
+                               struct devfreq_dev_profile *profile,
+                               const char *governor_name,
+                               void *data);
+int devfreq_remove_device(struct devfreq *devfreq);
+struct devfreq *devm_devfreq_add_device(struct device *dev,
+                               struct devfreq_dev_profile *profile,
+                               const char *governor_name,
+                               void *data);
+void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq);
 
 /* Supposed to be called by PM callbacks */
-extern int devfreq_suspend_device(struct devfreq *devfreq);
-extern int devfreq_resume_device(struct devfreq *devfreq);
+int devfreq_suspend_device(struct devfreq *devfreq);
+int devfreq_resume_device(struct devfreq *devfreq);
 
-extern void devfreq_suspend(void);
-extern void devfreq_resume(void);
+void devfreq_suspend(void);
+void devfreq_resume(void);
 
 /**
  * update_devfreq() - Reevaluate the device and configure frequency
@@ -226,39 +225,38 @@ extern void devfreq_resume(void);
  *
  * Note: devfreq->lock must be held
  */
-extern int update_devfreq(struct devfreq *devfreq);
+int update_devfreq(struct devfreq *devfreq);
 
 /* Helper functions for devfreq user device driver with OPP. */
-extern struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
-                                          unsigned long *freq, u32 flags);
-extern int devfreq_register_opp_notifier(struct device *dev,
-                                        struct devfreq *devfreq);
-extern int devfreq_unregister_opp_notifier(struct device *dev,
-                                          struct devfreq *devfreq);
-extern int devm_devfreq_register_opp_notifier(struct device *dev,
-                                             struct devfreq *devfreq);
-extern void devm_devfreq_unregister_opp_notifier(struct device *dev,
-                                               struct devfreq *devfreq);
-extern int devfreq_register_notifier(struct devfreq *devfreq,
-                                       struct notifier_block *nb,
-                                       unsigned int list);
-extern int devfreq_unregister_notifier(struct devfreq *devfreq,
-                                       struct notifier_block *nb,
-                                       unsigned int list);
-extern int devm_devfreq_register_notifier(struct device *dev,
+struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
+                               unsigned long *freq, u32 flags);
+int devfreq_register_opp_notifier(struct device *dev,
+                               struct devfreq *devfreq);
+int devfreq_unregister_opp_notifier(struct device *dev,
+                               struct devfreq *devfreq);
+int devm_devfreq_register_opp_notifier(struct device *dev,
+                               struct devfreq *devfreq);
+void devm_devfreq_unregister_opp_notifier(struct device *dev,
+                               struct devfreq *devfreq);
+int devfreq_register_notifier(struct devfreq *devfreq,
+                               struct notifier_block *nb,
+                               unsigned int list);
+int devfreq_unregister_notifier(struct devfreq *devfreq,
+                               struct notifier_block *nb,
+                               unsigned int list);
+int devm_devfreq_register_notifier(struct device *dev,
                                struct devfreq *devfreq,
                                struct notifier_block *nb,
                                unsigned int list);
-extern void devm_devfreq_unregister_notifier(struct device *dev,
+void devm_devfreq_unregister_notifier(struct device *dev,
                                struct devfreq *devfreq,
                                struct notifier_block *nb,
                                unsigned int list);
-extern struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev,
-                                               int index);
+struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index);
 
 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
 /**
- * struct devfreq_simple_ondemand_data - void *data fed to struct devfreq
+ * struct devfreq_simple_ondemand_data - ``void *data`` fed to struct devfreq
  *     and devfreq_add_device
  * @upthreshold:       If the load is over this value, the frequency jumps.
  *                     Specify 0 to use the default. Valid value = 0 to 100.
@@ -278,7 +276,7 @@ struct devfreq_simple_ondemand_data {
 
 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_PASSIVE)
 /**
- * struct devfreq_passive_data - void *data fed to struct devfreq
+ * struct devfreq_passive_data - ``void *data`` fed to struct devfreq
  *     and devfreq_add_device
  * @parent:    the devfreq instance of parent device.
  * @get_target_freq:   Optional callback, Returns desired operating frequency
@@ -311,9 +309,9 @@ struct devfreq_passive_data {
 
 #else /* !CONFIG_PM_DEVFREQ */
 static inline struct devfreq *devfreq_add_device(struct device *dev,
-                                         struct devfreq_dev_profile *profile,
-                                         const char *governor_name,
-                                         void *data)
+                                       struct devfreq_dev_profile *profile,
+                                       const char *governor_name,
+                                       void *data)
 {
        return ERR_PTR(-ENOSYS);
 }
@@ -350,31 +348,31 @@ static inline void devfreq_suspend(void) {}
 static inline void devfreq_resume(void) {}
 
 static inline struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
-                                          unsigned long *freq, u32 flags)
+                                       unsigned long *freq, u32 flags)
 {
        return ERR_PTR(-EINVAL);
 }
 
 static inline int devfreq_register_opp_notifier(struct device *dev,
-                                        struct devfreq *devfreq)
+                                       struct devfreq *devfreq)
 {
        return -EINVAL;
 }
 
 static inline int devfreq_unregister_opp_notifier(struct device *dev,
-                                          struct devfreq *devfreq)
+                                       struct devfreq *devfreq)
 {
        return -EINVAL;
 }
 
 static inline int devm_devfreq_register_opp_notifier(struct device *dev,
-                                                    struct devfreq *devfreq)
+                                       struct devfreq *devfreq)
 {
        return -EINVAL;
 }
 
 static inline void devm_devfreq_unregister_opp_notifier(struct device *dev,
-                                                       struct devfreq *devfreq)
+                                       struct devfreq *devfreq)
 {
 }
 
@@ -393,22 +391,22 @@ static inline int devfreq_unregister_notifier(struct devfreq *devfreq,
 }
 
 static inline int devm_devfreq_register_notifier(struct device *dev,
-                               struct devfreq *devfreq,
-                               struct notifier_block *nb,
-                               unsigned int list)
+                                       struct devfreq *devfreq,
+                                       struct notifier_block *nb,
+                                       unsigned int list)
 {
        return 0;
 }
 
 static inline void devm_devfreq_unregister_notifier(struct device *dev,
-                               struct devfreq *devfreq,
-                               struct notifier_block *nb,
-                               unsigned int list)
+                                       struct devfreq *devfreq,
+                                       struct notifier_block *nb,
+                                       unsigned int list)
 {
 }
 
 static inline struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev,
-                                                       int index)
+                                       int index)
 {
        return ERR_PTR(-ENODEV);
 }