From: Chanwoo Choi <cw00.choi@samsung.com>
Date: Mon, 26 Jun 2017 09:00:34 +0000 (+0900)
Subject: pass: hal: Add description for helper functions
X-Git-Tag: submit/tizen/20170705.081057~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2f98fb8acf69ff73ccaa11cc4e4e79a2bb30586d;p=platform%2Fcore%2Fsystem%2Fpass.git

pass: hal: Add description for helper functions

This patch adds the simple description for helper functions
in order to improve the readability for the supported range of functions.

Change-Id: Ibbddda47c1f7560291d9fee709bb5da8573fcc93
Signed-off-by: Chanwoo Choi <cw00.choi@samsung.com>
---

diff --git a/src/pass/pass-hal.h b/src/pass/pass-hal.h
index 6700eea..de4157b 100644
--- a/src/pass/pass-hal.h
+++ b/src/pass/pass-hal.h
@@ -22,6 +22,16 @@
 
 #include "hal/hal.h"
 
+/***
+ * Functions for all H/W resources
+ */
+/* Get and put the h/w resource. */
+int pass_get_resource(struct pass *pass);
+int pass_put_resource(struct pass *pass);
+
+/***
+ * Functions for CPU/BUS/GPU H/W resources
+ */
 /* Get and the current governor. */
 int pass_get_curr_governor(struct pass_resource *res, char *governor);
 int pass_set_curr_governor(struct pass_resource *res, char *governor);
@@ -41,6 +51,13 @@ int pass_set_max_freq(struct pass_resource *res, int freq);
 int pass_get_up_threshold(struct pass_resource *res);
 int pass_set_up_threshold(struct pass_resource *res, int up_threshold);
 
+/* Get the temperature and policy of thermal unit on specific h/w. */
+int pass_get_temp(struct pass_resource *res);
+int pass_get_policy(struct pass_resource *res, char *policy);
+
+/***
+ * Functions for CPU H/W resources
+ */
 /* Get and set online state of cpu. */
 int pass_get_online_state(struct pass_resource *res, int cpu);
 int pass_set_online_state(struct pass_resource *res, int cpu, int on);
@@ -50,15 +67,6 @@ int pass_set_online_min_num(struct pass_resource *res, int num);
 /* Get and set the maximum number of online CPUs */
 int pass_get_online_max_num(struct pass_resource *res);
 int pass_set_online_max_num(struct pass_resource *res, int num);
-
-/* Get the temperature and policy of thermal unit on specific h/w. */
-int pass_get_temp(struct pass_resource *res);
-int pass_get_policy(struct pass_resource *res, char *policy);
-
-/* Get and put the h/w resource. */
-int pass_get_resource(struct pass *pass);
-int pass_put_resource(struct pass *pass);
-
 /*
  * FXIME: Following function is not standard interface.
  * These functions will be altered by the standard interface on later.