From: Thomas, Sujith <sujith.thomas@intel.com>
Date: Wed, 5 Nov 2008 10:45:13 +0000 (+0530)
Subject: intel_menlow: Add comment documenting legal GTHS values
X-Git-Tag: firefly_0821_release~16872^2~6^2~13
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=d65dcdcf0cd55b4be1fd1f5025388e91042d63fc;p=firefly-linux-kernel-4.4.55.git

intel_menlow: Add comment documenting legal GTHS values

Signed-off-by: Sujith Thomas <sujith.thomas@intel.com>
Signed-off-by: Len Brown <len.brown@intel.com>
---

diff --git a/drivers/misc/intel_menlow.c b/drivers/misc/intel_menlow.c
index 124b37ddb5c1..27b7662955bb 100644
--- a/drivers/misc/intel_menlow.c
+++ b/drivers/misc/intel_menlow.c
@@ -52,6 +52,11 @@ MODULE_LICENSE("GPL");
 #define MEMORY_ARG_CUR_BANDWIDTH 1
 #define MEMORY_ARG_MAX_BANDWIDTH 0
 
+/*
+ * GTHS returning 'n' would mean that [0,n-1] states are supported
+ * In that case max_cstate would be n-1
+ * GTHS returning '0' would mean that no bandwidth control states are supported
+ */
 static int memory_get_int_max_bandwidth(struct thermal_cooling_device *cdev,
 					unsigned long *max_state)
 {