hal: Add separate description for each struct pass_resource_*

This patch adds the seprate description for each h/w resource
in order to improve the readability of the meaning of struct pass_resource_*.

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

diff --git a/src/hal/hal.h b/src/hal/hal.h
index 895e74b2074d9dbe61f437ab6d9896ff850ba457..4d41cc66789a13f5d95c9e65ac62971dedf82424 100644 (file)
--- a/src/hal/hal.h
+++ b/src/hal/hal.h
@@ -149,19 +149,13 @@ struct pass_resource_tmu_ops {
        int (*get_policy)(char *res_name, char *policy);
 };
 
-
 /*
- * Define the specific resource structure.
+ * Define the resource structure for CPU H/W.
  *
  * @common     : common resource structure.
- * @dvfs       : function lists for the DVFS (Dynamic Volt. & Freq. Scaling). 
+ * @dvfs       : function lists for the DVFS (Dynamic Volt. & Freq. Scaling).
  * @tmu                : function lists for the TMU (Thermal Management Unit).
- * @hotplug    : function lists for the Dynamic Hotplug.
- *
- * PASS hal support following kind of h/w resources:
- * - CPU, struct pass_resource_cpu
- * - BUS, struct pass_resource_bus
- * - GPU, struct pass_resource_gpu
+ * @hotplug    : function lists for the CPU on/off.
  */
 struct pass_resource_cpu {
        struct pass_resource_common common;
@@ -171,6 +165,13 @@ struct pass_resource_cpu {
        struct pass_resource_hotplug_ops hotplug;
 };
 
+/*
+ * Define the resource structure for Memory Bus H/W.
+ *
+ * @common     : common resource structure.
+ * @dvfs       : function lists for the DVFS (Dynamic Volt. & Freq. Scaling).
+ * @tmu                : function lists for the TMU (Thermal Management Unit).
+ */
 struct pass_resource_bus {
        struct pass_resource_common common;
 
@@ -178,6 +179,13 @@ struct pass_resource_bus {
        struct pass_resource_tmu_ops tmu;
 };
 
+/*
+ * Define the resource structure for GPU H/W.
+ *
+ * @common     : common resource structure.
+ * @dvfs       : function lists for the DVFS (Dynamic Volt. & Freq. Scaling).
+ * @tmu                : function lists for the TMU (Thermal Management Unit).
+ */
 struct pass_resource_gpu {
        struct pass_resource_common common;