Skip to contentSkip to conversation

platform/x86: thinkpad_acpi: lap or desk mode interface

PATCH Superseded Mark Pearson 9 participants 42 messages Jun 2, 2020 – Sep 17, 2020 28 messages not in the archive

Subsystems (2)
lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw

PATCH v2 1/1 platform/x86: thinkpad_acpi: lap or desk mode interface

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

---
Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 drivers/platform/x86/thinkpad_acpi.c | 113 +++++++++++++++++++++++++++
 1 file changed, 113 insertions(+)
drivers/platform/x86/thinkpad_acpi.c +113 -0
index 0f704484ae1d..8f51bbba21cd 100644
@@ -4049,6 +4049,7 @@ static bool hotkey_notify_6xxx(const u32 hkey,
 		pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
 		/* recommended action: do nothing, we don't have
 		 * Lenovo ATM information */
+		tpacpi_driver_event(hkey);
 		return true;
 	case TP_HKEY_EV_THM_TRANSFM_CHANGED:
 		pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9811,6 +9812,110 @@ static struct ibm_struct lcdshadow_driver_data = {
 	.write = lcdshadow_write,
 };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo performace mode feature
+ */
+
+#define DYTC_CMD_GET      2 /*To get current IC function and mode*/
+
+#define DYTC_GET_ENABLE_MASK  0x1 /*0 = disabled, 1 = enabled*/
+#define DYTC_GET_LAPMODE_SHIFT 17
+
+static int  dytc_lapmode;
+static void dytc_lapmode_notify_change(void)
+{
+	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+			"dytc_lapmode");
+}
+
+static int dytc_command(int command)
+{
+	acpi_handle dytc_handle;
+	int output;
+
+	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+		/*Platform doesn't support DYTC*/
+		return -ENODEV;
+	}
+	if (!acpi_evalf(dytc_handle, &output, NULL, "dd", command))
+		return -EIO;
+	return output;
+}
+
+static int dytc_lapmode_get(void)
+{
+	int output;
+
+	output = dytc_command(DYTC_CMD_GET);
+	if ((output == -ENODEV) || (output == -EIO))
+		return output;
+
+	return ((output >> DYTC_GET_LAPMODE_SHIFT) &
+				DYTC_GET_ENABLE_MASK);
+}
+
+static void dytc_lapmode_refresh(void)
+{
+	int new_state;
+
+	new_state = dytc_lapmode_get();
+	if ((new_state == -ENODEV) || (new_state == -EIO))
+		return;
+
+	if (dytc_lapmode != new_state) {
+		dytc_lapmode = new_state;
+		dytc_lapmode_notify_change();
+	}
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+					struct device_attribute *attr,
+					char *buf)
+{
+	if (dytc_lapmode < 0)
+		return dytc_lapmode;
+
+	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+	&dev_attr_dytc_lapmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_attr_group = {
+	.attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+	int res;
+
+	dytc_lapmode = dytc_lapmode_get();
+
+	if (dytc_lapmode < 0 && dytc_lapmode != -ENODEV)
+		return dytc_lapmode;
+
+	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
+				&dytc_attr_group);
+
+	return res;
+}
+
+static void dytc_exit(void)
+{
+	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
+			&dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+	.name = "dytc",
+	.exit = dytc_exit
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9858,6 +9963,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
 		mutex_unlock(&kbdlight_mutex);
 	}
+
+	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+		dytc_lapmode_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10296,6 +10405,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
 		.init = tpacpi_lcdshadow_init,
 		.data = &lcdshadow_driver_data,
 	},
+	{
+		.init = tpacpi_dytc_init,
+		.data = &dytc_driver_data,
+	},
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
Signature · 1 line
2.26.2
#2 lore raw

PATCH RESEND v2 1/1 platform/x86: thinkpad_acpi: lap or desk mode interface

In reply to a message not in the archive

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

---
Resend:
- Adding Bastien Nocera to cc list as requested
Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 drivers/platform/x86/thinkpad_acpi.c | 113 +++++++++++++++++++++++++++
 1 file changed, 113 insertions(+)
drivers/platform/x86/thinkpad_acpi.c +113 -0
index 0f704484ae1d..8f51bbba21cd 100644
@@ -4049,6 +4049,7 @@ static bool hotkey_notify_6xxx(const u32 hkey,
 		pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
 		/* recommended action: do nothing, we don't have
 		 * Lenovo ATM information */
+		tpacpi_driver_event(hkey);
 		return true;
 	case TP_HKEY_EV_THM_TRANSFM_CHANGED:
 		pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9811,6 +9812,110 @@ static struct ibm_struct lcdshadow_driver_data = {
 	.write = lcdshadow_write,
 };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo performace mode feature
+ */
+
+#define DYTC_CMD_GET      2 /*To get current IC function and mode*/
+
+#define DYTC_GET_ENABLE_MASK  0x1 /*0 = disabled, 1 = enabled*/
+#define DYTC_GET_LAPMODE_SHIFT 17
+
+static int  dytc_lapmode;
+static void dytc_lapmode_notify_change(void)
+{
+	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+			"dytc_lapmode");
+}
+
+static int dytc_command(int command)
+{
+	acpi_handle dytc_handle;
+	int output;
+
+	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+		/*Platform doesn't support DYTC*/
+		return -ENODEV;
+	}
+	if (!acpi_evalf(dytc_handle, &output, NULL, "dd", command))
+		return -EIO;
+	return output;
+}
+
+static int dytc_lapmode_get(void)
+{
+	int output;
+
+	output = dytc_command(DYTC_CMD_GET);
+	if ((output == -ENODEV) || (output == -EIO))
+		return output;
+
+	return ((output >> DYTC_GET_LAPMODE_SHIFT) &
+				DYTC_GET_ENABLE_MASK);
+}
+
+static void dytc_lapmode_refresh(void)
+{
+	int new_state;
+
+	new_state = dytc_lapmode_get();
+	if ((new_state == -ENODEV) || (new_state == -EIO))
+		return;
+
+	if (dytc_lapmode != new_state) {
+		dytc_lapmode = new_state;
+		dytc_lapmode_notify_change();
+	}
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+					struct device_attribute *attr,
+					char *buf)
+{
+	if (dytc_lapmode < 0)
+		return dytc_lapmode;
+
+	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+	&dev_attr_dytc_lapmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_attr_group = {
+	.attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+	int res;
+
+	dytc_lapmode = dytc_lapmode_get();
+
+	if (dytc_lapmode < 0 && dytc_lapmode != -ENODEV)
+		return dytc_lapmode;
+
+	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
+				&dytc_attr_group);
+
+	return res;
+}
+
+static void dytc_exit(void)
+{
+	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
+			&dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+	.name = "dytc",
+	.exit = dytc_exit
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9858,6 +9963,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
 		mutex_unlock(&kbdlight_mutex);
 	}
+
+	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+		dytc_lapmode_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10296,6 +10405,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
 		.init = tpacpi_lcdshadow_init,
 		.data = &lcdshadow_driver_data,
 	},
+	{
+		.init = tpacpi_dytc_init,
+		.data = &dytc_driver_data,
+	},
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
Signature · 1 line
2.26.2

A message that is not in the archive (sent off-list or not yet received): [email protected]

A message that is not in the archive (sent off-list or not yet received): 1905013469.24563660.1592574774373.JavaMail.zimbra-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org

#5 lore raw

Hi Bastien

Quoted 3 lines · Bastien Nocera

Hey Mark,

----- Original Message -----

<snip>

Quoted 10 lines
Quoted 4 lines

+/*************************************************************************
+ * DYTC subdriver, for the Lenovo performace mode feature
+ */

I don't think this should mention the performance mode, as it's a lap/table detection mode. Do we need to call that "DYTC"? "lapmode"? "lap_detection"? Or does the DYTC interface offer more functionality that we'd export in the future?

I've just noticed that I can't spell performance either which is embarrassing :)

Originally I developed this code for a thermal modes feature - but this portion of it is also needed for WWAN so we pulled out just this piece as the first bit to get in. Having WWAN available for users is more important than the thermal mode interface (there are a lot of users who want WWAN working properly on our laptops).

So...yes, DYTC does offer more functionality and I'm planning on proposing the thermal patch as soon as this one makes it through, but I agree that in the context of this patch the comment is misleading. I will clean that up for this version.

Quoted 5 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9819

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+
+#define DYTC_CMD_GET      2 /*To get current IC function and mode*/

For this comment and all the ones below, space after "/*" and before "*/"

Ack

Quoted 4 lines
Quoted 1 line

+#define DYTC_GET_ENABLE_MASK 0x1 /*0 = disabled, 1 = enabled*/

Is that necessary?

Another hangover in that the other fields used for the thermal mode have more interesting masks and this fitted in with that. I can remove for now if it's really a problem.

Quoted 5 lines
Quoted 1 line

+#define DYTC_GET_LAPMODE_SHIFT 17

You'd probably want to call this "bit" rather than shift. We shift it to read the value, but 17 is the bit's position. (See BIT() usage in the driver)

Ack

Quoted 4 lines

Do you want to add a comment here? Is there anything else that could be documented (the other bits, which versions of firmware would have that, if there's a publicly available version, or which hardware if publicly available)

So what is the preference normally? More pieces will definitely be made public when I release the thermal mode updates but I assumed we kept things related only to the code used. I can add more detail here if that helps. Not trying to hide anything :)

Quoted 26 lines
Quoted 26 lines
drivers/platform/x86/thinkpad_acpi.c +26 -0
+static int  dytc_lapmode;
+static void dytc_lapmode_notify_change(void)
+{
+	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+			"dytc_lapmode");
+}
+
+static int dytc_command(int command)
+{
+	acpi_handle dytc_handle;
+	int output;
+
+	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+		/*Platform doesn't support DYTC*/
+		return -ENODEV;
+	}
+	if (!acpi_evalf(dytc_handle, &output, NULL, "dd", command))
+		return -EIO;
+	return output;
+}
+
+static int dytc_lapmode_get(void)
+{
+	int output;
+
+	output = dytc_command(DYTC_CMD_GET);
Quoted 9 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9854

Quoted 5 lines
drivers/platform/x86/thinkpad_acpi.c +5 -0
+	if ((output == -ENODEV) || (output == -EIO))
+		return output;
+
+	return ((output >> DYTC_GET_LAPMODE_SHIFT) &
+				DYTC_GET_ENABLE_MASK);

Use BIT() instead? eg.
return (output & BIT(DYTC_GET_LAPMODE_SHIFT));

Ack

Quoted 12 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9863

Quoted 9 lines
drivers/platform/x86/thinkpad_acpi.c +9 -0
+}
+
+static void dytc_lapmode_refresh(void)
+{
+	int new_state;
+
+	new_state = dytc_lapmode_get();
+	if ((new_state == -ENODEV) || (new_state == -EIO))
+		return;

You could also return early if "dytc_lapmode == new_state".

Good point.

Quoted 2 lines

Rest looks good to me.

Great - thanks for the review. I'll prepare the updates and if there's any feedback on the questions above please let me know

Mark

#6 lore raw

PATCH v3 1/1 platform/x86: thinkpad_acpi: lap or desk mode interface

In reply to a message not in the archive

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

---
Changes in v3:
- Fixed inaccurate comments
- Used BIT macro to check lapmode bit setting as recommended and update define name
- Check for new_state == dytc_lapmode in dytc_lapmode_refresh

Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 drivers/platform/x86/thinkpad_acpi.c | 110 +++++++++++++++++++++++++++
 1 file changed, 110 insertions(+)
drivers/platform/x86/thinkpad_acpi.c +110 -0
index 0f704484ae1d..ce3bfb546109 100644
@@ -4049,6 +4049,7 @@ static bool hotkey_notify_6xxx(const u32 hkey,
 		pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
 		/* recommended action: do nothing, we don't have
 		 * Lenovo ATM information */
+		tpacpi_driver_event(hkey);
 		return true;
 	case TP_HKEY_EV_THM_TRANSFM_CHANGED:
 		pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9811,6 +9812,107 @@ static struct ibm_struct lcdshadow_driver_data = {
 	.write = lcdshadow_write,
 };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo lapmode feature
+ */
+
+#define DYTC_CMD_GET          2 /* To get current IC function and mode */
+#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+
+static int  dytc_lapmode;
+static void dytc_lapmode_notify_change(void)
+{
+	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+			"dytc_lapmode");
+}
+
+static int dytc_command(int command)
+{
+	acpi_handle dytc_handle;
+	int output;
+
+	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+		/* Platform doesn't support DYTC */
+		return -ENODEV;
+	}
+	if (!acpi_evalf(dytc_handle, &output, NULL, "dd", command))
+		return -EIO;
+	return output;
+}
+
+static int dytc_lapmode_get(void)
+{
+	int output;
+
+	output = dytc_command(DYTC_CMD_GET);
+	if ((output == -ENODEV) || (output == -EIO))
+		return output;
+
+	return (output & BIT(DYTC_GET_LAPMODE_BIT) ? 1 : 0);
+}
+
+static void dytc_lapmode_refresh(void)
+{
+	int new_state;
+
+	new_state = dytc_lapmode_get();
+	if ((new_state == -ENODEV) || (new_state == -EIO) || (new_state == dytc_lapmode))
+		return;
+
+	if (dytc_lapmode != new_state) {
+		dytc_lapmode = new_state;
+		dytc_lapmode_notify_change();
+	}
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+					struct device_attribute *attr,
+					char *buf)
+{
+	if (dytc_lapmode < 0)
+		return dytc_lapmode;
+
+	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+	&dev_attr_dytc_lapmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_attr_group = {
+	.attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+	int res;
+
+	dytc_lapmode = dytc_lapmode_get();
+
+	if (dytc_lapmode < 0 && dytc_lapmode != -ENODEV)
+		return dytc_lapmode;
+
+	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
+				&dytc_attr_group);
+
+	return res;
+}
+
+static void dytc_exit(void)
+{
+	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
+			&dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+	.name = "dytc",
+	.exit = dytc_exit
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9858,6 +9960,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
 		mutex_unlock(&kbdlight_mutex);
 	}
+
+	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+		dytc_lapmode_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10296,6 +10402,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
 		.init = tpacpi_lcdshadow_init,
 		.data = &lcdshadow_driver_data,
 	},
+	{
+		.init = tpacpi_dytc_init,
+		.data = &dytc_driver_data,
+	},
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
Signature · 1 line
2.26.2
#7 lore raw

PATCH v4 1/1 platform/x86: thinkpad_acpi: lap or desk mode interface

In reply to a message not in the archive

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

---
Changes in v4:
- Correct hotkey event comment as we're handling event
- Remove unnecessary check in dytc_lapmode_refresh
Changes in v3:
- Fixed inaccurate comments
- Used BIT macro to check lapmode bit setting as recommended and update define name
- Check for new_state == dytc_lapmode in dytc_lapmode_refresh

Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 drivers/platform/x86/thinkpad_acpi.c | 111 ++++++++++++++++++++++++++-
 1 file changed, 109 insertions(+), 2 deletions(-)
drivers/platform/x86/thinkpad_acpi.c +109 -2
index 0f704484ae1d..859b40c7113e 100644
@@ -4047,8 +4047,8 @@ static bool hotkey_notify_6xxx(const u32 hkey,
 		return true;
 	case TP_HKEY_EV_THM_CSM_COMPLETED:
 		pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
-		/* recommended action: do nothing, we don't have
-		 * Lenovo ATM information */
+		/* Thermal event - pass on to event handler */
+		tpacpi_driver_event(hkey);
 		return true;
 	case TP_HKEY_EV_THM_TRANSFM_CHANGED:
 		pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9811,6 +9811,105 @@ static struct ibm_struct lcdshadow_driver_data = {
 	.write = lcdshadow_write,
 };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo lapmode feature
+ */
+
+#define DYTC_CMD_GET          2 /* To get current IC function and mode */
+#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+
+static int  dytc_lapmode;
+static void dytc_lapmode_notify_change(void)
+{
+	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+			"dytc_lapmode");
+}
+
+static int dytc_command(int command)
+{
+	acpi_handle dytc_handle;
+	int output;
+
+	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+		/* Platform doesn't support DYTC */
+		return -ENODEV;
+	}
+	if (!acpi_evalf(dytc_handle, &output, NULL, "dd", command))
+		return -EIO;
+	return output;
+}
+
+static int dytc_lapmode_get(void)
+{
+	int output;
+
+	output = dytc_command(DYTC_CMD_GET);
+	if ((output == -ENODEV) || (output == -EIO))
+		return output;
+
+	return (output & BIT(DYTC_GET_LAPMODE_BIT) ? 1 : 0);
+}
+
+static void dytc_lapmode_refresh(void)
+{
+	int new_state;
+
+	new_state = dytc_lapmode_get();
+	if ((new_state == -ENODEV) || (new_state == -EIO) || (new_state == dytc_lapmode))
+		return;
+
+	dytc_lapmode = new_state;
+	dytc_lapmode_notify_change();
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+					struct device_attribute *attr,
+					char *buf)
+{
+	if (dytc_lapmode < 0)
+		return dytc_lapmode;
+
+	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+	&dev_attr_dytc_lapmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_attr_group = {
+	.attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+	int res;
+
+	dytc_lapmode = dytc_lapmode_get();
+
+	if (dytc_lapmode < 0 && dytc_lapmode != -ENODEV)
+		return dytc_lapmode;
+
+	res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
+				&dytc_attr_group);
+
+	return res;
+}
+
+static void dytc_exit(void)
+{
+	sysfs_remove_group(&tpacpi_pdev->dev.kobj,
+			&dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+	.name = "dytc",
+	.exit = dytc_exit
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9858,6 +9957,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
 		mutex_unlock(&kbdlight_mutex);
 	}
+
+	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+		dytc_lapmode_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10296,6 +10399,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
 		.init = tpacpi_lcdshadow_init,
 		.data = &lcdshadow_driver_data,
 	},
+	{
+		.init = tpacpi_dytc_init,
+		.data = &dytc_driver_data,
+	},
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
Signature · 1 line
2.26.2

A message that is not in the archive (sent off-list or not yet received): 20200629191748.3859-1-markpearson-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

Reviewed-by
#9 lore raw

----- Original Message -----

Quoted 11 lines

Newer Lenovo Thinkpad platforms have support to identify whether the
system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

You can add my:

Cheers

A message that is not in the archive (sent off-list or not yet received): 732277929.1313334.1593596757447.JavaMail.zimbra-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org

#11 lore raw

Hello Bastien

Quoted 11 lines

-----Original Message-----
From: Bastien Nocera <[email protected]>

----- Original Message -----

Quoted 7 lines

Newer Lenovo Thinkpad platforms have support to identify whether the
system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Quoted 8 lines
Quoted 4 lines

You can add my:

It's already added in latest patch and currently in "for-next"
http://git.infradead.org/linux-platform-drivers-x86.git/commit/acf7f4a59114471c3964f118564fe8e7a6f34bb8

Thanks

A message that is not in the archive (sent off-list or not yet received): SG2PR03MB2718DFC08C4ECF7816D1B4E48C720-ePYYJTVkT3RfCKvAoM4nXq82SN/[email protected]

#13 lore raw

----- Original Message -----

Quoted 19 lines

Hello Bastien

Quoted 17 lines

-----Original Message-----
From: Bastien Nocera <[email protected]>

----- Original Message -----

Quoted 11 lines

Newer Lenovo Thinkpad platforms have support to identify whether the
system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Quoted 5 lines
Quoted 2 lines

You can add my:

It's already added in latest patch and currently in "for-next"
http://git.infradead.org/linux-platform-drivers-x86.git/commit/acf7f4a59114471c3964f118564fe8e7a6f34bb8

I sent my message nearly a month ago, 2 days before the authoring date of the patch that was merged, so I'm not sure what you're trying to tell me here :)

A message that is not in the archive (sent off-list or not yet received): 321690127.4797880.1595847834329.JavaMail.zimbra-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org

#15 lore raw
Quoted 14 lines

-----Original Message-----
From: Bastien Nocera <[email protected]>
Sent: Monday, July 27, 2020 8:04 PM
To: Nitin Joshi1 <[email protected]>

Quoted 10 lines
Quoted 9 lines
Quoted 5 lines

You can add my:

Quoted 7 lines
Quoted 3 lines

It's already added in latest patch and currently in "for-next"
http://git.infradead.org/linux-platform-drivers-x86.git/commit/acf7f4a
59114471c3964f118564fe8e7a6f34bb8

I sent my message nearly a month ago, 2 days before the authoring date of the patch that was merged, so I'm not sure what you're trying to tell me here :)

Sorry , please ignore this e-mail . Don’t know why it came up on my mailbox today . But its my mistake , I would have seen date when this e-mail was sent :) Apologize for inconvenience caused.

Thanks & Regards,
Nitin Joshi

_______________________________________________
ibm-acpi-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ibm-acpi-devel

#16 lore raw
In reply to a message not in the archive

On Mon, Jun 29, 2020 at 10:23 PM Mark Pearson <[email protected]> wrote:

Thanks for the patch, my comments below.

Quoted 6 lines

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Please use proper indentation (no need to have spaces) and punctuation (like period at the end of sentences).

...

Quoted 2 lines
 drivers/platform/x86/thinkpad_acpi.c | 111 ++++++++++++++++++++++++++-
 1 file changed, 109 insertions(+), 2 deletions(-)

You specifically added a new ABI, where is documentation? It's a show stopper.

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9825

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+       sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+                       "dytc_lapmode");

One line?

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9848

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +5 -0
+       int output;
+
+       output = dytc_command(DYTC_CMD_GET);
 
+       if ((output == -ENODEV) || (output == -EIO))
+               return output;

Why not simple

if (output < 0)
return output;

Btw, how will this survive the 31st bit (if some method would like to use it)?

I think your prototype should be

int foo(cmd, *output);

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9859

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+       new_state = dytc_lapmode_get();
+       if ((new_state == -ENODEV) || (new_state == -EIO) || (new_state == dytc_lapmode))
+               return;

What about other errors?
What about MSB being set?

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9899

Quoted 9 lines
drivers/platform/x86/thinkpad_acpi.c +8 -0
+       dytc_lapmode = dytc_lapmode_get();
+
+       if (dytc_lapmode < 0 && dytc_lapmode != -ENODEV)
+               return dytc_lapmode;
 
+       res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
+                               &dytc_attr_group);
+
+       return res;

return ...(...);

So, we create a group for all possible error cases but ENODEV. Why?

Quoted 1 line

+}

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9905

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+       sysfs_remove_group(&tpacpi_pdev->dev.kobj,
+                       &dytc_attr_group);

One line?

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9910

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+static struct ibm_struct dytc_driver_data = {
+       .name = "dytc",
+       .exit = dytc_exit

Comma is missed.

Quoted 1 line

+};

Signature · 2 lines
With Best Regards,
Andy Shevchenko

A message that is not in the archive (sent off-list or not yet received): CAHp75VeO5SzYs=kRh+BV_vydO7PTPLkmu8aiYXvSJFTewSTYwA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#18 lore raw

Thanks Andy

Quoted 7 lines · Andy Shevchenko

On Mon, Jun 29, 2020 at 10:23 PM Mark Pearson <[email protected]> wrote:

Thanks for the patch, my comments below.

Quoted 3 lines

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

Quoted 6 lines
Quoted 3 lines

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Please use proper indentation (no need to have spaces) and punctuation (like period at the end of sentences).

Ack

Quoted 7 lines

...

Quoted 2 lines
  drivers/platform/x86/thinkpad_acpi.c | 111 ++++++++++++++++++++++++++-
  1 file changed, 109 insertions(+), 2 deletions(-)

You specifically added a new ABI, where is documentation? It's a show stopper.

Ah - my apologies I didn't know that was a requirement.

Any pointers on where to add it? I looked in Documentation/ABI and I couldn't find anything around thinkpad_acpi to add this to. Should there be a sysfs-devices-platform-thinkpad_acpi file?

If that's the case I'm happy to look at creating that but as a first time kernel contributor would you object if I took that on as a separate exercise rather than as part of this patch. I'm guessing it would need more time, care and reviewers from other contributors to the thinkpad_acpi.c driver

Quoted 7 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9825

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+       sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
+                       "dytc_lapmode");

One line?

Ack

Quoted 7 lines

...

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+       int output;
+
+       output = dytc_command(DYTC_CMD_GET);
Quoted 7 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9848

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+       if ((output == -ENODEV) || (output == -EIO))
+               return output;

Why not simple

if (output < 0)

    return output;

Agreed. I'll fix

Quoted 2 lines

Btw, how will this survive the 31st bit (if some method would like to use it)?

Hmmm - good point. I'll revisit this.

Quoted 4 lines

I think your prototype should be

int foo(cmd, *output);

Looking at it again - I agree.

Quoted 9 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9859

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+       new_state = dytc_lapmode_get();
+       if ((new_state == -ENODEV) || (new_state == -EIO) || (new_state == dytc_lapmode))
+               return;

What about other errors?
What about MSB being set?

Ack - this needs fixing

Quoted 8 lines

...

Quoted 4 lines
drivers/platform/x86/thinkpad_acpi.c +4 -0
+       dytc_lapmode = dytc_lapmode_get();
+
+       if (dytc_lapmode < 0 && dytc_lapmode != -ENODEV)
+               return dytc_lapmode;
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9899

Quoted 4 lines
drivers/platform/x86/thinkpad_acpi.c +4 -0
+       res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
+                               &dytc_attr_group);
+
+       return res;

return ...(...);

So, we create a group for all possible error cases but ENODEV. Why?

There seemed a good reason when I originally wrote it - but now I'm wondering why too.
I specifically was catching the ENODEV because of concerns around creating the group on platforms that didn't have the support for this feature - but I think in doing that I missed the obvious of all errors.

I'll revisit and fix.

Quoted 9 lines
Quoted 2 lines

+}

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9905

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+       sysfs_remove_group(&tpacpi_pdev->dev.kobj,
+                       &dytc_attr_group);

One line?

Ack.
As a minor note I think these all arose because of getting checkpatch to run cleanly. I prefer one line too and if that's your preference it works for me.

Quoted 8 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct lcdshadow_driver_data = { · line 9910

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+static struct ibm_struct dytc_driver_data = {
+       .name = "dytc",
+       .exit = dytc_exit

Comma is missed.

Ack

Quoted 3 lines
Quoted 2 lines

+};

I'll work on these and get an updated version out for review. Thank you for your time looking at these.

Mark

A message that is not in the archive (sent off-list or not yet received): 7d0e1dcc-7285-71e1-7125-604cb2630595-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#20 lore raw
Quoted 2 lines · Mark Pearson
Quoted 1 line · Andy Shevchenko

On Mon, Jun 29, 2020 at 10:23 PM Mark Pearson <[email protected]> wrote:

...

Quoted 7 lines
Quoted 1 line

You specifically added a new ABI, where is documentation? It's a show stopper.

Ah - my apologies I didn't know that was a requirement.

Any pointers on where to add it? I looked in Documentation/ABI and I couldn't find anything around thinkpad_acpi to add this to. Should there be a sysfs-devices-platform-thinkpad_acpi file?

Quoted 5 lines

If that's the case I'm happy to look at creating that but as a first time kernel contributor would you object if I took that on as a separate exercise rather than as part of this patch. I'm guessing it would need more time, care and reviewers from other contributors to the thinkpad_acpi.c driver

Since it's an old driver its ABI is listed here

https://elixir.bootlin.com/linux/latest/source/Documentation/admin-guide/laptops/thinkpad-acpi.rst

...

Quoted 10 lines
Quoted 4 lines

Why not simple

if (output < 0)

    return output;

Agreed. I'll fix

Quoted 3 lines

I think your prototype should be

int foo(cmd, *output);

Looking at it again - I agree.

And after returning only error codes, you may do above as simple as

int ret;

ret = ...(.., &output);
if (ret)
return ret;
...
return 0;

...

Quoted 3 lines

As a minor note I think these all arose because of getting checkpatch to run cleanly. I prefer one line too and if that's your preference it works for me.

Checkpatch shouldn't complain (update it if it does).

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#21 lore raw

PATCH v5 1/1 platform/x86: thinkpad_acpi: lap or desk mode interface

In reply to a message not in the archive

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

---
Changes in v5:
- Updated with review changes from Andy Shevchenko
- Added ABI information to thinkpad-acpi.rst
- improved error handling and parameter passing as recommended
- code cleanup as recommended
- added review tag from bnocera
Changes in v4:
- Correct hotkey event comment as we're handling event
- Remove unnecessary check in dytc_lapmode_refresh
Changes in v3:
- Fixed inaccurate comments
- Used BIT macro to check lapmode bit setting as recommended and update define name
- Check for new_state == dytc_lapmode in dytc_lapmode_refresh Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 .../admin-guide/laptops/thinkpad-acpi.rst     |  15 +++
 drivers/platform/x86/thinkpad_acpi.c          | 111 +++++++++++++++++-
 2 files changed, 124 insertions(+), 2 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +15 -0
index 822907dcc845..99066aa8d97b 100644
@@ -50,6 +50,7 @@ detailed description):
 	- WAN enable and disable
 	- UWB enable and disable
 	- LCD Shadow (PrivacyGuard) enable and disable
+	- Lap mode sensor
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1432,6 +1433,20 @@ The first command ensures the best viewing angle and the latter one turns
 on the feature, restricting the viewing angles.
 
 
+DYTC Lapmode sensor
+------------------
+
+sysfs: dytc_lapmode
+
+Newer thinkpads and mobile workstations have the ability to determine if
+the device is in deskmode or lapmode. This feature is used by user space
+to decide if WWAN transmission can be increased to maximum power and is
+also useful for understanding the different thermal modes available as
+they differ between desk and lap mode.
+
+The property is read-only. If the platform doesn't have support the sysfs
+class is not created.
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +109 -2

135 lines not on this page · raw message

Signature · 1 line
2.26.2

A message that is not in the archive (sent off-list or not yet received): 20200703012353.26413-1-markpearson-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#23 lore raw
Quoted 7 lines · Mark Pearson

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Hans, do you think it's good to have custom ABI for this? I think you may be know better what types of ABI we already have for such thing.

Quoted 208 lines

---
Changes in v5:
- Updated with review changes from Andy Shevchenko
- Added ABI information to thinkpad-acpi.rst
- improved error handling and parameter passing as recommended
- code cleanup as recommended
- added review tag from bnocera
Changes in v4:
- Correct hotkey event comment as we're handling event
- Remove unnecessary check in dytc_lapmode_refresh
Changes in v3:
- Fixed inaccurate comments
- Used BIT macro to check lapmode bit setting as recommended and update define name
- Check for new_state == dytc_lapmode in dytc_lapmode_refresh Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 .../admin-guide/laptops/thinkpad-acpi.rst     |  15 +++
 drivers/platform/x86/thinkpad_acpi.c          | 111 +++++++++++++++++-
 2 files changed, 124 insertions(+), 2 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +15 -0
index 822907dcc845..99066aa8d97b 100644
@@ -50,6 +50,7 @@ detailed description):
        - WAN enable and disable
        - UWB enable and disable
        - LCD Shadow (PrivacyGuard) enable and disable
+       - Lap mode sensor
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1432,6 +1433,20 @@ The first command ensures the best viewing angle and the latter one turns
 on the feature, restricting the viewing angles.
 
 
+DYTC Lapmode sensor
+------------------
+
+sysfs: dytc_lapmode
+
+Newer thinkpads and mobile workstations have the ability to determine if
+the device is in deskmode or lapmode. This feature is used by user space
+to decide if WWAN transmission can be increased to maximum power and is
+also useful for understanding the different thermal modes available as
+they differ between desk and lap mode.
+
+The property is read-only. If the platform doesn't have support the sysfs
+class is not created.
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +109 -3
index ff7f0a4f2475..037eb77414f9 100644
@@ -4022,8 +4022,8 @@ static bool hotkey_notify_6xxx(const u32 hkey,
                return true;
        case TP_HKEY_EV_THM_CSM_COMPLETED:
                pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
-               /* recommended action: do nothing, we don't have
-                * Lenovo ATM information */
+               /* Thermal event - pass on to event handler */
+               tpacpi_driver_event(hkey);
                return true;
        case TP_HKEY_EV_THM_TRANSFM_CHANGED:
                pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9795,6 +9795,105 @@ static struct ibm_struct lcdshadow_driver_data = {
        .write = lcdshadow_write,
 };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo lapmode feature
+ */
+
+#define DYTC_CMD_GET          2 /* To get current IC function and mode */
+#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+
+static bool dytc_lapmode;
+
+static void dytc_lapmode_notify_change(void)
+{
+       sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
+}
+
+static int dytc_command(int command, int *output)
+{
+       acpi_handle dytc_handle;
+
+       if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+               /* Platform doesn't support DYTC */
+               return -ENODEV;
+       }
+       if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
+               return -EIO;
+       return 0;
+}
+
+static int dytc_lapmode_get(bool *state)
+{
+       int output, err;
+
+       err = dytc_command(DYTC_CMD_GET, &output);
+       if (err)
+               return err;
+       *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
+       return 0;
+}
+
+static void dytc_lapmode_refresh(void)
+{
+       bool new_state;
+       int err;
+
+       err = dytc_lapmode_get(&new_state);
+       if (err || (new_state == dytc_lapmode))
+               return;
+
+       dytc_lapmode = new_state;
+       dytc_lapmode_notify_change();
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+                                       struct device_attribute *attr,
+                                       char *buf)
+{
+       return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+       &dev_attr_dytc_lapmode.attr,
+       NULL,
+};
+
+static const struct attribute_group dytc_attr_group = {
+       .attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+       int err;
+
+       err = dytc_lapmode_get(&dytc_lapmode);
+       /* If support isn't available (ENODEV) then don't return an error
+        * but just don't create the sysfs group
+        */
+       if (err == -ENODEV)
+               return 0;
+       /* For all other errors we can flag the failure */
+       if (err)
+               return err;
+
+       /* Platform supports this feature - create the group */
+       err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+       return err;
+}
+
+static void dytc_exit(void)
+{
+       sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+       .name = "dytc",
+       .exit = dytc_exit,
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9842,6 +9941,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
                mutex_unlock(&kbdlight_mutex);
        }
+
+       if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+               dytc_lapmode_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10280,6 +10383,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
                .init = tpacpi_lcdshadow_init,
                .data = &lcdshadow_driver_data,
        },
+       {
+               .init = tpacpi_dytc_init,
+               .data = &dytc_driver_data,
+       },
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
--

2.26.2

Signature · 2 lines
With Best Regards,
Andy Shevchenko

A message that is not in the archive (sent off-list or not yet received): CAHp75Vcs15wGCzwW8Pq7AXyqQnvnopNdFP1nDE0nf+ZTz=9zFw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#25 lore raw

Hi,

Quoted 11 lines · Andy Shevchenko
Quoted 7 lines · Mark Pearson

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Hans, do you think it's good to have custom ABI for this? I think you may be know better what types of ABI we already have for such thing.

Actually, Mark asked me the same question before submitting his patch upstream. I'm never a fan of custom ABI for this. But for now the solution Lenovo has chosen to deal with thermal management issues on modern hw is unique to Lenovo and we do not have anything like this anywhere else.

So for now I believe that a custom ABI is best.

If we see this becoming a common feature on more platforms then we can design a generic API for it once we have a better idea how this would look like when implemented by others and then thinkpad_acpi can easily add support for the new generic interface, while keeping its own custom interface for backward compatibility.

Regards,

Hans

Quoted 211 lines
Quoted 209 lines

---
Changes in v5:
- Updated with review changes from Andy Shevchenko
- Added ABI information to thinkpad-acpi.rst
- improved error handling and parameter passing as recommended
- code cleanup as recommended
- added review tag from bnocera
Changes in v4:
- Correct hotkey event comment as we're handling event
- Remove unnecessary check in dytc_lapmode_refresh
Changes in v3:
- Fixed inaccurate comments
- Used BIT macro to check lapmode bit setting as recommended and update define name
- Check for new_state == dytc_lapmode in dytc_lapmode_refresh Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

  .../admin-guide/laptops/thinkpad-acpi.rst     |  15 +++
  drivers/platform/x86/thinkpad_acpi.c          | 111 +++++++++++++++++-
  2 files changed, 124 insertions(+), 2 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +15 -0
index 822907dcc845..99066aa8d97b 100644
@@ -50,6 +50,7 @@ detailed description):
         - WAN enable and disable
         - UWB enable and disable
         - LCD Shadow (PrivacyGuard) enable and disable
+       - Lap mode sensor
 
  A compatibility table by model and feature is maintained on the web
  site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1432,6 +1433,20 @@ The first command ensures the best viewing angle and the latter one turns
  on the feature, restricting the viewing angles.
 
 
+DYTC Lapmode sensor
+------------------
+
+sysfs: dytc_lapmode
+
+Newer thinkpads and mobile workstations have the ability to determine if
+the device is in deskmode or lapmode. This feature is used by user space
+to decide if WWAN transmission can be increased to maximum power and is
+also useful for understanding the different thermal modes available as
+they differ between desk and lap mode.
+
+The property is read-only. If the platform doesn't have support the sysfs
+class is not created.
+
  EXPERIMENTAL: UWB
  -----------------
 
drivers/platform/x86/thinkpad_acpi.c +109 -3
index ff7f0a4f2475..037eb77414f9 100644
@@ -4022,8 +4022,8 @@ static bool hotkey_notify_6xxx(const u32 hkey,
                 return true;
         case TP_HKEY_EV_THM_CSM_COMPLETED:
                 pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
-               /* recommended action: do nothing, we don't have
-                * Lenovo ATM information */
+               /* Thermal event - pass on to event handler */
+               tpacpi_driver_event(hkey);
                 return true;
         case TP_HKEY_EV_THM_TRANSFM_CHANGED:
                 pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9795,6 +9795,105 @@ static struct ibm_struct lcdshadow_driver_data = {
         .write = lcdshadow_write,
  };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo lapmode feature
+ */
+
+#define DYTC_CMD_GET          2 /* To get current IC function and mode */
+#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+
+static bool dytc_lapmode;
+
+static void dytc_lapmode_notify_change(void)
+{
+       sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
+}
+
+static int dytc_command(int command, int *output)
+{
+       acpi_handle dytc_handle;
+
+       if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+               /* Platform doesn't support DYTC */
+               return -ENODEV;
+       }
+       if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
+               return -EIO;
+       return 0;
+}
+
+static int dytc_lapmode_get(bool *state)
+{
+       int output, err;
+
+       err = dytc_command(DYTC_CMD_GET, &output);
+       if (err)
+               return err;
+       *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
+       return 0;
+}
+
+static void dytc_lapmode_refresh(void)
+{
+       bool new_state;
+       int err;
+
+       err = dytc_lapmode_get(&new_state);
+       if (err || (new_state == dytc_lapmode))
+               return;
+
+       dytc_lapmode = new_state;
+       dytc_lapmode_notify_change();
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+                                       struct device_attribute *attr,
+                                       char *buf)
+{
+       return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+       &dev_attr_dytc_lapmode.attr,
+       NULL,
+};
+
+static const struct attribute_group dytc_attr_group = {
+       .attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+       int err;
+
+       err = dytc_lapmode_get(&dytc_lapmode);
+       /* If support isn't available (ENODEV) then don't return an error
+        * but just don't create the sysfs group
+        */
+       if (err == -ENODEV)
+               return 0;
+       /* For all other errors we can flag the failure */
+       if (err)
+               return err;
+
+       /* Platform supports this feature - create the group */
+       err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+       return err;
+}
+
+static void dytc_exit(void)
+{
+       sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+       .name = "dytc",
+       .exit = dytc_exit,
+};
+
  /****************************************************************************
   ****************************************************************************
   *
@@ -9842,6 +9941,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
                 mutex_unlock(&kbdlight_mutex);
         }
+
+       if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+               dytc_lapmode_refresh();
+
  }
 
  static void hotkey_driver_event(const unsigned int scancode)
@@ -10280,6 +10383,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
                 .init = tpacpi_lcdshadow_init,
                 .data = &lcdshadow_driver_data,
         },
+       {
+               .init = tpacpi_dytc_init,
+               .data = &dytc_driver_data,
+       },
  };
 
  static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
--

2.26.2

A message that is not in the archive (sent off-list or not yet received): 7c1698a6-ebd6-553d-a686-d9bd4e5a5e99-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org

#27 lore raw
Quoted 22 lines · Hans de Goede

Hi,

Quoted 11 lines · Andy Shevchenko
Quoted 7 lines · Mark Pearson

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Hans, do you think it's good to have custom ABI for this? I think you may be know better what types of ABI we already have for such thing.

Actually, Mark asked me the same question before submitting his patch upstream. I'm never a fan of custom ABI for this. But for now the solution Lenovo has chosen to deal with thermal management issues on modern hw is unique to Lenovo and we do not have anything like this anywhere else.

Quoted 7 lines

So for now I believe that a custom ABI is best.

If we see this becoming a common feature on more platforms then we can design a generic API for it once we have a better idea how this would look like when implemented by others and then thinkpad_acpi can easily add support for the new generic interface, while keeping its own custom interface for backward compatibility.

Thank you very much for the elaborative comment, appreciated!

Signature · 2 lines
With Best Regards,
Andy Shevchenko

A message that is not in the archive (sent off-list or not yet received): CAHp75Ve-qOs8VosoxEaHH1EnK-r16Sx0ki3uj14yZJWyuwC88w-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#29 lore raw
Quoted 25 lines · Andy Shevchenko
Quoted 24 lines · Hans de Goede

Hi,

Quoted 11 lines · Andy Shevchenko
Quoted 7 lines · Mark Pearson

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Hans, do you think it's good to have custom ABI for this? I think you may be know better what types of ABI we already have for such thing.

Actually, Mark asked me the same question before submitting his patch upstream. I'm never a fan of custom ABI for this. But for now the solution Lenovo has chosen to deal with thermal management issues on modern hw is unique to Lenovo and we do not have anything like this anywhere else.

So for now I believe that a custom ABI is best.

Quoted 8 lines
Quoted 5 lines

If we see this becoming a common feature on more platforms then we can design a generic API for it once we have a better idea how this would look like when implemented by others and then thinkpad_acpi can easily add support for the new generic interface, while keeping its own custom interface for backward compatibility.

Thank you very much for the elaborative comment, appreciated!

Yes, thanks Hans from me too.

Just to note, I'm very happy to work on or contribute to a generic framework if that makes sense in the future. I'd likely need some help & guidance on the best way to do it but if you see a need let me know.

Andy - let me know if you need anything else for this patch. I have a follow on patch for a similar sensor that I'll send up once this one is approved - I figured we should learn from our mistakes on this one before duplicating the errors.

Thanks all for the support, reviews and guidance

Mark

#30 lore raw
In reply to a message not in the archive
Quoted 8 lines · Mark Pearson

Newer Lenovo Thinkpad platforms have support to identify whether the system is on-lap or not using an ACPI DYTC event from the firmware.

This patch provides the ability to retrieve the current mode via sysfs entrypoints and will be used by userspace for thermal mode and WWAN functionality

Pushed to my review and testing queue, thanks!

Quoted 208 lines

---
Changes in v5:
- Updated with review changes from Andy Shevchenko
- Added ABI information to thinkpad-acpi.rst
- improved error handling and parameter passing as recommended
- code cleanup as recommended
- added review tag from bnocera
Changes in v4:
- Correct hotkey event comment as we're handling event
- Remove unnecessary check in dytc_lapmode_refresh
Changes in v3:
- Fixed inaccurate comments
- Used BIT macro to check lapmode bit setting as recommended and update define name
- Check for new_state == dytc_lapmode in dytc_lapmode_refresh Changes in v2:
- cleaned up initialisation sequence to be cleaner and avoid spamming platforms that don't have DYTC with warning message. Tested on P52
- Adding platform-driver-x86 mailing list for review as requested

 .../admin-guide/laptops/thinkpad-acpi.rst     |  15 +++
 drivers/platform/x86/thinkpad_acpi.c          | 111 +++++++++++++++++-
 2 files changed, 124 insertions(+), 2 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +15 -0
index 822907dcc845..99066aa8d97b 100644
@@ -50,6 +50,7 @@ detailed description):
        - WAN enable and disable
        - UWB enable and disable
        - LCD Shadow (PrivacyGuard) enable and disable
+       - Lap mode sensor
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1432,6 +1433,20 @@ The first command ensures the best viewing angle and the latter one turns
 on the feature, restricting the viewing angles.
 
 
+DYTC Lapmode sensor
+------------------
+
+sysfs: dytc_lapmode
+
+Newer thinkpads and mobile workstations have the ability to determine if
+the device is in deskmode or lapmode. This feature is used by user space
+to decide if WWAN transmission can be increased to maximum power and is
+also useful for understanding the different thermal modes available as
+they differ between desk and lap mode.
+
+The property is read-only. If the platform doesn't have support the sysfs
+class is not created.
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +109 -3
index ff7f0a4f2475..037eb77414f9 100644
@@ -4022,8 +4022,8 @@ static bool hotkey_notify_6xxx(const u32 hkey,
                return true;
        case TP_HKEY_EV_THM_CSM_COMPLETED:
                pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
-               /* recommended action: do nothing, we don't have
-                * Lenovo ATM information */
+               /* Thermal event - pass on to event handler */
+               tpacpi_driver_event(hkey);
                return true;
        case TP_HKEY_EV_THM_TRANSFM_CHANGED:
                pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
@@ -9795,6 +9795,105 @@ static struct ibm_struct lcdshadow_driver_data = {
        .write = lcdshadow_write,
 };
 
+/*************************************************************************
+ * DYTC subdriver, for the Lenovo lapmode feature
+ */
+
+#define DYTC_CMD_GET          2 /* To get current IC function and mode */
+#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+
+static bool dytc_lapmode;
+
+static void dytc_lapmode_notify_change(void)
+{
+       sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
+}
+
+static int dytc_command(int command, int *output)
+{
+       acpi_handle dytc_handle;
+
+       if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
+               /* Platform doesn't support DYTC */
+               return -ENODEV;
+       }
+       if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
+               return -EIO;
+       return 0;
+}
+
+static int dytc_lapmode_get(bool *state)
+{
+       int output, err;
+
+       err = dytc_command(DYTC_CMD_GET, &output);
+       if (err)
+               return err;
+       *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
+       return 0;
+}
+
+static void dytc_lapmode_refresh(void)
+{
+       bool new_state;
+       int err;
+
+       err = dytc_lapmode_get(&new_state);
+       if (err || (new_state == dytc_lapmode))
+               return;
+
+       dytc_lapmode = new_state;
+       dytc_lapmode_notify_change();
+}
+
+/* sysfs lapmode entry */
+static ssize_t dytc_lapmode_show(struct device *dev,
+                                       struct device_attribute *attr,
+                                       char *buf)
+{
+       return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+}
+
+static DEVICE_ATTR_RO(dytc_lapmode);
+
+static struct attribute *dytc_attributes[] = {
+       &dev_attr_dytc_lapmode.attr,
+       NULL,
+};
+
+static const struct attribute_group dytc_attr_group = {
+       .attrs = dytc_attributes,
+};
+
+static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
+{
+       int err;
+
+       err = dytc_lapmode_get(&dytc_lapmode);
+       /* If support isn't available (ENODEV) then don't return an error
+        * but just don't create the sysfs group
+        */
+       if (err == -ENODEV)
+               return 0;
+       /* For all other errors we can flag the failure */
+       if (err)
+               return err;
+
+       /* Platform supports this feature - create the group */
+       err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+       return err;
+}
+
+static void dytc_exit(void)
+{
+       sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+}
+
+static struct ibm_struct dytc_driver_data = {
+       .name = "dytc",
+       .exit = dytc_exit,
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9842,6 +9941,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 
                mutex_unlock(&kbdlight_mutex);
        }
+
+       if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
+               dytc_lapmode_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10280,6 +10383,10 @@ static struct ibm_init_struct ibms_init[] __initdata = {
                .init = tpacpi_lcdshadow_init,
                .data = &lcdshadow_driver_data,
        },
+       {
+               .init = tpacpi_dytc_init,
+               .data = &dytc_driver_data,
+       },
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
--

2.26.2

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#31 lore raw

PATCH 1/1 platform/x86: thinkpad_acpi: psensor interface

In reply to a message not in the archive

Some Lenovo Thinkpad platforms are equipped with a 'palm sensor' so as to be able to determine if a user is physically proximate to the device.

This patch provides the ability to retrieve the psensor state via sysfs entrypoints and will be used by userspace for WWAN functionality to control the transmission level safely

---
 .../admin-guide/laptops/thinkpad-acpi.rst     |  19 ++++
 drivers/platform/x86/thinkpad_acpi.c          | 104 +++++++++++++++++-
 2 files changed, 121 insertions(+), 2 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +19 -0
index 99066aa8d97b..c2c238d5d5f6 100644
@@ -51,6 +51,7 @@ detailed description):
 	- UWB enable and disable
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
+        - Palm sensor (aka p-sensor)
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1447,6 +1448,24 @@ they differ between desk and lap mode.
 The property is read-only. If the platform doesn't have support the sysfs
 class is not created.
 
+Palm sensor
+------------------
+
+sysfs: psensor_state
+
+Certain thinkpads and mobile workstations are equipped with a palm sensor to
+detect when a user is physically near the device. This device, when present,
+is used in conjunction with the lapmode sensor to decide if WWAN transmission
+can be increased to maximum power.
+
+The property is read-only. If the platform doesn't have support the sysfs
+class is not created.
+
+Note - some platforms have a limitation whereby the EC firmware cannot
+determine if the sensor is not installed or not. On these platforms the
+p-sensor state will always be reported as true to avoid high power being used
+incorrectly.
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +102 -2

128 lines not on this page · raw message

Signature · 1 line
2.26.2

A message that is not in the archive (sent off-list or not yet received): 20200715235242.4934-1-markpearson-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#33 lore raw

Re: [PATCH] platform/x86: thinkpad_acpi: psensor interface

Quoted 7 lines · Mark Pearson

Some Lenovo Thinkpad platforms are equipped with a 'palm sensor' so as to be able to determine if a user is physically proximate to the device.

This patch provides the ability to retrieve the psensor state via sysfs entrypoints and will be used by userspace for WWAN functionality to control the transmission level safely

...

drivers/platform/x86/thinkpad_acpi.c static bool hotkey_notify_6xxx(const u32 hkey, · line 4076

Quoted 7 lines

case TP_HKEY_EV_PALM_DETECTED:
case TP_HKEY_EV_PALM_UNDETECTED:

drivers/platform/x86/thinkpad_acpi.c +2 -2
-               /* palm detected hovering the keyboard, forward to user-space
-                * via netlink for consumption */
+               /* palm detected - pass on to event handler */
+               tpacpi_driver_event(hkey);
                return true;

Comment here tells something about the netlink interface to user space. Can you elaborate why we need sysfs now and how it's all supposed to work?

...

Quoted 9 lines
drivers/platform/x86/thinkpad_acpi.c +9 -0
+static int psensor_get(bool *state)
+{
+       acpi_handle psensor_handle;
+       int output;
+
+       if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS", &psensor_handle)))
+               return -ENODEV;
+
+       if (!acpi_evalf(psensor_handle, &output, NULL, "d"))

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9928

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +10 -0
+               return -EIO;
+
+       /* Check if sensor has a Psensor */
+       if (!(output & BIT(PSENSOR_PRESENT_BIT)))
+               return -ENODEV;
+
+       /* Return if psensor is set or not */
+       *state = output & BIT(PSENSOR_ON_BIT) ? true : false;
+       return 0;
+}

It reminds me of a function you created in one of the previous changes. Can you rather create a parameterized helper which will serve for both?

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9948

Quoted 7 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+/* sysfs psensor entry */
+static ssize_t psensor_state_show(struct device *dev,
+                                       struct device_attribute *attr,
+                                       char *buf)
+{
 
+       return snprintf(buf, PAGE_SIZE, "%d\n", psensor_state);

We know that %d takes much less than PAGE_SIZE, use sprintf().

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9909

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+}
 
+

No blank line here.

Quoted 1 line

+static DEVICE_ATTR_RO(psensor_state);

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9955

Quoted 4 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+static struct attribute *psensor_attributes[] = {
+       &dev_attr_psensor_state.attr,
 
+       NULL,

No comma for terminator line(s).

Quoted 1 line

+};

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9969

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+       /* If support isn't available (ENODEV) then don't return an error
+        * but just don't create the sysfs group
+        */

/*
* Consider to use a proper multi-line comment style.
* Like here. (It's applicable to the entire patch) */

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9977

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+       err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &psensor_attr_group);
+       return err;

return sysfs...

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#34 lore raw

Re: [External] Re: [PATCH] platform/x86: thinkpad_acpi: psensor interface

Hi Andy ,

Quoted 14 lines

-----Original Message-----
From: Andy Shevchenko <[email protected]>
Sent: Monday, July 27, 2020 7:35 PM

drivers/platform/x86/thinkpad_acpi.c static bool hotkey_notify_6xxx(const u32 hkey, · line 4076

Quoted 8 lines · Mark Pearson

case TP_HKEY_EV_PALM_DETECTED:
case TP_HKEY_EV_PALM_UNDETECTED:

drivers/platform/x86/thinkpad_acpi.c +2 -2
-               /* palm detected hovering the keyboard, forward to user-space
-                * via netlink for consumption */
+               /* palm detected - pass on to event handler */
+               tpacpi_driver_event(hkey);
                return true;
Quoted 3 lines

Comment here tells something about the netlink interface to user space. Can you elaborate why we need sysfs now and how it's all supposed to work?

Using netlink , we were getting proximity events like '0x60b0' and '0x60b1' but for our WWAN requirement, we need default and current p-sensor state too .
Some tools like "acpi-listen" uses netlink to display events but we need default and current p-sensor state also as per our requirement. hence , we have added new sysfs to get current p-sensor state using 'GPSS' method from BIOS .
This will be used for implementing "Dynamic power reduction" app which is used to control Body SAR value as per FCC requirement . When Body or any object is near or away from p-sensor location on thinkpad system , then sysfs will be set .

Quoted 10 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = {

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+static int psensor_get(bool *state)
+{
+       acpi_handle psensor_handle;
+       int output;
+
+       if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS",

&psensor_handle)))

Quoted 16 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9928

Quoted 13 lines
drivers/platform/x86/thinkpad_acpi.c +13 -0
+               return -ENODEV;
+
+       if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
+               return -EIO;
+
+       /* Check if sensor has a Psensor */
+       if (!(output & BIT(PSENSOR_PRESENT_BIT)))
+               return -ENODEV;
+
+       /* Return if psensor is set or not */
+       *state = output & BIT(PSENSOR_ON_BIT) ? true : false;
+       return 0;
+}

It reminds me of a function you created in one of the previous changes. Can you rather create a parameterized helper which will serve for both?

Ack , we will check it .

Quoted 10 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9948

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +5 -0
+/* sysfs psensor entry */
+static ssize_t psensor_state_show(struct device *dev,
+                                       struct device_attribute *attr,
+                                       char *buf) {
 
+       return snprintf(buf, PAGE_SIZE, "%d\n", psensor_state);
Quoted 8 lines

We know that %d takes much less than PAGE_SIZE, use sprintf().

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9909

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+}
 
+

No blank line here.

Ack

Quoted 11 lines
Quoted 1 line

+static DEVICE_ATTR_RO(psensor_state);

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9955

Quoted 4 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+static struct attribute *psensor_attributes[] = {
+       &dev_attr_psensor_state.attr,
 
+       NULL,

No comma for terminator line(s).

Ack

Quoted 12 lines
Quoted 1 line

+};

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9969

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+       /* If support isn't available (ENODEV) then don't return an error
+        * but just don't create the sysfs group
+        */

/*
* Consider to use a proper multi-line comment style.
* Like here. (It's applicable to the entire patch) */

Quoted 7 lines

...

Quoted 1 line

+ err = sysfs_create_group(&tpacpi_pdev->dev.kobj,

&psensor_attr_group);

Quoted 1 line

+ return err;

return sysfs...

Ack

Thanks & Regards,
Nitin Joshi

A message that is not in the archive (sent off-list or not yet received): PU1PR03MB2716FE7EF1BF12E5B9EC25188C730-PIfHAIETUCsWqO6DXxnA3a82SN/[email protected]

#36 lore raw

Re: [External] Re: [PATCH] platform/x86: thinkpad_acpi: psensor interface

Hi Andy,

First off apologies for my delay in replying and thanks to Nitin for covering for me. I took a week of PTO and then suffered the consequences of that for the week after - it's taken me a bit to catch-up.

Quoted 19 lines · On 7/27/2020 11:51 PM, Nitin Joshi1 wrote:

Hi Andy ,

Quoted 14 lines

-----Original Message-----
From: Andy Shevchenko <[email protected]>
Sent: Monday, July 27, 2020 7:35 PM

drivers/platform/x86/thinkpad_acpi.c static bool hotkey_notify_6xxx(const u32 hkey, · line 4076

Quoted 8 lines · Mark Pearson

case TP_HKEY_EV_PALM_DETECTED:
case TP_HKEY_EV_PALM_UNDETECTED:

drivers/platform/x86/thinkpad_acpi.c +2 -2
-               /* palm detected hovering the keyboard, forward to user-space
-                * via netlink for consumption */
+               /* palm detected - pass on to event handler */
+               tpacpi_driver_event(hkey);
                 return true;
Quoted 3 lines

Comment here tells something about the netlink interface to user space. Can you elaborate why we need sysfs now and how it's all supposed to work?

Quoted 7 lines

Using netlink , we were getting proximity events like '0x60b0' and '0x60b1' but for our WWAN requirement, we need default and current p-sensor state too .
Some tools like "acpi-listen" uses netlink to display events but we need default and current p-sensor state also as per our requirement. hence , we have added new sysfs to get current p-sensor state using 'GPSS' method from BIOS .
This will be used for implementing "Dynamic power reduction" app which is used to control Body SAR value as per FCC requirement . When Body or any object is near or away from p-sensor location on thinkpad system , then sysfs will be set .

I think Nitin has covered it. Let us know if any follow on questions or concerns here.

Quoted 27 lines
Quoted 10 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = {

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+static int psensor_get(bool *state)
+{
+       acpi_handle psensor_handle;
+       int output;
+
+       if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS",

&psensor_handle)))

Quoted 16 lines

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9928

Quoted 13 lines
drivers/platform/x86/thinkpad_acpi.c +13 -0
+               return -ENODEV;
+
+       if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
+               return -EIO;
+
+       /* Check if sensor has a Psensor */
+       if (!(output & BIT(PSENSOR_PRESENT_BIT)))
+               return -ENODEV;
+
+       /* Return if psensor is set or not */
+       *state = output & BIT(PSENSOR_ON_BIT) ? true : false;
+       return 0;
+}

It reminds me of a function you created in one of the previous changes. Can you rather create a parameterized helper which will serve for both?

Quoted 1 line

Ack , we will check it .

I've been looking at this and I understand where you're coming from but the benefits of combining them aren't working for me.

The previous change was for the lapmode sensor which is a separate piece of hardware. The ACPI handle and access format is different and the lapmode sensor has some extra handling logic needed. The code has enough differences too that I don't think combining it makes a lot of sense.

Let me know if I'm missing something obvious or if you disagree.

Quoted 47 lines
Quoted 11 lines

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9948

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +5 -0
+/* sysfs psensor entry */
+static ssize_t psensor_state_show(struct device *dev,
+                                       struct device_attribute *attr,
+                                       char *buf) {
 
+       return snprintf(buf, PAGE_SIZE, "%d\n", psensor_state);
Quoted 8 lines

We know that %d takes much less than PAGE_SIZE, use sprintf().

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9909

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +2 -0
+}
 
+

No blank line here.

Ack

Quoted 11 lines
Quoted 1 line

+static DEVICE_ATTR_RO(psensor_state);

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9955

Quoted 4 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+static struct attribute *psensor_attributes[] = {
+       &dev_attr_psensor_state.attr,
 
+       NULL,

No comma for terminator line(s).

Ack

Quoted 12 lines
Quoted 1 line

+};

...

drivers/platform/x86/thinkpad_acpi.c static struct ibm_struct dytc_driver_data = { · line 9969

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +3 -0
+       /* If support isn't available (ENODEV) then don't return an error
+        * but just don't create the sysfs group
+        */

/*
* Consider to use a proper multi-line comment style.
* Like here. (It's applicable to the entire patch) */

Quoted 9 lines
Quoted 7 lines

...

Quoted 1 line

+ err = sysfs_create_group(&tpacpi_pdev->dev.kobj,

&psensor_attr_group);

Quoted 1 line

+ return err;

return sysfs...

Ack

I'll push a patch soon with these other adjustments.

Thanks for the review
Mark

#37 lore raw

PATCH 1/1 platform/x86: thinkpad_acpi: performance mode interface

In reply to a message not in the archive

Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to provide different performance/thermal modes.

The modes can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the operating mode between three different modes.

H - High performance. Maximum power is available and the temperature is allowed to increase to the maximum for the platform.
M - Medium performance (aka balance). In this mode power will be limited and the laptop will have a lower maximum temperature.
L - Low performance (aka quiet). In this mode power consumption is reduced and the device will be cooler.

High performance mode is only available when the device is in 'desk mode'. If the device detects that it is on a lap then it will automatically drop into medium mode to maintain a safer operating temperature.

This patch provides an interface to determine the current mode and to also allow the setting of the mode through the dytc_perfmode sysfs entry. This can be used by userspace for improved control.

---
 .../admin-guide/laptops/thinkpad-acpi.rst     |  35 +++
 drivers/platform/x86/thinkpad_acpi.c          | 209 +++++++++++++++++-
 2 files changed, 235 insertions(+), 9 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +35 -0
index 2e9d62903ead..d5fef0bb562b 100644
@@ -52,6 +52,7 @@ detailed description):
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
         - Palm sensor (aka psensor)
+        - Thermal mode status and control
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1466,6 +1467,40 @@ determine if the sensor is not installed or not. On these platforms the
 psensor state will always be reported as true to avoid high power being used
 incorrectly.
 
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provide a better
+interface for user space to use
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature is
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be limited and
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is reduced and
+the device will be cooler and quieter
+
+Note: High performance mode is only available when the device is in 'deskmode'. If
+thde device detects that it is on a lap then it will automatically drop into medium
+mode to maintain a safer operating temperature.
+
+The sysfs entry provides the ability to return the current status and to set the
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +200 -9

259 lines not on this page · raw message

Signature · 1 line
2.26.2

A message that is not in the archive (sent off-list or not yet received): 20200722171108.65185-1-markpearson-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#39 lore raw

Re: [PATCH] platform/x86: thinkpad_acpi: performance mode interface

Quoted 58 lines

Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to provide different performance/thermal modes.

The modes can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the operating mode between three different modes.

H - High performance. Maximum power is available and the temperature is allowed to increase to the maximum for the platform.
M - Medium performance (aka balance). In this mode power will be limited and the laptop will have a lower maximum temperature.
L - Low performance (aka quiet). In this mode power consumption is reduced and the device will be cooler.

High performance mode is only available when the device is in 'desk mode'. If the device detects that it is on a lap then it will automatically drop into medium mode to maintain a safer operating temperature.

This patch provides an interface to determine the current mode and to also allow the setting of the mode through the dytc_perfmode sysfs entry. This can be used by userspace for improved control.

---
 .../admin-guide/laptops/thinkpad-acpi.rst     |  35 +++
 drivers/platform/x86/thinkpad_acpi.c          | 209 +++++++++++++++++-
 2 files changed, 235 insertions(+), 9 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +1 -0
index 2e9d62903ead..d5fef0bb562b 100644
@@ -52,6 +52,7 @@ detailed description):
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
         - Palm sensor (aka psensor)
+        - Thermal mode status and control
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1466,6 +1467,40 @@ determine if the sensor is not installed or not. On

these platforms the
psensor state will always be reported as true to avoid high power being used incorrectly.

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced

firmware to

Documentation/admin-guide/laptops/thinkpad-acpi.rst +4 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provide a
Quoted 2 lines

better
+interface for user space to use

So is userspace also notified in some way when you use the hotkey to change, or is the event usurped by the EC? Is this by the event TP_HKEY_EV_THM_CSM_COMPLETED?

You might consider to mention what other interfaces will conflict with this and document them and/or artificially block them when this is loaded to prevent such a conflict.

Quoted 14 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +10 -0
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature is
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be limited and
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is reduced

and

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+the device will be cooler and quieter
+
+Note: High performance mode is only available when the device is in
Quoted 2 lines

'deskmode'. If
+thde device detects that it is on a lap then it will automatically drop into

the

Quoted 2 lines

medium
+mode to maintain a safer operating temperature.

I don't see an explicit notification path for this, how will userspace know about it?

Doesn't it need some sort of change uevent?
Or is this implied by the event TP_HKEY_EV_THM_CSM_COMPLETED?

Documentation/admin-guide/laptops/thinkpad-acpi.rst determine if the sensor is not installed or not. On these platforms the · line 1502

Quoted 8 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +2 -0
+
+The sysfs entry provides the ability to return the current status and to set

the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +5 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode

Doesn't this need ABI documentation submitted as part of the patch?

Quoted 93 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +1 -0
+
 EXPERIMENTAL: UWB
 -----------------
drivers/platform/x86/thinkpad_acpi.c +69 -1
index 40f2e368fdf9..5aebaf1718b1 100644
@@ -9799,10 +9799,33 @@ static struct ibm_struct lcdshadow_driver_data = {
  * DYTC subdriver, for the Lenovo lapmode feature
  */
 
+#define DYTC_CMD_QUERY        0 /* To get DYTC status - enable/revision */
+#define DYTC_CMD_SET          1 /* To enable/disable IC function mode */
 #define DYTC_CMD_GET          2 /* To get current IC function and mode */
-#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+#define DYTC_CMD_RESET    0x1ff /* To reset back to default */
+
+#define DYTC_QUERY_ENABLE_BIT 8  /* Bit 8 - 0 = disabled, 1 = enabled */
+#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revisision */
+#define DYTC_QUERY_REV_BIT    28 /* Bits 28 - 31 - revision */
+
+#define DYTC_GET_FUNCTION_BIT 8  /* Bits 8-11 - function setting */
+#define DYTC_GET_MODE_BIT     12 /* Bits 12-15 - mode setting */
+#define DYTC_GET_LAPMODE_BIT  17 /* Bit 17 - lapmode. Set when on lap */
+
+#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - funct setting */
+#define DYTC_SET_MODE_BIT     16 /* Bits 16-19 - mode setting */
+#define DYTC_SET_VALID_BIT    20 /* Bit 20 - 1 = on, 0 = off */
+
+#define DYTC_FUNCTION_STD     0  /* Function = 0, standard mode */
+#define DYTC_FUNCTION_CQL     1  /* Function = 1, lap mode */
+#define DYTC_FUNCTION_MMC     11 /* Function = 11, desk mode */
+
+#define DYTC_MODE_PERFORM     2  /* High power mode aka performance */
+#define DYTC_MODE_QUIET       3  /* low power mode aka quiet */
+#define DYTC_MODE_BALANCE   0xF  /* default mode aka balance */
 
 static bool dytc_lapmode;
+static bool dytc_mode_available;
 
 static void dytc_lapmode_notify_change(void)
 {
@@ -9822,7 +9845,81 @@ static int dytc_command(int command, int *output)
 	return 0;
 }
 
+static int dytc_perfmode_get(int *perfmode, int *funcmode)
+{
+	int output, err;
+
+	if (!dytc_mode_available)
+		return -ENODEV;
+
+	err = dytc_command(DYTC_CMD_GET, &output);
+	if (err)
+		return err;
+	*funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
+
+	if (*funcmode == DYTC_FUNCTION_CQL) {
+		int dummy;
+		/* We can't get the mode when in CQL mode - so we disable CQL
+		 * mode retrieve the mode and then enable it again.
+		 */
+		err = dytc_command(0x000F1001 /*Disable CQL*/, &dummy);
+		if (err)
+			return err;
+		err = dytc_command(DYTC_CMD_GET, &output);
+		if (err)
+			return err;
+		err = dytc_command(0x001F1001 /*Enable CQL*/, &dummy);
+		if (err)
+			return err;
+	}
+	*perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
+	return 0;
+}
+
+static int dytc_perfmode_set(int perfmode)
+{
+	int err, dytc_set;
+	int output;
+	int cur_perfmode, cur_funcmode;
+
+	if (!dytc_mode_available)
+		return -ENODEV;
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset command */
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;

drivers/platform/x86/thinkpad_acpi.c static int dytc_command(int command, int *output) · line 9902

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +9 -0
+	} else {
+		/* Determine if we are in CQL mode. This alters the commands we do
 */
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL first*/
+			err = dytc_command(0x000F1001 /*Disable CQL*/, &output);

Why not put 0x000F1001 and 0x001F1001 as defines at the top?

Quoted 46 lines
drivers/platform/x86/thinkpad_acpi.c +37 -0
+			if (err)
+				return err;
+		}
+		dytc_set = (1 << DYTC_SET_VALID_BIT) |
+			(DYTC_FUNCTION_MMC << DYTC_SET_FUNCTION_BIT) |
+			(perfmode << DYTC_SET_MODE_BIT) |
+			DYTC_CMD_SET;
+		err = dytc_command(dytc_set, &output);
+		if (err)
+			return err;
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			err = dytc_command(0x001F1001 /*Enable CQL*/, &output);
+			if (err)
+				return err;
+		}
+	}
+	return 0;
+}
+
 static int dytc_lapmode_get(bool *state)
+
 {
 	int output, err;
@@ -9846,6 +9943,77 @@ static void dytc_lapmode_refresh(void)
 	dytc_lapmode_notify_change();
 }
 
+/* sysfs perfmode entry */
+static ssize_t dytc_perfmode_show(struct device *dev,
+				  struct device_attribute *attr,
+				  char *buf)
+{
+	int err;
+	int perfmode, funcmode;
+
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return err;
+
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return snprintf(buf, PAGE_SIZE, "Medium (Reduced as lapmode
 active)\n");

drivers/platform/x86/thinkpad_acpi.c static void dytc_lapmode_refresh(void) · line 9973

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +10 -0
+		else
+			return snprintf(buf, PAGE_SIZE, "High\n");
+	case DYTC_MODE_QUIET:
+		return snprintf(buf, PAGE_SIZE, "Low\n");
+	case DYTC_MODE_BALANCE:
+		return snprintf(buf, PAGE_SIZE, "Medium\n");
+	default:
+		return snprintf(buf, PAGE_SIZE, "Unknown (%d)\n", perfmode);
+	}
+}

I think it's pretty confusing that you write "H/M/L" into this file, but you get back a full string.

Quoted 13 lines
drivers/platform/x86/thinkpad_acpi.c +13 -0
+
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':

drivers/platform/x86/thinkpad_acpi.c static void dytc_lapmode_refresh(void) · line 9995

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +10 -0
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");

Shouldn't this be dev_err?

Quoted 57 lines
drivers/platform/x86/thinkpad_acpi.c +21 -0
+		break;
+	}
+	if (err)
+		return err;
+
+	tpacpi_disclose_usertask(attr->attr.name,
+				"Performance mode set to %c\n", buf[0]);
+	return count;
+}
+
+static DEVICE_ATTR_RW(dytc_perfmode);
+
+static struct attribute *dytc_perfmode_attributes[] = {
+	&dev_attr_dytc_perfmode.attr,
+	NULL,
+};
+
+static const struct attribute_group dytc_perf_attr_group = {
+	.attrs = dytc_perfmode_attributes,
+};
+
 /* sysfs lapmode entry */
 static ssize_t dytc_lapmode_show(struct device *dev,
drivers/platform/x86/thinkpad_acpi.c +6 -6
 					struct device_attribute *attr,
@@ -9856,22 +10024,22 @@ static ssize_t dytc_lapmode_show(struct device *dev,
 
 static DEVICE_ATTR_RO(dytc_lapmode);
 
-static struct attribute *dytc_attributes[] = {
+static struct attribute *dytc_lap_attributes[] = {
 	&dev_attr_dytc_lapmode.attr,
 	NULL,
 };
 
-static const struct attribute_group dytc_attr_group = {
-	.attrs = dytc_attributes,
+static const struct attribute_group dytc_lap_attr_group = {
+	.attrs = dytc_lap_attributes,
 };
 
 static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
 {
-	int err;
+	int err, output;
 
-	err = dytc_lapmode_get(&dytc_lapmode);
+	err = dytc_command(DYTC_CMD_QUERY, &output);
 	/* If support isn't available (ENODEV) then don't return an error
-	 * but just don't create the sysfs group
+	 * just don't create the sysfs group
 	 */
 	if (err == -ENODEV)
 		return 0;
@@ -9879,14 +10047,37 @@ static int tpacpi_dytc_init(struct ibm_init_struct
 *iibm)
 	if (err)
 		return err;

drivers/platform/x86/thinkpad_acpi.c static int tpacpi_dytc_init(struct ibm_init_struct · line 10059

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +9 -0
 
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_mode_available = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			pr_info("DYTC thermal mode configuration available\n");

I would argue this isn't useful to most people.
1) You should decrease this to debug for use with dynamic debugging
2) Output in the log what integer value you returned back in case of a need to identify future firmware bugs.

drivers/platform/x86/thinkpad_acpi.c static int tpacpi_dytc_init(struct ibm_init_struct *iibm) · line 10059

Quoted 1 line
drivers/platform/x86/thinkpad_acpi.c +1 -0
+			dytc_mode_available = true;

I think you shouldn't set this flag until after the group is actually created.

Quoted 29 lines
drivers/platform/x86/thinkpad_acpi.c +15 -2
+			/* Platform supports this feature - create the group */
+			err = sysfs_create_group(&tpacpi_pdev->dev.kobj,
 &dytc_perf_attr_group);
+			if (err)
+				return err;
+		}
+	}
+
+	err = dytc_lapmode_get(&dytc_lapmode);
+	if (err)
+		return err;
+
 	/* Platform supports this feature - create the group */
-	err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_lap_attr_group);
 	return err;
 }
 
 static void dytc_exit(void)
 {
-	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_lap_attr_group);
+	if (dytc_mode_available)
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_perf_attr_group);
 }

static struct ibm_struct dytc_driver_data = {
--
2.26.2

A message that is not in the archive (sent off-list or not yet received): DM6PR19MB263650F7DC4B6680A5EFC5DAFA790-JELcaX3dgTY1BKDJOnGuQNvXXbHMiUzJvxpqHgZTriW3zl9H0oFU5g@public.gmane.org

#41 lore raw

Re: [External] RE: [PATCH] platform/x86: thinkpad_acpi: performance mode interface

Hi Mario

On 7/22/2020 2:46 PM, Limonciello, Mario wrote:
<snip>

Quoted 18 lines
Quoted 12 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced

firmware to

Documentation/admin-guide/laptops/thinkpad-acpi.rst +4 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provide a
Quoted 2 lines

better
+interface for user space to use

So is userspace also notified in some way when you use the hotkey to change, or is the event usurped by the EC? Is this by the event TP_HKEY_EV_THM_CSM_COMPLETED?

I haven't added that yet - my aim with this patch was to get the sysfs API available. I'll look at adding the notification.

Quoted 3 lines

You might consider to mention what other interfaces will conflict with this and document them and/or artificially block them when this is loaded to prevent such a conflict.

I'm afraid I don't know what other interface will be conflicted with. Is there anything in particular I should be looking for? What did you have in mind?

The firmware is operating by default and this patch is just providing user space with a way of determining the current mode and changing it by an alternate mechanism than hotkeys (I know some people dislike the hotkeys...)

Quoted 1 line

<snip>

Quoted 10 lines

Documentation/admin-guide/laptops/thinkpad-acpi.rst determine if the sensor is not installed or not. On these platforms the · line 1502

Quoted 8 lines
(quoted diff) +2 -0
+
+The sysfs entry provides the ability to return the current status and to set

the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +5 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode

Doesn't this need ABI documentation submitted as part of the patch?

OK - I'll need some help here as I'm not sure what I missed. Isn't that what this part of the patch is covering? If you can give me some pointers for what I should be putting where I'll do that.

Quoted 1 line

<snip>

Quoted 10 lines
Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +8 -0
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset command */
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the commands we do

*/

drivers/platform/x86/thinkpad_acpi.c +1 -0
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static int dytc_command(int command, int *output) · line 9901

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL first*/
+			err = dytc_command(0x000F1001 /*Disable CQL*/, &output);

Why not put 0x000F1001 and 0x001F1001 as defines at the top?

Fair point - I will fix that.

Quoted 1 line

<snip>

Quoted 12 lines
Quoted 12 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return snprintf(buf, PAGE_SIZE, "Medium (Reduced as lapmode

active)\n");

drivers/platform/x86/thinkpad_acpi.c +5 -0
+		else
+			return snprintf(buf, PAGE_SIZE, "High\n");
+	case DYTC_MODE_QUIET:
+		return snprintf(buf, PAGE_SIZE, "Low\n");
+	case DYTC_MODE_BALANCE:
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static void dytc_lapmode_refresh(void) · line 9972

Quoted 5 lines
drivers/platform/x86/thinkpad_acpi.c +5 -0
+		return snprintf(buf, PAGE_SIZE, "Medium\n");
+	default:
+		return snprintf(buf, PAGE_SIZE, "Unknown (%d)\n", perfmode);
+	}
+}

I think it's pretty confusing that you write "H/M/L" into this file, but you get back a full string.

The main reason here for the string is the need to let the user know they are operating in medium mode even though high has been configured - because the device is on their lap. My thinking was you can parse the first letter to get H/M/L but more information is available for the subtleties.
I considered another letter but couldn't determine something that was obvious to a user (Lower case 'h' is my best candidate?) and decided a string was nicer.

I'd appreciate input from others as to the best thing to provide here.

Quoted 18 lines
Quoted 18 lines
drivers/platform/x86/thinkpad_acpi.c +17 -0
+
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static void dytc_lapmode_refresh(void) · line 9995

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");

Shouldn't this be dev_err?

Ack - I will correct

<snip>

Quoted 15 lines

drivers/platform/x86/thinkpad_acpi.c static int tpacpi_dytc_init(struct ibm_init_struct *iibm) · line 10058

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +9 -0
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_mode_available = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			pr_info("DYTC thermal mode configuration available\n");

I would argue this isn't useful to most people.
1) You should decrease this to debug for use with dynamic debugging
2) Output in the log what integer value you returned back in case of a need to identify future firmware bugs.

Agreed on both fronts. I will fix.

Quoted 5 lines

drivers/platform/x86/thinkpad_acpi.c static int tpacpi_dytc_init(struct ibm_init_struct *iibm) · line 10059

Quoted 2 lines
drivers/platform/x86/thinkpad_acpi.c +1 -0
+			dytc_mode_available = true;

I think you shouldn't set this flag until after the group is actually created.

Agreed. I will fix

Thanks for the feedback - very much appreciated.

Mark

A message that is not in the archive (sent off-list or not yet received): b79e0359-536d-f496-a01e-fe4c4b7796cc-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#43 lore raw

Re: [External] RE: [PATCH] platform/x86: thinkpad_acpi: performance mode interface

Quoted 19 lines · Mario

<snip>

Quoted 16 lines
Quoted 12 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced

firmware to

Documentation/admin-guide/laptops/thinkpad-acpi.rst +4 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provide a
Quoted 2 lines

better
+interface for user space to use

So is userspace also notified in some way when you use the hotkey to change,

Quoted 6 lines

or

Quoted 1 line

is the event usurped by the EC? Is this by the event

TP_HKEY_EV_THM_CSM_COMPLETED?

Quoted 1 line

I haven't added that yet - my aim with this patch was to get the sysfs API available. I'll look at adding the notification.

Yeah I just think touch the kernel/user ABI as atomically as possible
to avoid userspace to have to know 5.9 behaves this way and you need to poll for a value and 5.10 you get a notification etc.

Quoted 8 lines
Quoted 3 lines

You might consider to mention what other interfaces will conflict with this and document them and/or artificially block them when this is loaded to

prevent

Quoted 1 line

such a conflict.

I'm afraid I don't know what other interface will be conflicted with. Is there anything in particular I should be looking for? What did you have in mind?

Since it's not mentioned I can only guess your firmware implementation associated with this code. I would think for example that touching some PLx related MSR or possibly RAPL interface might cause unexpected behaviors.

Assuming that's right kernel lockdown might prevent some of the MSR, but if you really want user fully in control of this decision by one knob, you shouldn't let common userspace tools like thermald, tuned, tlp or the like touch the related objects.

Quoted 5 lines

The firmware is operating by default and this patch is just providing user space with a way of determining the current mode and changing it by an alternate mechanism than hotkeys (I know some people dislike the hotkeys...)

In which case if the firmware preference is that it's user control, I think all the more reason to block out those other things while offering this interface.

Quoted 14 lines
Quoted 2 lines

<snip>

Quoted 2 lines

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+The sysfs entry provides the ability to return the current status and to

set

Quoted 8 lines

Documentation/admin-guide/laptops/thinkpad-acpi.rst determine if the sensor is not installed or not. On these platforms the · line 1502

Quoted 6 lines

the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +5 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode

Doesn't this need ABI documentation submitted as part of the patch?

Quoted 3 lines

OK - I'll need some help here as I'm not sure what I missed. Isn't that what this part of the patch is covering? If you can give me some pointers for what I should be putting where I'll do that.

I think it's common to document how your sysfs attributes work in a file in Documentation/ABI/testing. You can look at the format for some others for examples.

Quoted 55 lines
Quoted 1 line

<snip>

Quoted 10 lines
Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +8 -0
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset command */
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the commands we do

*/

drivers/platform/x86/thinkpad_acpi.c +1 -0
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static int dytc_command(int command, int *output) · line 9901

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL first*/
+			err = dytc_command(0x000F1001 /*Disable CQL*/, &output);

Why not put 0x000F1001 and 0x001F1001 as defines at the top?

Fair point - I will fix that.

Quoted 1 line

<snip>

Quoted 12 lines
Quoted 12 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return snprintf(buf, PAGE_SIZE, "Medium (Reduced as lapmode

active)\n");

drivers/platform/x86/thinkpad_acpi.c +5 -0
+		else
+			return snprintf(buf, PAGE_SIZE, "High\n");
+	case DYTC_MODE_QUIET:
+		return snprintf(buf, PAGE_SIZE, "Low\n");
+	case DYTC_MODE_BALANCE:
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static void dytc_lapmode_refresh(void) · line 9972

Quoted 5 lines
drivers/platform/x86/thinkpad_acpi.c +5 -0
+		return snprintf(buf, PAGE_SIZE, "Medium\n");
+	default:
+		return snprintf(buf, PAGE_SIZE, "Unknown (%d)\n", perfmode);
+	}
+}

I think it's pretty confusing that you write "H/M/L" into this file, but you get back a full string.

The main reason here for the string is the need to let the user know they are operating in medium mode even though high has been configured - because the device is on their lap.
My thinking was you can parse the first letter to get H/M/L but more information is available for the subtleties.
I considered another letter but couldn't determine something that was obvious to a user (Lower case 'h' is my best candidate?) and decided a string was nicer.

Quoted 1 line

I'd appreciate input from others as to the best thing to provide here.

My own personal opinion (and there may be others that offer different view so don't take it authoritative):

If you're offering High/Medium/Low, you should accept an input of High/Medium/Low. If you offer H/M/L you should accept H/M/L.

A good way to indicate the reduced mode would be to add an asterisk for medium. So it could be:
Write: H/M/L
Read: H/M*/M/L

The actual decoding of the information can be placed in that Documentation file I mentioned above. In general a userspace tool will be making this pretty and translated I would guess, so no need to do High versus high or Foo (bar) when it could be Foo*

Quoted 45 lines
Quoted 19 lines
Quoted 19 lines
drivers/platform/x86/thinkpad_acpi.c +17 -0
+
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
Quoted 8 lines

drivers/platform/x86/thinkpad_acpi.c static void dytc_lapmode_refresh(void) · line 9995

Quoted 6 lines
drivers/platform/x86/thinkpad_acpi.c +6 -0
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");

Shouldn't this be dev_err?

Ack - I will correct

<snip>

Quoted 15 lines

drivers/platform/x86/thinkpad_acpi.c static int tpacpi_dytc_init(struct ibm_init_struct *iibm) · line 10058

Quoted 10 lines
drivers/platform/x86/thinkpad_acpi.c +9 -0
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_mode_available = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			pr_info("DYTC thermal mode configuration available\n");

I would argue this isn't useful to most people.
1) You should decrease this to debug for use with dynamic debugging
2) Output in the log what integer value you returned back in case of a need to identify future firmware bugs.

Quoted 1 line

Agreed on both fronts. I will fix.

Similar to the pr_err vs dev_err, make sure you use the dev_dbg here instead of pr_dbg.

Quoted 10 lines
Quoted 5 lines

drivers/platform/x86/thinkpad_acpi.c static int tpacpi_dytc_init(struct ibm_init_struct *iibm) · line 10059

Quoted 3 lines
drivers/platform/x86/thinkpad_acpi.c +1 -0
+			dytc_mode_available = true;

I think you shouldn't set this flag until after the group is actually

created.

Quoted 1 line

Agreed. I will fix

Thanks for the feedback - very much appreciated.

Sure thing.

A message that is not in the archive (sent off-list or not yet received): DM6PR19MB26360DE8FCA56BC132644F98FA790-JELcaX3dgTY1BKDJOnGuQNvXXbHMiUzJvxpqHgZTriW3zl9H0oFU5g@public.gmane.org

#45 lore raw

Re: [External] RE: [PATCH] platform/x86: thinkpad_acpi: performance mode interface

Quoted 21 lines · Mario
Quoted 21 lines · Mario

<snip>

Quoted 16 lines
Quoted 12 lines
(quoted diff) +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced

firmware to

(quoted diff) +4 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provide a
Quoted 2 lines

better
+interface for user space to use

So is userspace also notified in some way when you use the hotkey to change,

or

Quoted 1 line

is the event usurped by the EC? Is this by the event

Quoted 9 lines
Quoted 4 lines

TP_HKEY_EV_THM_CSM_COMPLETED?

Quoted 1 line

I haven't added that yet - my aim with this patch was to get the sysfs API available. I'll look at adding the notification.

Yeah I just think touch the kernel/user ABI as atomically as possible
to avoid userspace to have to know 5.9 behaves this way and you need to poll for a value and 5.10 you get a notification etc.

OK - fair point. I'll look into implementing that as well.

Quoted 9 lines
Quoted 8 lines
Quoted 3 lines

You might consider to mention what other interfaces will conflict with this and document them and/or artificially block them when this is loaded to

prevent

Quoted 1 line

such a conflict.

I'm afraid I don't know what other interface will be conflicted with. Is there anything in particular I should be looking for? What did you have in mind?

Quoted 8 lines

Since it's not mentioned I can only guess your firmware implementation associated with this code. I would think for example that touching some PLx related MSR or possibly RAPL interface might cause unexpected behaviors.

Assuming that's right kernel lockdown might prevent some of the MSR, but if you really want user fully in control of this decision by one knob, you shouldn't let common userspace tools like thermald, tuned, tlp or the like touch the related objects.

Hmmm - I think I disagree here.

I don't think this should control what other userspace tools (like thermald) want to do with the CPU registers. Adding hooks into those other pieces of code also seems to me to be complicated and unnecessary in the kernel (and way beyond the scope of this patch). As an aside - my experience from testing is that thermald will override what the firmware is doing anyway.

I can see the value of adding a feature to *disable* the Lenovo firmware implementation as that doesn't currently exist. I will talk to the firmware team and see what can be done and take that on as a separate task. If there's a mechanism to do that already in a safe way then I'll add that to this.

Quoted 8 lines
Quoted 5 lines

The firmware is operating by default and this patch is just providing user space with a way of determining the current mode and changing it by an alternate mechanism than hotkeys (I know some people dislike the hotkeys...)

In which case if the firmware preference is that it's user control, I think all the more reason to block out those other things while offering this interface.

Covered above

Quoted 15 lines
Quoted 15 lines
Quoted 3 lines

<snip>

Quoted 2 lines

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+The sysfs entry provides the ability to return the current status and to

set

Quoted 8 lines

Review

Quoted 6 lines

the

(quoted diff) +5 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode

Doesn't this need ABI documentation submitted as part of the patch?

Quoted 7 lines
Quoted 3 lines

OK - I'll need some help here as I'm not sure what I missed. Isn't that what this part of the patch is covering? If you can give me some pointers for what I should be putting where I'll do that.

I think it's common to document how your sysfs attributes work in a file in Documentation/ABI/testing. You can look at the format for some others for examples.

Ah - that was new to me. Thanks. I'm guessing I need to add a new sysfs-devices-platform-thinkpad_acpi file there. Strange there's not one already :)

Quoted 61 lines
Quoted 56 lines
Quoted 2 lines

<snip>

Quoted 10 lines
Quoted 10 lines
(quoted diff) +8 -0
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset command */
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the commands we do

*/

(quoted diff) +1 -0
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
Quoted 8 lines

Review

Quoted 6 lines
(quoted diff) +6 -0
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL first*/
+			err = dytc_command(0x000F1001 /*Disable CQL*/, &output);

Why not put 0x000F1001 and 0x001F1001 as defines at the top?

Fair point - I will fix that.

Quoted 1 line

<snip>

Quoted 12 lines
Quoted 12 lines
(quoted diff) +6 -0
+
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return snprintf(buf, PAGE_SIZE, "Medium (Reduced as lapmode

active)\n");

(quoted diff) +5 -0
+		else
+			return snprintf(buf, PAGE_SIZE, "High\n");
+	case DYTC_MODE_QUIET:
+		return snprintf(buf, PAGE_SIZE, "Low\n");
+	case DYTC_MODE_BALANCE:
Quoted 8 lines

Review

Quoted 5 lines
(quoted diff) +5 -0
+		return snprintf(buf, PAGE_SIZE, "Medium\n");
+	default:
+		return snprintf(buf, PAGE_SIZE, "Unknown (%d)\n", perfmode);
+	}
+}

I think it's pretty confusing that you write "H/M/L" into this file, but you get back a full string.

The main reason here for the string is the need to let the user know they are operating in medium mode even though high has been configured - because the device is on their lap.
My thinking was you can parse the first letter to get H/M/L but more information is available for the subtleties.
I considered another letter but couldn't determine something that was obvious to a user (Lower case 'h' is my best candidate?) and decided a string was nicer.

Quoted 1 line

I'd appreciate input from others as to the best thing to provide here.

My own personal opinion (and there may be others that offer different view so don't take it authoritative):

Quoted 7 lines

If you're offering High/Medium/Low, you should accept an input of High/Medium/Low. If you offer H/M/L you should accept H/M/L.

A good way to indicate the reduced mode would be to add an asterisk for medium. So it could be:
Write: H/M/L
Read: H/M*/M/L

I like this. Unless someone jumps in and says otherwise I'm good to switch to this.

Quoted 5 lines

The actual decoding of the information can be placed in that Documentation file I mentioned above. In general a userspace tool will be making this pretty and translated I would guess, so no need to do High versus high or Foo (bar) when it could be Foo*

Ack

Quoted 63 lines
Quoted 45 lines
Quoted 19 lines
Quoted 19 lines
(quoted diff) +17 -0
+
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
Quoted 8 lines

Review

Quoted 6 lines
(quoted diff) +6 -0
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");

Shouldn't this be dev_err?

Ack - I will correct

<snip>

Quoted 15 lines

Review

Quoted 10 lines
(quoted diff) +9 -0
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_mode_available = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			pr_info("DYTC thermal mode configuration available\n");

I would argue this isn't useful to most people.
1) You should decrease this to debug for use with dynamic debugging
2) Output in the log what integer value you returned back in case of a need to identify future firmware bugs.

Quoted 1 line

Agreed on both fronts. I will fix.

Similar to the pr_err vs dev_err, make sure you use the dev_dbg here instead of pr_dbg.

Quoted 10 lines
Quoted 5 lines

Review

Quoted 3 lines
(quoted diff) +1 -0
+			dytc_mode_available = true;

I think you shouldn't set this flag until after the group is actually

created.

Quoted 1 line

Agreed. I will fix

Thanks for the feedback - very much appreciated.

Sure thing.

A message that is not in the archive (sent off-list or not yet received): e14aa227-493b-4206-eaef-81874512166f-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#47 lore raw

Re: [External] RE: [PATCH] platform/x86: thinkpad_acpi: performance mode interface

Quoted 14 lines
Quoted 2 lines

Since it's not mentioned I can only guess your firmware implementation

associated

Quoted 1 line

with this code. I would think for example that touching some PLx related

MSR or

Quoted 3 lines

possibly RAPL interface might cause unexpected behaviors.

Assuming that's right kernel lockdown might prevent some of the MSR, but

if you really

Quoted 1 line

want user fully in control of this decision by one knob, you shouldn't

let common

Quoted 1 line

userspace tools like thermald, tuned, tlp or the like touch the related

objects.

Quoted 1 line
Quoted 8 lines

Hmmm - I think I disagree here.

I don't think this should control what other userspace tools (like thermald) want to do with the CPU registers. Adding hooks into those other pieces of code also seems to me to be complicated and unnecessary in the kernel (and way beyond the scope of this patch). As an aside - my experience from testing is that thermald will override what the firmware is doing anyway.

I'm actually in agreement it is potentially quite complicated and shouldn't be in this specific patch. I was going to suggest it should either come as other patches, or perhaps in documentation along the lines of "Users using this interface should not use other tools to modify X, Y and Z". No need to mention the actual tools, but you should try to help prevent users shooting themselves in the foot unintentionally.

Quoted 6 lines

I can see the value of adding a feature to *disable* the Lenovo firmware implementation as that doesn't currently exist. I will talk to the firmware team and see what can be done and take that on as a separate task. If there's a mechanism to do that already in a safe way then I'll add that to this.

This is actually even better to me. Back to the H/M/L approach if you can have an extra one for "off" then userspace tools that want to control the same levers can turn this off when they are taking control.

#48 lore raw

PATCH v2 1/1 platform/x86: thinkpad_acpi: psensor interface

In reply to a message not in the archive

Some Lenovo Thinkpad platforms are equipped with a 'palm sensor' so as to be able to determine if a user is physically proximate to the device.

This patch provides the ability to retrieve the psensor state via sysfs entrypoints and will be used by userspace for WWAN functionality to control the transmission level safely

---
Changes in v2:
- addressed formatting and coding style errors identified during review

 drivers/platform/x86/thinkpad_acpi.c | 107 ++++++++++++++++++++++++++-
 1 file changed, 104 insertions(+), 3 deletions(-)
drivers/platform/x86/thinkpad_acpi.c +104 -3
index 4864a5c189d4..41b75dd4755c 100644
@@ -4079,10 +4079,9 @@ static bool hotkey_notify_6xxx(const u32 hkey,
 
 	case TP_HKEY_EV_PALM_DETECTED:
 	case TP_HKEY_EV_PALM_UNDETECTED:
-		/* palm detected hovering the keyboard, forward to user-space
-		 * via netlink for consumption */
+		/* palm detected - pass on to event handler */
+		tpacpi_driver_event(hkey);
 		return true;
-
 	default:
 		/* report simply as unknown, no sensor dump */
 		return false;
@@ -9916,6 +9915,99 @@ static struct ibm_struct dytc_driver_data = {
 	.exit = dytc_exit,
 };
 
+/**********************************************************************
+ * Palm sensor subdriver
+ */
+
+#define PSENSOR_PRESENT_BIT 0 /* Determine if psensor present */
+#define PSENSOR_ON_BIT      1 /* psensor status */
+
+static bool psensor_state;
+
+static void psensor_notify_change(void)
+{
+	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "psensor_state");
+}
+
+static int psensor_get(bool *state)
+{
+	acpi_handle psensor_handle;
+	int output;
+
+	if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS", &psensor_handle)))
+		return -ENODEV;
+
+	if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
+		return -EIO;
+
+	/* Check if sensor has a Psensor */
+	if (!(output & BIT(PSENSOR_PRESENT_BIT)))
+		return -ENODEV;
+
+	/* Return if psensor is set or not */
+	*state = output & BIT(PSENSOR_ON_BIT) ? true : false;
+	return 0;
+}
+
+static void psensor_state_refresh(void)
+{
+	bool new_state;
+	int err;
+
+	err = psensor_get(&new_state);
+	if (err || (new_state == psensor_state))
+		return;
+
+	psensor_state = new_state;
+	psensor_notify_change();
+}
+
+/* sysfs psensor entry */
+static ssize_t psensor_state_show(struct device *dev,
+					struct device_attribute *attr,
+					char *buf)
+{
+	return sprintf(buf, "%d\n", psensor_state);
+}
+static DEVICE_ATTR_RO(psensor_state);
+
+static struct attribute *psensor_attributes[] = {
+	&dev_attr_psensor_state.attr,
+	NULL
+};
+
+static const struct attribute_group psensor_attr_group = {
+	.attrs = psensor_attributes,
+};
+
+static int tpacpi_psensor_init(struct ibm_init_struct *iibm)
+{
+	int err;
+
+	err = psensor_get(&psensor_state);
+	/*
+	 * If support isn't available (ENODEV) then don't return an error,
+	 * just don't create the sysfs group.
+	 */
+	if (err == -ENODEV)
+		return 0;
+	/* For all other errors we can flag the failure */
+	if (err)
+		return err;
+
+	return sysfs_create_group(&tpacpi_pdev->dev.kobj, &psensor_attr_group);
+}
+
+static void psensor_exit(void)
+{
+	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &psensor_attr_group);
+}
+
+static struct ibm_struct psensor_driver_data = {
+	.name = "psensor",
+	.exit = psensor_exit,
+};
+
 /****************************************************************************
  ****************************************************************************
  *
@@ -9967,6 +10059,10 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
 	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
 		dytc_lapmode_refresh();
 
+	if ((hkey_event == TP_HKEY_EV_PALM_DETECTED) ||
+		(hkey_event == TP_HKEY_EV_PALM_UNDETECTED))
+		psensor_state_refresh();
+
 }
 
 static void hotkey_driver_event(const unsigned int scancode)
@@ -10409,6 +10505,11 @@ static struct ibm_init_struct ibms_init[] __initdata = {
 		.init = tpacpi_dytc_init,
 		.data = &dytc_driver_data,
 	},
+	{
+		.init = tpacpi_psensor_init,
+		.data = &psensor_driver_data,
+	},
+
 };
 
 static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
Signature · 1 line
2.26.2
#49 lore raw

PATCH v3 1/1 platform/x86: thinkpad_acpi: psensor interface

In reply to a message not in the archive

Some Lenovo Thinkpad platforms are equipped with a 'palm sensor' so as to be able to determine if a user is physically proximate to the device.

This patch provides the ability to retrieve the psensor state via sysfs entrypoints and will be used by userspace for WWAN functionality to control the transmission level safely

---
Changes in v2:
- addressed formatting and coding style errors identified during review
Changes in v3:
- I had missed updating thinkpad-acpi.rst in the v2 update so adding that back so it is correct.

 .../admin-guide/laptops/thinkpad-acpi.rst     |  18 +++
 drivers/platform/x86/thinkpad_acpi.c          | 107 +++++++++++++++++-
 2 files changed, 122 insertions(+), 3 deletions(-)
Documentation/admin-guide/laptops/thinkpad-acpi.rst +18 -0
index 5e477869df18..6b57c52d8f13 100644
@@ -51,6 +51,7 @@ detailed description):
 	- UWB enable and disable
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
+        - Palm sensor (aka psensor)
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1447,6 +1448,23 @@ they differ between desk and lap mode.
 The property is read-only. If the platform doesn't have support the sysfs
 class is not created.
 
+Palm sensor
+------------------
+
+sysfs: psensor_state
+
+Certain thinkpads and mobile workstations are equipped with a palm sensor to
+detect when a user is physically near the device. This device, when present,
+is used in conjunction with the lapmode sensor to decide if WWAN transmission
+can be increased to maximum power.
+
+The property is read-only. If the platform doesn't have support the sysfs
+class is not created.
+
+Note - some platforms have a limitation whereby the EC firmware cannot
+determine if the sensor is installed or not. On these platforms the psensor
+state will always be reported as true to avoid high power being used incorrectly.
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +104 -3

132 lines not on this page · raw message

Signature · 1 line
2.26.2
#50 lore raw

PATCH v2 1/1 platform/x86: thinkpad_acpi: performance mode interface

In reply to a message not in the archive

Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to provide different performance/thermal modes.

The modes can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the operating mode between three different modes.

H - High performance. Maximum power is available and the temperature is allowed to increase to the maximum for the platform.
M - Medium performance (aka balance). In this mode power will be limited and the laptop will have a lower maximum temperature.
L - Low performance (aka quiet). In this mode power consumption is reduced and the device will be cooler.

High performance mode is only available when the device is in 'desk mode'. If the device detects that it is on a lap then it will automatically drop into medium mode to maintain a safer operating temperature.

This patch provides an interface to determine the current mode and to also allow the setting of the mode through the dytc_perfmode sysfs entry. This can be used by userspace for improved control.

---
Changes in v2:
- Add userspace notification to hkey event handler. Note this got somewhat more complicated than expected as retrieving the performance mode when in lapmode generates an event itself; added a flag to ignore these known events.
- Updated the values returned to be simpler (H/M*/M/L) as suggested.
- Added ABI documentation as requested. Lap and palm sensor details added whilst I was doing this.
- Cleaned up code based on recommendations as well as feedback received from other patch reviews.
- Based on discussion with firmware team the lapmode sensor should only be made available for DYTC v5 and later. Added this to init logic.

 .../sysfs-devices-platform-thinkpad_acpi      |  34 +++
 .../admin-guide/laptops/thinkpad-acpi.rst     |  35 +++
 drivers/platform/x86/thinkpad_acpi.c          | 267 ++++++++++++++++--
 3 files changed, 310 insertions(+), 26 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi
Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +34 -0
new file mode 100644
index 000000000000..28f07753a889
@@ -0,0 +1,34 @@
+What:		/sys/devices/platform/thinkpad_acpi/dytc_perfmode
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads return the current performance mode setting configured in firmware using
+		the below nomenclature.
+
+		Writes configure the performance mode setting by using the below nomenclature.
+
+		H  - High performance mode. Maximum power and temperature available.
+		M* - High performance mode but performance is limited to medium as system is
+		     in lapmode. Power and temperature maximums reduced to a safe threshold.
+		M  - Medium performance mode (aka 'balance'). Lower maximum power and temperatures
+		     but better battery life.
+		L  - Low performance mode (aka 'quiet'). Reduced power setting gives lower
+		     temperatures and extended battery life. Fans run quieter.
+
+What:		/sys/devices/platform/thinkpad_acpi/dytc_lapmode
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads returns the current value of the lapmode sensor.
+
+		0 - desk mode is detected
+		1 - lap mode is detected
+
+What:		/sys/devices/platform/thinkpad_acpi/psensor_state
+Date:		August 2020
+Contact:	Nitin Joshi <[email protected]>
+Description:
+		Reads returns the current value of the palm sensor.
+
+		0 - palm not detected
+		1 - palm detected
Documentation/admin-guide/laptops/thinkpad-acpi.rst +35 -0
index 6b57c52d8f13..b98f0de9e063 100644
@@ -52,6 +52,7 @@ detailed description):
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
         - Palm sensor (aka psensor)
+	- Thermal mode status and control
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1465,6 +1466,40 @@ Note - some platforms have a limitation whereby the EC firmware cannot
 determine if the sensor is installed or not. On these platforms the psensor
 state will always be reported as true to avoid high power being used incorrectly.
 
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provides a better
+interface for user space to use.
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature is
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be limited and
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is reduced and
+the device will be cooler and quieter.
+
+Note: High performance mode is only available when the device is in 'deskmode'. If
+the device detects that it is on a lap then it will automatically drop into medium
+mode to maintain a safer operating temperature.
+
+The sysfs entry provides the ability to return the current status and to set the
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+
 EXPERIMENTAL: UWB
 -----------------
 
drivers/platform/x86/thinkpad_acpi.c +241 -26

331 lines not on this page · raw message

Signature · 1 line
2.26.2

A message that is not in the archive (sent off-list or not yet received): 20200821175310.335873-1-markpearson-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#52 lore raw

Re: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Quoted 24 lines

Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to provide different performance/thermal modes.

The modes can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the operating mode between three different modes.

H - High performance. Maximum power is available and the temperature is allowed to increase to the maximum for the platform.
M - Medium performance (aka balance). In this mode power will be limited and the laptop will have a lower maximum temperature.
L - Low performance (aka quiet). In this mode power consumption is reduced and the device will be cooler.

High performance mode is only available when the device is in 'desk mode'. If the device detects that it is on a lap then it will automatically drop into medium mode to maintain a safer operating temperature.

This patch provides an interface to determine the current mode and to also allow the setting of the mode through the dytc_perfmode sysfs entry. This can be used by userspace for improved control.

Quoted 13 lines

---
Changes in v2:
- Add userspace notification to hkey event handler. Note this got somewhat more complicated than expected as retrieving the performance mode when in lapmode generates an event itself; added a flag to ignore these known events.
- Updated the values returned to be simpler (H/M*/M/L) as suggested.
- Added ABI documentation as requested. Lap and palm sensor details added whilst I was doing this.
- Cleaned up code based on recommendations as well as feedback received from other patch reviews.
- Based on discussion with firmware team the lapmode sensor should only be made available for DYTC v5 and later. Added this to init logic.

Thanks for adapting a lot of my feedback, this looks much better to me.

Quoted 109 lines
 .../sysfs-devices-platform-thinkpad_acpi      |  34 +++
 .../admin-guide/laptops/thinkpad-acpi.rst     |  35 +++
 drivers/platform/x86/thinkpad_acpi.c          | 267 ++++++++++++++++--
 3 files changed, 310 insertions(+), 26 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-

thinkpad_acpi

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +5 -0
new file mode 100644
index 000000000000..28f07753a889
@@ -0,0 +1,34 @@
+What:		/sys/devices/platform/thinkpad_acpi/dytc_perfmode
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads return the current performance mode setting configured in

firmware using

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +3 -0
+		the below nomenclature.
+
+		Writes configure the performance mode setting by using the below

nomenclature.

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +2 -0
+
+		H  - High performance mode. Maximum power and temperature

available.

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +1 -0
+		M* - High performance mode but performance is limited to medium as

system is

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +1 -0
+		     in lapmode. Power and temperature maximums reduced to a safe

threshold.

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +1 -0
+		M  - Medium performance mode (aka 'balance'). Lower maximum power

and temperatures

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +2 -0
+		     but better battery life.
+		L  - Low performance mode (aka 'quiet'). Reduced power setting

gives lower

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +19 -0
+		     temperatures and extended battery life. Fans run quieter.
+
+What:		/sys/devices/platform/thinkpad_acpi/dytc_lapmode
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads returns the current value of the lapmode sensor.
+
+		0 - desk mode is detected
+		1 - lap mode is detected
+
+What:		/sys/devices/platform/thinkpad_acpi/psensor_state
+Date:		August 2020
+Contact:	Nitin Joshi <[email protected]>
+Description:
+		Reads returns the current value of the palm sensor.
+
+		0 - palm not detected
+		1 - palm detected
Documentation/admin-guide/laptops/thinkpad-acpi.rst +1 -0
index 6b57c52d8f13..b98f0de9e063 100644
@@ -52,6 +52,7 @@ detailed description):
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
         - Palm sensor (aka psensor)
+	- Thermal mode status and control
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1465,6 +1466,40 @@ Note - some platforms have a limitation whereby the EC

firmware cannot
determine if the sensor is installed or not. On these platforms the psensor state will always be reported as true to avoid high power being used
incorrectly.

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced

firmware to

Documentation/admin-guide/laptops/thinkpad-acpi.rst +4 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provides a

better

Documentation/admin-guide/laptops/thinkpad-acpi.rst +11 -0
+interface for user space to use.
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature is
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be limited and
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is reduced

and

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+the device will be cooler and quieter.
+
+Note: High performance mode is only available when the device is in

'deskmode'. If
+the device detects that it is on a lap then it will automatically drop into medium

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+mode to maintain a safer operating temperature.
+
+The sysfs entry provides the ability to return the current status and to set

the

Documentation/admin-guide/laptops/thinkpad-acpi.rst Note - some platforms have a limitation whereby the EC firmware cannot · line 1502

Quoted 6 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+

I was thinking about this some more, do you actually want another mode that "disables"
this feature? IE "O" turns it off an calls DYTC_DISABLE_CQL.

For example if a user wanted to test the recently landed code in thermald 2.3 and compare performance between the two it seems like this and that "might" fight. As an outsider looking in - I of course may be wrong too here.

If at some point in the future thermald does a better job than this implementation you might also want an "out" to let thermald or another piece of userland turn this off if it's in the picture.

Quoted 352 lines

EXPERIMENTAL: UWB
-----------------

drivers/platform/x86/thinkpad_acpi.c +113 -7
index 41b75dd4755c..8fcb660aa5a2 100644
@@ -9817,18 +9817,43 @@ static struct ibm_struct lcdshadow_driver_data = {
 };
 
 /*************************************************************************
- * DYTC subdriver, for the Lenovo lapmode feature
+ * DYTC subdriver, for the Lenovo lap and performance mode feature
  */
 
+#define DYTC_CMD_QUERY        0 /* To get DYTC status - enable/revision */
+#define DYTC_CMD_SET          1 /* To enable/disable IC function mode */
 #define DYTC_CMD_GET          2 /* To get current IC function and mode */
-#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+#define DYTC_CMD_RESET    0x1ff /* To reset back to default */
 
-static bool dytc_lapmode;
+#define DYTC_QUERY_ENABLE_BIT 8  /* Bit 8 - 0 = disabled, 1 = enabled */
+#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revisision */
+#define DYTC_QUERY_REV_BIT    28 /* Bits 28 - 31 - revision */
 
-static void dytc_lapmode_notify_change(void)
-{
-	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
-}
+#define DYTC_GET_FUNCTION_BIT 8  /* Bits 8-11 - function setting */
+#define DYTC_GET_MODE_BIT     12 /* Bits 12-15 - mode setting */
+#define DYTC_GET_LAPMODE_BIT  17 /* Bit 17 - lapmode. Set when on lap */
+
+#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - funct setting */
+#define DYTC_SET_MODE_BIT     16 /* Bits 16-19 - mode setting */
+#define DYTC_SET_VALID_BIT    20 /* Bit 20 - 1 = on, 0 = off */
+
+#define DYTC_FUNCTION_STD     0  /* Function = 0, standard mode */
+#define DYTC_FUNCTION_CQL     1  /* Function = 1, lap mode */
+#define DYTC_FUNCTION_MMC     11 /* Function = 11, desk mode */
+
+#define DYTC_MODE_PERFORM     2  /* High power mode aka performance */
+#define DYTC_MODE_QUIET       3  /* low power mode aka quiet */
+#define DYTC_MODE_BALANCE   0xF  /* default mode aka balance */
+
+#define DYTC_DISABLE_CQL ((DYTC_MODE_BALANCE << DYTC_SET_MODE_BIT) | \
+		(DYTC_FUNCTION_CQL << DYTC_SET_FUNCTION_BIT) | \
+		DYTC_CMD_SET)
+#define DYTC_ENABLE_CQL (DYTC_DISABLE_CQL | (1 << DYTC_SET_VALID_BIT))
+
+static bool dytc_lapmode;
+static int  dytc_perfmode;
+static bool dytc_available;
+static bool dytc_ignore_next_event;
 
 static int dytc_command(int command, int *output)
 {
@@ -9843,6 +9868,87 @@ static int dytc_command(int command, int *output)
 	return 0;
 }
 
+static int dytc_perfmode_get(int *perfmode, int *funcmode)
+{
+	int output, err;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	err = dytc_command(DYTC_CMD_GET, &output);
+	if (err)
+		return err;
+	*funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
+
+	if (*funcmode == DYTC_FUNCTION_CQL) {
+		int dummy;
+		/*
+		 * We can't get the mode when in CQL mode - so we disable CQL
+		 * mode retrieve the mode and then enable it again.
+		 * As disabling/enabling CQL triggers an event we set a flag to
+		 * ignore these events. This will be cleared by the event handler
+		 */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_DISABLE_CQL, &dummy);
+		if (err)
+			return err;
+		err = dytc_command(DYTC_CMD_GET, &output);
+		if (err)
+			return err;
+		/* Again ignore this event */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_ENABLE_CQL, &dummy);
+		if (err)
+			return err;
+	}
+	*perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
+	return 0;
+}
+
+static int dytc_perfmode_set(int perfmode)
+{
+	int err, dytc_set;
+	int output;
+	int cur_perfmode, cur_funcmode;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset command */
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the commands we do
 */
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL first*/
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_DISABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+		dytc_set = (1 << DYTC_SET_VALID_BIT) |
+			(DYTC_FUNCTION_MMC << DYTC_SET_FUNCTION_BIT) |
+			(perfmode << DYTC_SET_MODE_BIT) |
+			DYTC_CMD_SET;
+		err = dytc_command(dytc_set, &output);
+		if (err)
+			return err;
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_ENABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+	}
+	return 0;
+}
+
 static int dytc_lapmode_get(bool *state)
 {
drivers/platform/x86/thinkpad_acpi.c +128 -19
 	int output, err;
@@ -9854,45 +9960,130 @@ static int dytc_lapmode_get(bool *state)
 	return 0;
 }
 
-static void dytc_lapmode_refresh(void)
+static void dytc_refresh(void)
 {
-	bool new_state;
+	bool lapmode;
+	int perfmode, funcmode;
 	int err;
 
-	err = dytc_lapmode_get(&new_state);
-	if (err || (new_state == dytc_lapmode))
+	err = dytc_lapmode_get(&lapmode);
+	if (err)
+		return;
+	if (dytc_ignore_next_event) {
+		dytc_ignore_next_event = false; /*clear setting*/
 		return;
+	}
+	if (lapmode != dytc_lapmode) {
+		dytc_lapmode = lapmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
+	}
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return;
+	if (perfmode != dytc_perfmode) {
+		dytc_perfmode = perfmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_perfmode");
+	}
+}
+
+/* sysfs perfmode entry */
+static ssize_t dytc_perfmode_show(struct device *dev,
+				  struct device_attribute *attr,
+				  char *buf)
+{
+	int err;
+	int perfmode, funcmode;
+
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return err;
 
-	dytc_lapmode = new_state;
-	dytc_lapmode_notify_change();
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return sprintf(buf, "M*\n");
+		else
+			return sprintf(buf, "H\n");
+	case DYTC_MODE_QUIET:
+		return sprintf(buf, "L\n");
+	case DYTC_MODE_BALANCE:
+		return sprintf(buf, "M\n");
+	default:
+		return sprintf(buf, "Unknown (%d)\n", perfmode);
+	}
 }
 
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");
+		break;
+	}
+	if (err)
+		return err;
+
+	tpacpi_disclose_usertask(attr->attr.name,
+				"Performance mode set to %c\n", buf[0]);
+	return count;
+}
+
+static DEVICE_ATTR_RW(dytc_perfmode);
+
+static struct attribute *dytc_perfmode_attributes[] = {
+	&dev_attr_dytc_perfmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_perf_attr_group = {
+	.attrs = dytc_perfmode_attributes
+};
+
 /* sysfs lapmode entry */
 static ssize_t dytc_lapmode_show(struct device *dev,
 					struct device_attribute *attr,
 					char *buf)
 {
-	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+	return sprintf(buf, "%d\n", dytc_lapmode);
 }
 
 static DEVICE_ATTR_RO(dytc_lapmode);
 
-static struct attribute *dytc_attributes[] = {
+static struct attribute *dytc_lap_attributes[] = {
 	&dev_attr_dytc_lapmode.attr,
-	NULL,
+	NULL
 };
 
-static const struct attribute_group dytc_attr_group = {
-	.attrs = dytc_attributes,
+static const struct attribute_group dytc_lap_attr_group = {
+	.attrs = dytc_lap_attributes
 };
 
 static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
 {
-	int err;
+	int err, output;
 
-	err = dytc_lapmode_get(&dytc_lapmode);
-	/* If support isn't available (ENODEV) then don't return an error
-	 * but just don't create the sysfs group
+	err = dytc_command(DYTC_CMD_QUERY, &output);
+	/*
+	 * If support isn't available (ENODEV) then don't return an error
+	 * just don't create the sysfs group
 	 */
 	if (err == -ENODEV)
 		return 0;
@@ -9900,14 +10091,38 @@ static int tpacpi_dytc_init(struct ibm_init_struct
 *iibm)
 	if (err)
 		return err;
 
-	/* Platform supports this feature - create the group */
-	err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_available = false;
+	dytc_ignore_next_event = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			dbg_printk(TPACPI_DBG_INIT,
+				   "DYTC version %d: thermal mode available\n",
 dytc_version);
+			dytc_available = true;
+			/* Platform supports this feature - create the group */
+			err = sysfs_create_group(&tpacpi_pdev->dev.kobj,
 &dytc_perf_attr_group);
+			if (err)
+				return err;
+
+			err = dytc_lapmode_get(&dytc_lapmode);
+			if (err)
+				return err;
+			err = sysfs_create_group(&tpacpi_pdev->dev.kobj,
 &dytc_lap_attr_group);
+		}
+	}
 	return err;
 }
 
 static void dytc_exit(void)
 {
-	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	if (dytc_available) {
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_lap_attr_group);
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_perf_attr_group);
+	}
 }
 
 static struct ibm_struct dytc_driver_data = {
@@ -10057,7 +10272,7 @@ static void tpacpi_driver_event(const unsigned int
 hkey_event)
 	}
 
 	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
-		dytc_lapmode_refresh();
+		dytc_refresh();
 
 	if ((hkey_event == TP_HKEY_EV_PALM_DETECTED) ||

(hkey_event == TP_HKEY_EV_PALM_UNDETECTED))
--
2.26.2

A message that is not in the archive (sent off-list or not yet received): DM6PR19MB2636F1CFCE1E386D6E793E25FA5B0-JELcaX3dgTY1BKDJOnGuQNvXXbHMiUzJvxpqHgZTriW3zl9H0oFU5g@public.gmane.org

#54 lore raw

Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Hi Mario

Quoted 1 line · Mario
Quoted 1 line

<snip>

Quoted 3 lines

Thanks for adapting a lot of my feedback, this looks much better to me.

No problems and genuinely thank you for the feedback. Sorry it took so long to get this update out - PTO and other things got in the way :)

Quoted 1 line
Quoted 1 line

<snip>

Quoted 13 lines

Documentation/admin-guide/laptops/thinkpad-acpi.rst Note - some platforms have a limitation whereby the EC firmware cannot · line 1502

Quoted 9 lines
(quoted diff) +2 -0
+
+The sysfs entry provides the ability to return the current status and to set

the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+

I was thinking about this some more, do you actually want another mode that "disables"
this feature? IE "O" turns it off an calls DYTC_DISABLE_CQL.

Quoted 8 lines

For example if a user wanted to test the recently landed code in thermald 2.3 and compare performance between the two it seems like this and that "might" fight. As an outsider looking in - I of course may be wrong too here.

If at some point in the future thermald does a better job than this implementation you might also want an "out" to let thermald or another piece of userland turn this off if it's in the picture.

I'm still digging into this one. Right now I haven't found a good clean way of just disabling the firmware. Currently when thermald goes in and tweaks the CPU power registers it has the effect of overriding the FW anyway - but I appreciate that's not quite the same as actually doing it explicitly.

I'm still discussing with the BIOS team how to implement this - these conversations take time.... I suspect I'll need a new BIOS API which will take a while to implement and get rolled out. I didn't want to hold up this patch as there are benefits for users in the meantime and Lenovo do plan on supporting the thermal software going forwards. I'm not not dropping the plan to have a disable function as I can see the benefits.

Thanks for the input. Let me know if you want a reviewed-by tag added. I think it's kinda awesome having input from a Dell engineer on a Lenovo related driver and I hope in the future I can provide the same help ;) Open source is awesome.

Mark

A message that is not in the archive (sent off-list or not yet received): 1806c4ec-6788-bcc7-7e09-8e5274d2b9d5-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#56 lore raw

Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Quoted 50 lines

-----Original Message-----
From: [email protected] <platform-driver-x86- [email protected]> On Behalf Of Mark Pearson
Sent: Friday, August 21, 2020 14:36
To: Limonciello, Mario
Cc: [email protected]; [email protected]; [email protected]; [email protected]; Nitin Joshi
Subject: Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi:
performance mode interface

[EXTERNAL EMAIL]

Hi Mario

Quoted 1 line · Mario
Quoted 1 line

<snip>

Quoted 3 lines

Thanks for adapting a lot of my feedback, this looks much better to me.

No problems and genuinely thank you for the feedback. Sorry it took so long to get this update out - PTO and other things got in the way :)

Quoted 1 line
Quoted 1 line

<snip>

Quoted 2 lines

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+The sysfs entry provides the ability to return the current status and to

set

Quoted 9 lines

Documentation/admin-guide/laptops/thinkpad-acpi.rst Note - some platforms have a limitation whereby the EC firmware cannot · line 1502

Quoted 7 lines

the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+

I was thinking about this some more, do you actually want another mode that

"disables"

Quoted 3 lines

this feature? IE "O" turns it off an calls DYTC_DISABLE_CQL.

For example if a user wanted to test the recently landed code in thermald

2.3

Quoted 1 line

and compare performance between the two it seems like this and that "might"

fight.

Quoted 3 lines

As an outsider looking in - I of course may be wrong too here.

If at some point in the future thermald does a better job than this

implementation you

Quoted 1 line

might also want an "out" to let thermald or another piece of userland turn

Quoted 9 lines

this off

Quoted 2 lines

if it's in the picture.

I'm still digging into this one. Right now I haven't found a good clean way of just disabling the firmware. Currently when thermald goes in and tweaks the CPU power registers it has the effect of overriding the FW anyway - but I appreciate that's not quite the same as actually doing it explicitly.

What about a modprobe parameter to disable at least? That would at least make it pretty easy to make a change, reboot and compare with thermald (or other software) without disabling the rest of the functionality of the thinkpad_acpi driver.

Quoted 7 lines

I'm still discussing with the BIOS team how to implement this - these conversations take time.... I suspect I'll need a new BIOS API which will take a while to implement and get rolled out. I didn't want to hold up this patch as there are benefits for users in the meantime and Lenovo do plan on supporting the thermal software going forwards. I'm not not dropping the plan to have a disable function as I can see the benefits.

Yup, well aware how these types of things go.

Quoted 6 lines

Thanks for the input. Let me know if you want a reviewed-by tag added. I think it's kinda awesome having input from a Dell engineer on a Lenovo related driver and I hope in the future I can provide the same help ;) Open source is awesome.

Mark

😊

_______________________________________________
ibm-acpi-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ibm-acpi-devel

A message that is not in the archive (sent off-list or not yet received): DM6PR19MB26369308415B8235B3C9997EFA5B0-JELcaX3dgTY1BKDJOnGuQNvXXbHMiUzJvxpqHgZTriW3zl9H0oFU5g@public.gmane.org

#58 lore raw

Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

On 8/21/2020 4:00 PM, Limonciello, Mario wrote:
<snip>

Quoted 29 lines
Quoted 22 lines
Quoted 17 lines
Quoted 6 lines

+ +The sysfs entry provides the ability to return the current status and to set
the +desired mode. For example:: + + echo H >
/sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo
M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode +

I was thinking about this some more, do you actually want another mode that "disables"
this feature? IE "O" turns it off an calls DYTC_DISABLE_CQL.

For example if a user wanted to test the recently landed code in thermald 2.3
and compare performance between the two it seems like this and that "might" fight.
As an outsider looking in - I of course may be wrong too here.

Quoted 5 lines

If at some point in the future thermald does a better job than this implementation you
might also want an "out" to let thermald or another piece of userland turn this off if it's in the picture.

Quoted 6 lines

I'm still digging into this one. Right now I haven't found a good clean way of just disabling the firmware. Currently when thermald goes in and tweaks the CPU power registers it has the effect of overriding the FW anyway - but I appreciate that's not quite the same as actually doing it explicitly.

Quoted 5 lines

What about a modprobe parameter to disable at least? That would at least make it pretty easy to make a change, reboot and compare with thermald (or other software) without disabling the rest of the functionality of the thinkpad_acpi driver.

The problem is I don't have a good way to disable the firmware (that I know of yet) so a modprobe parameter wouldn't really do much. I guess it could skip providing the sysfs entry points - but the FW will still be there doing it's thing, so I'm not sure I see the benefit of that. At least the sysfs entry point gives a bit more insight into what is going on. Let me know if I'm missing something obvious.

Mark

A message that is not in the archive (sent off-list or not yet received): 9e0c14a9-3b24-4b64-6d9e-b312d28dfd44-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#60 lore raw

Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Quoted 48 lines

-----Original Message-----
From: Mark Pearson <[email protected]>
Sent: Friday, August 21, 2020 15:06
To: Limonciello, Mario
Cc: [email protected]; [email protected]; ibm-acpi-N3TV7GIv+o9fyO9Q7EP/[email protected]; [email protected]; Nitin Joshi
Subject: Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi:
performance mode interface

[EXTERNAL EMAIL]

On 8/21/2020 4:00 PM, Limonciello, Mario wrote:
<snip>

Quoted 29 lines
Quoted 22 lines
Quoted 17 lines
Quoted 6 lines

+ +The sysfs entry provides the ability to return the current status and to set
the +desired mode. For example:: + + echo H >
/sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo
M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode +

I was thinking about this some more, do you actually want another mode that "disables"
this feature? IE "O" turns it off an calls DYTC_DISABLE_CQL.

For example if a user wanted to test the recently landed code in thermald 2.3
and compare performance between the two it seems like this and that "might" fight.
As an outsider looking in - I of course may be wrong too here.

Quoted 5 lines

If at some point in the future thermald does a better job than this implementation you
might also want an "out" to let thermald or another piece of userland turn this off if it's in the picture.

Quoted 6 lines

I'm still digging into this one. Right now I haven't found a good clean way of just disabling the firmware. Currently when thermald goes in and tweaks the CPU power registers it has the effect of overriding the FW anyway - but I appreciate that's not quite the same as actually doing it explicitly.

Quoted 5 lines

What about a modprobe parameter to disable at least? That would at least make it pretty easy to make a change, reboot and compare with thermald (or other software) without disabling the rest of the functionality of the thinkpad_acpi driver.

Quoted 7 lines

The problem is I don't have a good way to disable the firmware (that I know of yet) so a modprobe parameter wouldn't really do much. I guess it could skip providing the sysfs entry points - but the FW will still be there doing it's thing, so I'm not sure I see the benefit of that. At least the sysfs entry point gives a bit more insight into what is going on. Let me know if I'm missing something obvious.

Oh so it's not actually the driver loading tells the firmware it's supposed to work this way. The firmware actually detects "I'm running on Linux, so I'll do this differently"?

A message that is not in the archive (sent off-list or not yet received): DM6PR19MB263621A07F59D91C8E2F7205FA5B0-JELcaX3dgTY1BKDJOnGuQNvXXbHMiUzJvxpqHgZTriW3zl9H0oFU5g@public.gmane.org

#62 lore raw

Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Quoted 31 lines · Mario
Quoted 31 lines

-----Original Message----- From: Mark Pearson <[email protected]> Sent: Friday, August 21, 2020 15:06

On 8/21/2020 4:00 PM, Limonciello, Mario wrote: <snip>

Quoted 27 lines
Quoted 14 lines
Quoted 14 lines
Quoted 6 lines

+ +The sysfs entry provides the ability to return the current status and to set the +desired mode. For example::
+ + echo H >
/sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo M

Quoted 1 line

/sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo

L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode +

I was thinking about this some more, do you actually want another mode that "disables" this feature? IE "O" turns it
off an calls DYTC_DISABLE_CQL.

For example if a user wanted to test the recently landed code
in thermald 2.3 and compare performance between the two it
seems like this and that "might" fight. As an outsider looking in - I of course may be wrong too here.

Quoted 8 lines
Quoted 4 lines

If at some point in the future thermald does a better job than this implementation you might also want an "out" to let
thermald or another piece of userland turn this off if it's
in the picture.

I'm still digging into this one. Right now I haven't found a good clean way of just disabling the firmware. Currently when thermald goes in and tweaks the CPU power registers it has the
effect of overriding the FW anyway - but I appreciate that's
not quite the same as actually doing it explicitly.

What about a modprobe parameter to disable at least? That would
at least make it pretty easy to make a change, reboot and
compare with thermald (or other software) without disabling the rest of the functionality of the thinkpad_acpi driver.

Quoted 8 lines
Quoted 5 lines

The problem is I don't have a good way to disable the firmware (that I know of yet) so a modprobe parameter wouldn't really do much. I guess it could skip providing the sysfs entry points - but
the FW will still be there doing it's thing, so I'm not sure I see
the benefit of that. At least the sysfs entry point gives a bit
more insight into what is going on. Let me know if I'm missing something obvious.

Oh so it's not actually the driver loading tells the firmware it's supposed to work this way. The firmware actually detects "I'm running on Linux, so I'll do this differently"?

Right. This patch is just providing a more friendly interface so user space can see what is going on and be able to do control of the different modes without the need for hotkeys.

Afraid I don't have much insight into the nitty gritty details of exactly how that works - I believe it's related to detecting the use of DPTF but the details aren't shared with me because of NDA's. As a thought it's quite possible (probable?) that if thermald is using DPTF the firmware will automatically disable itself. Proving that might be tricky - I'll see if the firmware team have any ideas.

Mark

A message that is not in the archive (sent off-list or not yet received): 52fc84b9-f87d-c91d-4d24-1db768c5c812-6jq1YtArVR3QT0dZR+AlfA@public.gmane.org

#64 lore raw

Re: [External] RE: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Quoted 55 lines · Mario
Quoted 46 lines
Quoted 37 lines

-----Original Message----- From: Mark Pearson <[email protected]> Sent: Friday, August 21, 2020 15:06

On 8/21/2020 4:00 PM, Limonciello, Mario wrote: <snip>

Quoted 28 lines
Quoted 21 lines
Quoted 16 lines
Quoted 6 lines

+ +The sysfs entry provides the ability to return the current status and to set the +desired mode. For example::
+ + echo H >
/sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo M

Quoted 1 line

/sys/devices/platform/thinkpad_acpi/dytc_perfmode + echo

L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode +

I was thinking about this some more, do you actually want
another mode that "disables" this feature? IE "O" turns it
off an calls DYTC_DISABLE_CQL.

For example if a user wanted to test the recently landed code in thermald 2.3 and compare performance between the two it seems like this and that "might" fight. As an outsider looking in - I of course may be wrong too here.

Quoted 5 lines

If at some point in the future thermald does a better job than this implementation you might also want an "out" to let
thermald or another piece of userland turn this off if it's in the picture.

Quoted 6 lines

I'm still digging into this one. Right now I haven't found a good clean way of just disabling the firmware. Currently when thermald goes in and tweaks the CPU power registers it has the
effect of overriding the FW anyway - but I appreciate that's
not quite the same as actually doing it explicitly.

Quoted 5 lines

What about a modprobe parameter to disable at least? That would
at least make it pretty easy to make a change, reboot and
compare with thermald (or other software) without disabling the rest of the functionality of the thinkpad_acpi driver.

Quoted 8 lines

The problem is I don't have a good way to disable the firmware (that I know of yet) so a modprobe parameter wouldn't really do much. I guess it could skip providing the sysfs entry points - but
the FW will still be there doing it's thing, so I'm not sure I see the benefit of that. At least the sysfs entry point gives a bit
more insight into what is going on. Let me know if I'm missing something obvious.

Quoted 4 lines

Oh so it's not actually the driver loading tells the firmware it's supposed to work this way. The firmware actually detects "I'm running on Linux, so I'll do this differently"?

Right. This patch is just providing a more friendly interface so user space can see what is going on and be able to do control of the different modes without the need for hotkeys.

Quoted 7 lines

Afraid I don't have much insight into the nitty gritty details of exactly how that works - I believe it's related to detecting the use of DPTF but the details aren't shared with me because of NDA's. As a thought it's quite possible (probable?) that if thermald is using DPTF the firmware will automatically disable itself. Proving that might be tricky - I'll see if the firmware team have any ideas.

Right - it's a reverse engineered implementation done in thermald and there are still some missing items. So your comment makes perfect sense to me now, and if/when those other things are added this may change and it will make sense to offer a way to turn this off at that time.

#65 lore raw

Re: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

In reply to a message not in the archive

Hi Mark,

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi line 16

Quoted 7 lines · Mark Pearson
Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +7 -0
+		H  - High performance mode. Maximum power and temperature available.
+		M* - High performance mode but performance is limited to medium as system is
+		     in lapmode. Power and temperature maximums reduced to a safe threshold.
+		M  - Medium performance mode (aka 'balance'). Lower maximum power and temperatures
+		     but better battery life.
+		L  - Low performance mode (aka 'quiet'). Reduced power setting gives lower
+		     temperatures and extended battery life. Fans run quieter.

I tested the patch yesterday and I see some minor issues right now.

First, right now change notifications do not happen for a lapmode change. The sysfs file will switch between "H" and "M*" without any notification. This will be an easy fix.

Second, I personally see the current "M*" more as a degraded performance mode rather than an effective balanced mode. For example, H and M* match in the sense that the machine will be more noisy as fans are turned on more aggressively.

Third, we still have a mismatch when writing the file. i.e. you write "H" but you will read "M*".

So, I am thinking of using H* instead. That means we directly represent the firmwares performance mode rather than making an interpretation about an "effective" state. And with the * we continue to convey that there is a major impact on performance due to other factors.

Benjamin

Quoted 456 lines

+What: /sys/devices/platform/thinkpad_acpi/dytc_lapmod
e

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +9 -0
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads returns the current value of the lapmode sensor.
+
+		0 - desk mode is detected
+		1 - lap mode is detected
+
+What:		/sys/devices/platform/thinkpad_acpi/psensor_sta

te

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +7 -0
+Date:		August 2020
+Contact:	Nitin Joshi <[email protected]>
+Description:
+		Reads returns the current value of the palm sensor.
+
+		0 - palm not detected
+		1 - palm detected
Documentation/admin-guide/laptops/thinkpad-acpi.rst +1 -0
index 6b57c52d8f13..b98f0de9e063 100644
@@ -52,6 +52,7 @@ detailed description):
 	- LCD Shadow (PrivacyGuard) enable and disable
 	- Lap mode sensor
         - Palm sensor (aka psensor)
+	- Thermal mode status and control
 
 A compatibility table by model and feature is maintained on the web
 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1465,6 +1466,40 @@ Note - some platforms have a limitation

whereby the EC firmware cannot
determine if the sensor is installed or not. On these platforms the
psensor
state will always be reported as true to avoid high power being used
incorrectly.

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have

enhanced firmware to

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to

switch the
+operating mode between three different modes. This sysfs node provides a better

Documentation/admin-guide/laptops/thinkpad-acpi.rst +5 -0
+interface for user space to use.
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature

is

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be

limited and

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is

reduced and

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+the device will be cooler and quieter.
+
+Note: High performance mode is only available when the device is in

'deskmode'. If
+the device detects that it is on a lap then it will automatically drop into medium

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+mode to maintain a safer operating temperature.
+
+The sysfs entry provides the ability to return the current status

and to set the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+
 EXPERIMENTAL: UWB
 -----------------
drivers/platform/x86/thinkpad_acpi.c +2 -1
index 41b75dd4755c..8fcb660aa5a2 100644
@@ -9817,18 +9817,43 @@ static struct ibm_struct
 lcdshadow_driver_data = {
 };
 
 /*******************************************************************
 ******
- * DYTC subdriver, for the Lenovo lapmode feature
+ * DYTC subdriver, for the Lenovo lap and performance mode feature
  */
 
+#define DYTC_CMD_QUERY        0 /* To get DYTC status -

enable/revision */
+#define DYTC_CMD_SET 1 /* To enable/disable IC function
mode */
#define DYTC_CMD_GET 2 /* To get current IC function and
mode */

drivers/platform/x86/thinkpad_acpi.c +2 -2
-#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+#define DYTC_CMD_RESET    0x1ff /* To reset back to default */
 
-static bool dytc_lapmode;
+#define DYTC_QUERY_ENABLE_BIT 8  /* Bit 8 - 0 = disabled, 1 =

enabled */

drivers/platform/x86/thinkpad_acpi.c +5 -4
+#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revisision */
+#define DYTC_QUERY_REV_BIT    28 /* Bits 28 - 31 - revision */
 
-static void dytc_lapmode_notify_change(void)
-{
-	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
-}
+#define DYTC_GET_FUNCTION_BIT 8  /* Bits 8-11 - function setting */
+#define DYTC_GET_MODE_BIT     12 /* Bits 12-15 - mode setting */
+#define DYTC_GET_LAPMODE_BIT  17 /* Bit 17 - lapmode. Set when on

lap */

drivers/platform/x86/thinkpad_acpi.c +10 -0
+
+#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - funct setting */
+#define DYTC_SET_MODE_BIT     16 /* Bits 16-19 - mode setting */
+#define DYTC_SET_VALID_BIT    20 /* Bit 20 - 1 = on, 0 = off */
+
+#define DYTC_FUNCTION_STD     0  /* Function = 0, standard mode */
+#define DYTC_FUNCTION_CQL     1  /* Function = 1, lap mode */
+#define DYTC_FUNCTION_MMC     11 /* Function = 11, desk mode */
+
+#define DYTC_MODE_PERFORM     2  /* High power mode aka performance

*/

drivers/platform/x86/thinkpad_acpi.c +4 -0
+#define DYTC_MODE_QUIET       3  /* low power mode aka quiet */
+#define DYTC_MODE_BALANCE   0xF  /* default mode aka balance */
+
+#define DYTC_DISABLE_CQL ((DYTC_MODE_BALANCE << DYTC_SET_MODE_BIT) |

\

drivers/platform/x86/thinkpad_acpi.c +3 -0
+		(DYTC_FUNCTION_CQL << DYTC_SET_FUNCTION_BIT) | \
+		DYTC_CMD_SET)
+#define DYTC_ENABLE_CQL (DYTC_DISABLE_CQL | (1 <<

DYTC_SET_VALID_BIT))

drivers/platform/x86/thinkpad_acpi.c +21 -0
+
+static bool dytc_lapmode;
+static int  dytc_perfmode;
+static bool dytc_available;
+static bool dytc_ignore_next_event;
 
 static int dytc_command(int command, int *output)
 {
@@ -9843,6 +9868,87 @@ static int dytc_command(int command, int
 *output)
 	return 0;
 }
 
+static int dytc_perfmode_get(int *perfmode, int *funcmode)
+{
+	int output, err;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	err = dytc_command(DYTC_CMD_GET, &output);
+	if (err)
+		return err;
+	*funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
+
+	if (*funcmode == DYTC_FUNCTION_CQL) {
+		int dummy;
+		/*
+		 * We can't get the mode when in CQL mode - so we

disable CQL

drivers/platform/x86/thinkpad_acpi.c +2 -0
+		 * mode retrieve the mode and then enable it again.
+		 * As disabling/enabling CQL triggers an event we set a

flag to

drivers/platform/x86/thinkpad_acpi.c +1 -0
+		 * ignore these events. This will be cleared by the

event handler

drivers/platform/x86/thinkpad_acpi.c +29 -0
+		 */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_DISABLE_CQL, &dummy);
+		if (err)
+			return err;
+		err = dytc_command(DYTC_CMD_GET, &output);
+		if (err)
+			return err;
+		/* Again ignore this event */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_ENABLE_CQL, &dummy);
+		if (err)
+			return err;
+	}
+	*perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
+	return 0;
+}
+
+static int dytc_perfmode_set(int perfmode)
+{
+	int err, dytc_set;
+	int output;
+	int cur_perfmode, cur_funcmode;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset

command */

drivers/platform/x86/thinkpad_acpi.c +5 -0
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the

commands we do */

drivers/platform/x86/thinkpad_acpi.c +6 -0
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL

first*/

drivers/platform/x86/thinkpad_acpi.c +118 -14
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_DISABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+		dytc_set = (1 << DYTC_SET_VALID_BIT) |
+			(DYTC_FUNCTION_MMC << DYTC_SET_FUNCTION_BIT) |
+			(perfmode << DYTC_SET_MODE_BIT) |
+			DYTC_CMD_SET;
+		err = dytc_command(dytc_set, &output);
+		if (err)
+			return err;
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_ENABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+	}
+	return 0;
+}
+
 static int dytc_lapmode_get(bool *state)
 {
 	int output, err;
@@ -9854,45 +9960,130 @@ static int dytc_lapmode_get(bool *state)
 	return 0;
 }
 
-static void dytc_lapmode_refresh(void)
+static void dytc_refresh(void)
 {
-	bool new_state;
+	bool lapmode;
+	int perfmode, funcmode;
 	int err;
 
-	err = dytc_lapmode_get(&new_state);
-	if (err || (new_state == dytc_lapmode))
+	err = dytc_lapmode_get(&lapmode);
+	if (err)
+		return;
+	if (dytc_ignore_next_event) {
+		dytc_ignore_next_event = false; /*clear setting*/
 		return;
+	}
+	if (lapmode != dytc_lapmode) {
+		dytc_lapmode = lapmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
 "dytc_lapmode");
+	}
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return;
+	if (perfmode != dytc_perfmode) {
+		dytc_perfmode = perfmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
 "dytc_perfmode");
+	}
+}
+
+/* sysfs perfmode entry */
+static ssize_t dytc_perfmode_show(struct device *dev,
+				  struct device_attribute *attr,
+				  char *buf)
+{
+	int err;
+	int perfmode, funcmode;
+
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return err;
 
-	dytc_lapmode = new_state;
-	dytc_lapmode_notify_change();
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return sprintf(buf, "M*\n");
+		else
+			return sprintf(buf, "H\n");
+	case DYTC_MODE_QUIET:
+		return sprintf(buf, "L\n");
+	case DYTC_MODE_BALANCE:
+		return sprintf(buf, "M\n");
+	default:
+		return sprintf(buf, "Unknown (%d)\n", perfmode);
+	}
 }
 
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");
+		break;
+	}
+	if (err)
+		return err;
+
+	tpacpi_disclose_usertask(attr->attr.name,
+				"Performance mode set to %c\n",
 buf[0]);
+	return count;
+}
+
+static DEVICE_ATTR_RW(dytc_perfmode);
+
+static struct attribute *dytc_perfmode_attributes[] = {
+	&dev_attr_dytc_perfmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_perf_attr_group = {
+	.attrs = dytc_perfmode_attributes
+};
+
 /* sysfs lapmode entry */
 static ssize_t dytc_lapmode_show(struct device *dev,
 					struct device_attribute *attr,
 					char *buf)
 {
-	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+	return sprintf(buf, "%d\n", dytc_lapmode);
 }
 
 static DEVICE_ATTR_RO(dytc_lapmode);
 
-static struct attribute *dytc_attributes[] = {
+static struct attribute *dytc_lap_attributes[] = {
 	&dev_attr_dytc_lapmode.attr,
-	NULL,
+	NULL
 };
 
-static const struct attribute_group dytc_attr_group = {
-	.attrs = dytc_attributes,
+static const struct attribute_group dytc_lap_attr_group = {
+	.attrs = dytc_lap_attributes
 };
 
 static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
 {
-	int err;
+	int err, output;
 
-	err = dytc_lapmode_get(&dytc_lapmode);
-	/* If support isn't available (ENODEV) then don't return an

error

drivers/platform/x86/thinkpad_acpi.c +3 -1
-	 * but just don't create the sysfs group
+	err = dytc_command(DYTC_CMD_QUERY, &output);
+	/*
+	 * If support isn't available (ENODEV) then don't return an

error

drivers/platform/x86/thinkpad_acpi.c +14 -2
+	 * just don't create the sysfs group
 	 */
 	if (err == -ENODEV)
 		return 0;
@@ -9900,14 +10091,38 @@ static int tpacpi_dytc_init(struct
 ibm_init_struct *iibm)
 	if (err)
 		return err;
 
-	/* Platform supports this feature - create the group */
-	err = sysfs_create_group(&tpacpi_pdev->dev.kobj,
 &dytc_attr_group);
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_available = false;
+	dytc_ignore_next_event = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			dbg_printk(TPACPI_DBG_INIT,
+				   "DYTC version %d: thermal mode
 available\n", dytc_version);
+			dytc_available = true;
+			/* Platform supports this feature - create the

group */

drivers/platform/x86/thinkpad_acpi.c +1 -0
+			err = sysfs_create_group(&tpacpi_pdev-
Quoted 1 line

dev.kobj, &dytc_perf_attr_group);

drivers/platform/x86/thinkpad_acpi.c +7 -0
+			if (err)
+				return err;
+
+			err = dytc_lapmode_get(&dytc_lapmode);
+			if (err)
+				return err;
+			err = sysfs_create_group(&tpacpi_pdev-
Quoted 1 line

dev.kobj, &dytc_lap_attr_group);

drivers/platform/x86/thinkpad_acpi.c +4 -1
+		}
+	}
 	return err;
 }
 
 static void dytc_exit(void)
 {
-	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	if (dytc_available) {
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj,

&dytc_lap_attr_group);

drivers/platform/x86/thinkpad_acpi.c +1 -0
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj,

&dytc_perf_attr_group);

drivers/platform/x86/thinkpad_acpi.c +2 -1
+	}
 }
 
 static struct ibm_struct dytc_driver_data = {
@@ -10057,7 +10272,7 @@ static void tpacpi_driver_event(const
 unsigned int hkey_event)
 	}
 
 	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
-		dytc_lapmode_refresh();
+		dytc_refresh();
 
 	if ((hkey_event == TP_HKEY_EV_PALM_DETECTED) ||
Quoted 1 line

(hkey_event == TP_HKEY_EV_PALM_UNDETECTED))

_______________________________________________
ibm-acpi-devel mailing list [email protected]
https://lists.sourceforge.net/lists/listinfo/ibm-acpi-devel

A message that is not in the archive (sent off-list or not yet received): 11594528cfb96e2eed8fe0f27a4ecc1d60803432.camel-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org

#67 lore raw

Re: [External] Re: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Thanks Benjamin!

Quoted 13 lines · Benjamin Berg

Hi Mark,

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi line 16

Quoted 7 lines · Mark Pearson
Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +7 -0
+		H  - High performance mode. Maximum power and temperature available.
+		M* - High performance mode but performance is limited to medium as system is
+		     in lapmode. Power and temperature maximums reduced to a safe threshold.
+		M  - Medium performance mode (aka 'balance'). Lower maximum power and temperatures
+		     but better battery life.
+		L  - Low performance mode (aka 'quiet'). Reduced power setting gives lower
+		     temperatures and extended battery life. Fans run quieter.

I tested the patch yesterday and I see some minor issues right now.

Quoted 3 lines

First, right now change notifications do not happen for a lapmode change. The sysfs file will switch between "H" and "M*" without any notification. This will be an easy fix.

OK - I'll look into this and get that implemented. Good catch.

Quoted 6 lines

Second, I personally see the current "M*" more as a degraded performance mode rather than an effective balanced mode. For example, H and M* match in the sense that the machine will be more noisy as fans are turned on more aggressively.

Quoted 7 lines

Third, we still have a mismatch when writing the file. i.e. you write "H" but you will read "M*".

So, I am thinking of using H* instead. That means we directly represent the firmwares performance mode rather than making an interpretation about an "effective" state. And with the * we continue to convey that there is a major impact on performance due to other factors.

I agree - that makes sense to me. I'll make that change.

Thanks for the review
Mark

Quoted 460 lines

Benjamin

Quoted 457 lines

+What: /sys/devices/platform/thinkpad_acpi/dytc_lapmod
e

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +9 -0
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads returns the current value of the lapmode sensor.
+
+		0 - desk mode is detected
+		1 - lap mode is detected
+
+What:		/sys/devices/platform/thinkpad_acpi/psensor_sta

te

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +7 -0
+Date:		August 2020
+Contact:	Nitin Joshi <[email protected]>
+Description:
+		Reads returns the current value of the palm sensor.
+
+		0 - palm not detected
+		1 - palm detected
Documentation/admin-guide/laptops/thinkpad-acpi.rst +1 -0
index 6b57c52d8f13..b98f0de9e063 100644
@@ -52,6 +52,7 @@ detailed description):
  	- LCD Shadow (PrivacyGuard) enable and disable
  	- Lap mode sensor
          - Palm sensor (aka psensor)
+	- Thermal mode status and control
 
  A compatibility table by model and feature is maintained on the web
  site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1465,6 +1466,40 @@ Note - some platforms have a limitation

whereby the EC firmware cannot
determine if the sensor is installed or not. On these platforms the
psensor
state will always be reported as true to avoid high power being used
incorrectly.

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have

enhanced firmware to

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to

switch the
+operating mode between three different modes. This sysfs node provides a better

Documentation/admin-guide/laptops/thinkpad-acpi.rst +5 -0
+interface for user space to use.
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature

is

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be

limited and

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is

reduced and

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+the device will be cooler and quieter.
+
+Note: High performance mode is only available when the device is in

'deskmode'. If
+the device detects that it is on a lap then it will automatically drop into medium

Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -0
+mode to maintain a safer operating temperature.
+
+The sysfs entry provides the ability to return the current status

and to set the

Documentation/admin-guide/laptops/thinkpad-acpi.rst +6 -0
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+
  EXPERIMENTAL: UWB
  -----------------
drivers/platform/x86/thinkpad_acpi.c +2 -1
index 41b75dd4755c..8fcb660aa5a2 100644
@@ -9817,18 +9817,43 @@ static struct ibm_struct
 lcdshadow_driver_data = {
  };
 
  /*******************************************************************
 ******
- * DYTC subdriver, for the Lenovo lapmode feature
+ * DYTC subdriver, for the Lenovo lap and performance mode feature
   */
 
+#define DYTC_CMD_QUERY        0 /* To get DYTC status -

enable/revision */
+#define DYTC_CMD_SET 1 /* To enable/disable IC function
mode */
#define DYTC_CMD_GET 2 /* To get current IC function and
mode */

drivers/platform/x86/thinkpad_acpi.c +2 -2
-#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+#define DYTC_CMD_RESET    0x1ff /* To reset back to default */
 
-static bool dytc_lapmode;
+#define DYTC_QUERY_ENABLE_BIT 8  /* Bit 8 - 0 = disabled, 1 =

enabled */

drivers/platform/x86/thinkpad_acpi.c +5 -4
+#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revisision */
+#define DYTC_QUERY_REV_BIT    28 /* Bits 28 - 31 - revision */
 
-static void dytc_lapmode_notify_change(void)
-{
-	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
-}
+#define DYTC_GET_FUNCTION_BIT 8  /* Bits 8-11 - function setting */
+#define DYTC_GET_MODE_BIT     12 /* Bits 12-15 - mode setting */
+#define DYTC_GET_LAPMODE_BIT  17 /* Bit 17 - lapmode. Set when on

lap */

drivers/platform/x86/thinkpad_acpi.c +10 -0
+
+#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - funct setting */
+#define DYTC_SET_MODE_BIT     16 /* Bits 16-19 - mode setting */
+#define DYTC_SET_VALID_BIT    20 /* Bit 20 - 1 = on, 0 = off */
+
+#define DYTC_FUNCTION_STD     0  /* Function = 0, standard mode */
+#define DYTC_FUNCTION_CQL     1  /* Function = 1, lap mode */
+#define DYTC_FUNCTION_MMC     11 /* Function = 11, desk mode */
+
+#define DYTC_MODE_PERFORM     2  /* High power mode aka performance

*/

drivers/platform/x86/thinkpad_acpi.c +4 -0
+#define DYTC_MODE_QUIET       3  /* low power mode aka quiet */
+#define DYTC_MODE_BALANCE   0xF  /* default mode aka balance */
+
+#define DYTC_DISABLE_CQL ((DYTC_MODE_BALANCE << DYTC_SET_MODE_BIT) |

\

drivers/platform/x86/thinkpad_acpi.c +3 -0
+		(DYTC_FUNCTION_CQL << DYTC_SET_FUNCTION_BIT) | \
+		DYTC_CMD_SET)
+#define DYTC_ENABLE_CQL (DYTC_DISABLE_CQL | (1 <<

DYTC_SET_VALID_BIT))

drivers/platform/x86/thinkpad_acpi.c +21 -0
+
+static bool dytc_lapmode;
+static int  dytc_perfmode;
+static bool dytc_available;
+static bool dytc_ignore_next_event;
 
  static int dytc_command(int command, int *output)
  {
@@ -9843,6 +9868,87 @@ static int dytc_command(int command, int
 *output)
  	return 0;
  }
 
+static int dytc_perfmode_get(int *perfmode, int *funcmode)
+{
+	int output, err;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	err = dytc_command(DYTC_CMD_GET, &output);
+	if (err)
+		return err;
+	*funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
+
+	if (*funcmode == DYTC_FUNCTION_CQL) {
+		int dummy;
+		/*
+		 * We can't get the mode when in CQL mode - so we

disable CQL

drivers/platform/x86/thinkpad_acpi.c +2 -0
+		 * mode retrieve the mode and then enable it again.
+		 * As disabling/enabling CQL triggers an event we set a

flag to

drivers/platform/x86/thinkpad_acpi.c +1 -0
+		 * ignore these events. This will be cleared by the

event handler

drivers/platform/x86/thinkpad_acpi.c +29 -0
+		 */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_DISABLE_CQL, &dummy);
+		if (err)
+			return err;
+		err = dytc_command(DYTC_CMD_GET, &output);
+		if (err)
+			return err;
+		/* Again ignore this event */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_ENABLE_CQL, &dummy);
+		if (err)
+			return err;
+	}
+	*perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
+	return 0;
+}
+
+static int dytc_perfmode_set(int perfmode)
+{
+	int err, dytc_set;
+	int output;
+	int cur_perfmode, cur_funcmode;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset

command */

drivers/platform/x86/thinkpad_acpi.c +5 -0
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the

commands we do */

drivers/platform/x86/thinkpad_acpi.c +6 -0
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL

first*/

drivers/platform/x86/thinkpad_acpi.c +118 -14
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_DISABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+		dytc_set = (1 << DYTC_SET_VALID_BIT) |
+			(DYTC_FUNCTION_MMC << DYTC_SET_FUNCTION_BIT) |
+			(perfmode << DYTC_SET_MODE_BIT) |
+			DYTC_CMD_SET;
+		err = dytc_command(dytc_set, &output);
+		if (err)
+			return err;
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_ENABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+	}
+	return 0;
+}
+
  static int dytc_lapmode_get(bool *state)
  {
  	int output, err;
@@ -9854,45 +9960,130 @@ static int dytc_lapmode_get(bool *state)
  	return 0;
  }
 
-static void dytc_lapmode_refresh(void)
+static void dytc_refresh(void)
  {
-	bool new_state;
+	bool lapmode;
+	int perfmode, funcmode;
  	int err;
 
-	err = dytc_lapmode_get(&new_state);
-	if (err || (new_state == dytc_lapmode))
+	err = dytc_lapmode_get(&lapmode);
+	if (err)
+		return;
+	if (dytc_ignore_next_event) {
+		dytc_ignore_next_event = false; /*clear setting*/
  		return;
+	}
+	if (lapmode != dytc_lapmode) {
+		dytc_lapmode = lapmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
 "dytc_lapmode");
+	}
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return;
+	if (perfmode != dytc_perfmode) {
+		dytc_perfmode = perfmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
 "dytc_perfmode");
+	}
+}
+
+/* sysfs perfmode entry */
+static ssize_t dytc_perfmode_show(struct device *dev,
+				  struct device_attribute *attr,
+				  char *buf)
+{
+	int err;
+	int perfmode, funcmode;
+
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return err;
 
-	dytc_lapmode = new_state;
-	dytc_lapmode_notify_change();
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return sprintf(buf, "M*\n");
+		else
+			return sprintf(buf, "H\n");
+	case DYTC_MODE_QUIET:
+		return sprintf(buf, "L\n");
+	case DYTC_MODE_BALANCE:
+		return sprintf(buf, "M\n");
+	default:
+		return sprintf(buf, "Unknown (%d)\n", perfmode);
+	}
  }
 
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");
+		break;
+	}
+	if (err)
+		return err;
+
+	tpacpi_disclose_usertask(attr->attr.name,
+				"Performance mode set to %c\n",
 buf[0]);
+	return count;
+}
+
+static DEVICE_ATTR_RW(dytc_perfmode);
+
+static struct attribute *dytc_perfmode_attributes[] = {
+	&dev_attr_dytc_perfmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_perf_attr_group = {
+	.attrs = dytc_perfmode_attributes
+};
+
  /* sysfs lapmode entry */
  static ssize_t dytc_lapmode_show(struct device *dev,
  					struct device_attribute *attr,
  					char *buf)
  {
-	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+	return sprintf(buf, "%d\n", dytc_lapmode);
  }
 
  static DEVICE_ATTR_RO(dytc_lapmode);
 
-static struct attribute *dytc_attributes[] = {
+static struct attribute *dytc_lap_attributes[] = {
  	&dev_attr_dytc_lapmode.attr,
-	NULL,
+	NULL
  };
 
-static const struct attribute_group dytc_attr_group = {
-	.attrs = dytc_attributes,
+static const struct attribute_group dytc_lap_attr_group = {
+	.attrs = dytc_lap_attributes
  };
 
  static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
  {
-	int err;
+	int err, output;
 
-	err = dytc_lapmode_get(&dytc_lapmode);
-	/* If support isn't available (ENODEV) then don't return an

error

drivers/platform/x86/thinkpad_acpi.c +3 -1
-	 * but just don't create the sysfs group
+	err = dytc_command(DYTC_CMD_QUERY, &output);
+	/*
+	 * If support isn't available (ENODEV) then don't return an

error

drivers/platform/x86/thinkpad_acpi.c +14 -2
+	 * just don't create the sysfs group
  	 */
  	if (err == -ENODEV)
  		return 0;
@@ -9900,14 +10091,38 @@ static int tpacpi_dytc_init(struct
 ibm_init_struct *iibm)
  	if (err)
  		return err;
 
-	/* Platform supports this feature - create the group */
-	err = sysfs_create_group(&tpacpi_pdev->dev.kobj,
 &dytc_attr_group);
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_available = false;
+	dytc_ignore_next_event = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			dbg_printk(TPACPI_DBG_INIT,
+				   "DYTC version %d: thermal mode
 available\n", dytc_version);
+			dytc_available = true;
+			/* Platform supports this feature - create the

group */

drivers/platform/x86/thinkpad_acpi.c +1 -0
+			err = sysfs_create_group(&tpacpi_pdev-
Quoted 1 line

dev.kobj, &dytc_perf_attr_group);

drivers/platform/x86/thinkpad_acpi.c +7 -0
+			if (err)
+				return err;
+
+			err = dytc_lapmode_get(&dytc_lapmode);
+			if (err)
+				return err;
+			err = sysfs_create_group(&tpacpi_pdev-
Quoted 1 line

dev.kobj, &dytc_lap_attr_group);

drivers/platform/x86/thinkpad_acpi.c +4 -1
+		}
+	}
  	return err;
  }
 
  static void dytc_exit(void)
  {
-	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	if (dytc_available) {
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj,

&dytc_lap_attr_group);

drivers/platform/x86/thinkpad_acpi.c +1 -0
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj,

&dytc_perf_attr_group);

drivers/platform/x86/thinkpad_acpi.c +2 -1
+	}
  }
 
  static struct ibm_struct dytc_driver_data = {
@@ -10057,7 +10272,7 @@ static void tpacpi_driver_event(const
 unsigned int hkey_event)
  	}
 
  	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
-		dytc_lapmode_refresh();
+		dytc_refresh();
 
  	if ((hkey_event == TP_HKEY_EV_PALM_DETECTED) ||

(hkey_event == TP_HKEY_EV_PALM_UNDETECTED))

#68 lore raw

Re: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

In reply to Mark Pearson

Hi,

Quoted 123 lines · Mark Pearson

Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to provide different performance/thermal modes.

The modes can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the operating mode between three different modes.

H - High performance. Maximum power is available and the temperature is allowed to increase to the maximum for the platform.
M - Medium performance (aka balance). In this mode power will be limited and the laptop will have a lower maximum temperature.
L - Low performance (aka quiet). In this mode power consumption is reduced and the device will be cooler.

High performance mode is only available when the device is in 'desk mode'. If the device detects that it is on a lap then it will automatically drop into medium mode to maintain a safer operating temperature.

This patch provides an interface to determine the current mode and to also allow the setting of the mode through the dytc_perfmode sysfs entry. This can be used by userspace for improved control.

---
Changes in v2:
- Add userspace notification to hkey event handler. Note this got somewhat more complicated than expected as retrieving the performance mode when in lapmode generates an event itself; added a flag to ignore these known events.
- Updated the values returned to be simpler (H/M*/M/L) as suggested.
- Added ABI documentation as requested. Lap and palm sensor details added whilst I was doing this.
- Cleaned up code based on recommendations as well as feedback received from other patch reviews.
- Based on discussion with firmware team the lapmode sensor should only be made available for DYTC v5 and later. Added this to init logic.

  .../sysfs-devices-platform-thinkpad_acpi      |  34 +++
  .../admin-guide/laptops/thinkpad-acpi.rst     |  35 +++
  drivers/platform/x86/thinkpad_acpi.c          | 267 ++++++++++++++++--
  3 files changed, 310 insertions(+), 26 deletions(-)

create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi

Documentation/ABI/testing/sysfs-devices-platform-thinkpad_acpi new file +34 -0
new file mode 100644
index 000000000000..28f07753a889
@@ -0,0 +1,34 @@
+What:		/sys/devices/platform/thinkpad_acpi/dytc_perfmode
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads return the current performance mode setting configured in firmware using
+		the below nomenclature.
+
+		Writes configure the performance mode setting by using the below nomenclature.
+
+		H  - High performance mode. Maximum power and temperature available.
+		M* - High performance mode but performance is limited to medium as system is
+		     in lapmode. Power and temperature maximums reduced to a safe threshold.
+		M  - Medium performance mode (aka 'balance'). Lower maximum power and temperatures
+		     but better battery life.
+		L  - Low performance mode (aka 'quiet'). Reduced power setting gives lower
+		     temperatures and extended battery life. Fans run quieter.
+
+What:		/sys/devices/platform/thinkpad_acpi/dytc_lapmode
+Date:		August 2020
+Contact:	Mark Pearson <[email protected]>
+Description:
+		Reads returns the current value of the lapmode sensor.
+
+		0 - desk mode is detected
+		1 - lap mode is detected
+
+What:		/sys/devices/platform/thinkpad_acpi/psensor_state
+Date:		August 2020
+Contact:	Nitin Joshi <[email protected]>
+Description:
+		Reads returns the current value of the palm sensor.
+
+		0 - palm not detected
+		1 - palm detected
Documentation/admin-guide/laptops/thinkpad-acpi.rst +25 -0
index 6b57c52d8f13..b98f0de9e063 100644
@@ -52,6 +52,7 @@ detailed description):
  	- LCD Shadow (PrivacyGuard) enable and disable
  	- Lap mode sensor
          - Palm sensor (aka psensor)
+	- Thermal mode status and control
 
  A compatibility table by model and feature is maintained on the web
  site, http://ibm-acpi.sf.net/. I appreciate any success or failure
@@ -1465,6 +1466,40 @@ Note - some platforms have a limitation whereby the EC firmware cannot
  determine if the sensor is installed or not. On these platforms the psensor
  state will always be reported as true to avoid high power being used incorrectly.
 
+DYTC Thermal mode status and control
+------------------------------------
+
+sysfs: dytc_perfmode
+
+Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to
+provide improved performance control.
+
+The firmware can be controlled by hotkeys (FN+H, FN+M, FN+L) to switch the
+operating mode between three different modes. This sysfs node provides a better
+interface for user space to use.
+
+The modes available are:
+
+H - High performance. Maximum power is available and the temperature is
+allowed to increase to the maximum for the platform.
+
+M - Medium performance (aka balance). In this mode power will be limited and
+the laptop will remain cooler.
+
+L - Low performance (aka quiet). In this mode power consumption is reduced and
+the device will be cooler and quieter.
+
+Note: High performance mode is only available when the device is in 'deskmode'. If

Documentation/admin-guide/laptops/thinkpad-acpi.rst Note - some platforms have a limitation whereby the EC firmware cannot · line 1502

Quoted 10 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +10 -0
+the device detects that it is on a lap then it will automatically drop into medium
+mode to maintain a safer operating temperature.
+
+The sysfs entry provides the ability to return the current status and to set the
+desired mode. For example::
+
+        echo H > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo M > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+        echo L > /sys/devices/platform/thinkpad_acpi/dytc_perfmode
+

So we recently had another driver show up with almost the same interface / thing:

https://patchwork.kernel.org/patch/11774509/

So I believe that we really should come up with a standardize sysfs interface for this under /sys/class/<some-name>

Please see the "RFC: offering a standardized (/sys/class) userspace API for selecting system/laptop performance-profiles" mail thread which I just started.

Note I've not looked at the rest of this patch at all yet. But this patch should not be merged until the userspace API question is settled so nack to this patch for now (sorry).

Mark, once we have an agreement on what the userspace API for this should look like I can implement a small helper-library / class-core for registering the class device for this, modify this patch to use that and test it on a X1C8.

Or if you prefer you can do this yourself. Please let me know how you want to proceed with this.

Regards,

Hans

Quoted 344 lines
Documentation/admin-guide/laptops/thinkpad-acpi.rst +0 -0
  EXPERIMENTAL: UWB
  -----------------
 
drivers/platform/x86/thinkpad_acpi.c +241 -26
index 41b75dd4755c..8fcb660aa5a2 100644
@@ -9817,18 +9817,43 @@ static struct ibm_struct lcdshadow_driver_data = {
  };
 
  /*************************************************************************
- * DYTC subdriver, for the Lenovo lapmode feature
+ * DYTC subdriver, for the Lenovo lap and performance mode feature
   */
 
+#define DYTC_CMD_QUERY        0 /* To get DYTC status - enable/revision */
+#define DYTC_CMD_SET          1 /* To enable/disable IC function mode */
  #define DYTC_CMD_GET          2 /* To get current IC function and mode */
-#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
+#define DYTC_CMD_RESET    0x1ff /* To reset back to default */
 
-static bool dytc_lapmode;
+#define DYTC_QUERY_ENABLE_BIT 8  /* Bit 8 - 0 = disabled, 1 = enabled */
+#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revisision */
+#define DYTC_QUERY_REV_BIT    28 /* Bits 28 - 31 - revision */
 
-static void dytc_lapmode_notify_change(void)
-{
-	sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
-}
+#define DYTC_GET_FUNCTION_BIT 8  /* Bits 8-11 - function setting */
+#define DYTC_GET_MODE_BIT     12 /* Bits 12-15 - mode setting */
+#define DYTC_GET_LAPMODE_BIT  17 /* Bit 17 - lapmode. Set when on lap */
+
+#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - funct setting */
+#define DYTC_SET_MODE_BIT     16 /* Bits 16-19 - mode setting */
+#define DYTC_SET_VALID_BIT    20 /* Bit 20 - 1 = on, 0 = off */
+
+#define DYTC_FUNCTION_STD     0  /* Function = 0, standard mode */
+#define DYTC_FUNCTION_CQL     1  /* Function = 1, lap mode */
+#define DYTC_FUNCTION_MMC     11 /* Function = 11, desk mode */
+
+#define DYTC_MODE_PERFORM     2  /* High power mode aka performance */
+#define DYTC_MODE_QUIET       3  /* low power mode aka quiet */
+#define DYTC_MODE_BALANCE   0xF  /* default mode aka balance */
+
+#define DYTC_DISABLE_CQL ((DYTC_MODE_BALANCE << DYTC_SET_MODE_BIT) | \
+		(DYTC_FUNCTION_CQL << DYTC_SET_FUNCTION_BIT) | \
+		DYTC_CMD_SET)
+#define DYTC_ENABLE_CQL (DYTC_DISABLE_CQL | (1 << DYTC_SET_VALID_BIT))
+
+static bool dytc_lapmode;
+static int  dytc_perfmode;
+static bool dytc_available;
+static bool dytc_ignore_next_event;
 
  static int dytc_command(int command, int *output)
  {
@@ -9843,6 +9868,87 @@ static int dytc_command(int command, int *output)
  	return 0;
  }
 
+static int dytc_perfmode_get(int *perfmode, int *funcmode)
+{
+	int output, err;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	err = dytc_command(DYTC_CMD_GET, &output);
+	if (err)
+		return err;
+	*funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
+
+	if (*funcmode == DYTC_FUNCTION_CQL) {
+		int dummy;
+		/*
+		 * We can't get the mode when in CQL mode - so we disable CQL
+		 * mode retrieve the mode and then enable it again.
+		 * As disabling/enabling CQL triggers an event we set a flag to
+		 * ignore these events. This will be cleared by the event handler
+		 */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_DISABLE_CQL, &dummy);
+		if (err)
+			return err;
+		err = dytc_command(DYTC_CMD_GET, &output);
+		if (err)
+			return err;
+		/* Again ignore this event */
+		dytc_ignore_next_event = true;
+		err = dytc_command(DYTC_ENABLE_CQL, &dummy);
+		if (err)
+			return err;
+	}
+	*perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
+	return 0;
+}
+
+static int dytc_perfmode_set(int perfmode)
+{
+	int err, dytc_set;
+	int output;
+	int cur_perfmode, cur_funcmode;
+
+	if (!dytc_available)
+		return -ENODEV;
+
+	if (perfmode == DYTC_MODE_BALANCE) {
+		/* To get back to balance mode we just issue a reset command */
+		err = dytc_command(DYTC_CMD_RESET, &output);
+		if (err)
+			return err;
+	} else {
+		/* Determine if we are in CQL mode. This alters the commands we do */
+		err = dytc_perfmode_get(&cur_perfmode, &cur_funcmode);
+		if (err)
+			return err;
+
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			/* To set the mode we need to disable CQL first*/
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_DISABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+		dytc_set = (1 << DYTC_SET_VALID_BIT) |
+			(DYTC_FUNCTION_MMC << DYTC_SET_FUNCTION_BIT) |
+			(perfmode << DYTC_SET_MODE_BIT) |
+			DYTC_CMD_SET;
+		err = dytc_command(dytc_set, &output);
+		if (err)
+			return err;
+		if (cur_funcmode == DYTC_FUNCTION_CQL) {
+			dytc_ignore_next_event = true; /*ignore event*/
+			err = dytc_command(DYTC_ENABLE_CQL, &output);
+			if (err)
+				return err;
+		}
+	}
+	return 0;
+}
+
  static int dytc_lapmode_get(bool *state)
  {
  	int output, err;
@@ -9854,45 +9960,130 @@ static int dytc_lapmode_get(bool *state)
  	return 0;
  }
 
-static void dytc_lapmode_refresh(void)
+static void dytc_refresh(void)
  {
-	bool new_state;
+	bool lapmode;
+	int perfmode, funcmode;
  	int err;
 
-	err = dytc_lapmode_get(&new_state);
-	if (err || (new_state == dytc_lapmode))
+	err = dytc_lapmode_get(&lapmode);
+	if (err)
+		return;
+	if (dytc_ignore_next_event) {
+		dytc_ignore_next_event = false; /*clear setting*/
  		return;
+	}
+	if (lapmode != dytc_lapmode) {
+		dytc_lapmode = lapmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
+	}
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return;
+	if (perfmode != dytc_perfmode) {
+		dytc_perfmode = perfmode;
+		sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_perfmode");
+	}
+}
+
+/* sysfs perfmode entry */
+static ssize_t dytc_perfmode_show(struct device *dev,
+				  struct device_attribute *attr,
+				  char *buf)
+{
+	int err;
+	int perfmode, funcmode;
+
+	err = dytc_perfmode_get(&perfmode, &funcmode);
+	if (err)
+		return err;
 
-	dytc_lapmode = new_state;
-	dytc_lapmode_notify_change();
+	switch (perfmode) {
+	case DYTC_MODE_PERFORM:
+		/* High performance is only available in deskmode */
+		if (funcmode == DYTC_FUNCTION_CQL)
+			return sprintf(buf, "M*\n");
+		else
+			return sprintf(buf, "H\n");
+	case DYTC_MODE_QUIET:
+		return sprintf(buf, "L\n");
+	case DYTC_MODE_BALANCE:
+		return sprintf(buf, "M\n");
+	default:
+		return sprintf(buf, "Unknown (%d)\n", perfmode);
+	}
  }
 
+static ssize_t dytc_perfmode_store(struct device *dev,
+				   struct device_attribute *attr,
+				   const char *buf, size_t count)
+{
+	int err;
+
+	switch (buf[0]) {
+	case 'l':
+	case 'L':
+		err = dytc_perfmode_set(DYTC_MODE_QUIET);
+		break;
+	case 'm':
+	case 'M':
+		err = dytc_perfmode_set(DYTC_MODE_BALANCE);
+		break;
+	case 'h':
+	case 'H':
+		err = dytc_perfmode_set(DYTC_MODE_PERFORM);
+		break;
+	default:
+		err = -EINVAL;
+		pr_err("Unknown operating mode. Ignoring\n");
+		break;
+	}
+	if (err)
+		return err;
+
+	tpacpi_disclose_usertask(attr->attr.name,
+				"Performance mode set to %c\n", buf[0]);
+	return count;
+}
+
+static DEVICE_ATTR_RW(dytc_perfmode);
+
+static struct attribute *dytc_perfmode_attributes[] = {
+	&dev_attr_dytc_perfmode.attr,
+	NULL
+};
+
+static const struct attribute_group dytc_perf_attr_group = {
+	.attrs = dytc_perfmode_attributes
+};
+
  /* sysfs lapmode entry */
  static ssize_t dytc_lapmode_show(struct device *dev,
  					struct device_attribute *attr,
  					char *buf)
  {
-	return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
+	return sprintf(buf, "%d\n", dytc_lapmode);
  }
 
  static DEVICE_ATTR_RO(dytc_lapmode);
 
-static struct attribute *dytc_attributes[] = {
+static struct attribute *dytc_lap_attributes[] = {
  	&dev_attr_dytc_lapmode.attr,
-	NULL,
+	NULL
  };
 
-static const struct attribute_group dytc_attr_group = {
-	.attrs = dytc_attributes,
+static const struct attribute_group dytc_lap_attr_group = {
+	.attrs = dytc_lap_attributes
  };
 
  static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
  {
-	int err;
+	int err, output;
 
-	err = dytc_lapmode_get(&dytc_lapmode);
-	/* If support isn't available (ENODEV) then don't return an error
-	 * but just don't create the sysfs group
+	err = dytc_command(DYTC_CMD_QUERY, &output);
+	/*
+	 * If support isn't available (ENODEV) then don't return an error
+	 * just don't create the sysfs group
  	 */
  	if (err == -ENODEV)
  		return 0;
@@ -9900,14 +10091,38 @@ static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
  	if (err)
  		return err;
 
-	/* Platform supports this feature - create the group */
-	err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	/* Check DYTC is enabled and supports mode setting */
+	dytc_available = false;
+	dytc_ignore_next_event = false;
+	if (output & BIT(DYTC_QUERY_ENABLE_BIT)) {
+		/* Only DYTC v5.0 and later has this feature. */
+		int dytc_version;
+
+		dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
+		if (dytc_version >= 5) {
+			dbg_printk(TPACPI_DBG_INIT,
+				   "DYTC version %d: thermal mode available\n", dytc_version);
+			dytc_available = true;
+			/* Platform supports this feature - create the group */
+			err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_perf_attr_group);
+			if (err)
+				return err;
+
+			err = dytc_lapmode_get(&dytc_lapmode);
+			if (err)
+				return err;
+			err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_lap_attr_group);
+		}
+	}
  	return err;
  }
 
  static void dytc_exit(void)
  {
-	sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
+	if (dytc_available) {
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_lap_attr_group);
+		sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_perf_attr_group);
+	}
  }
 
  static struct ibm_struct dytc_driver_data = {
@@ -10057,7 +10272,7 @@ static void tpacpi_driver_event(const unsigned int hkey_event)
  	}
 
  	if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
-		dytc_lapmode_refresh();
+		dytc_refresh();
 
  	if ((hkey_event == TP_HKEY_EV_PALM_DETECTED) ||
  		(hkey_event == TP_HKEY_EV_PALM_UNDETECTED))
#69 lore raw

Re: [External] Re: [PATCH v2] platform/x86: thinkpad_acpi: performance mode interface

Hi Hans,

Quoted 6 lines · Hans de Goede

Hi,

Quoted 3 lines · Mark Pearson

Lenovo Thinkpad platforms with DYTC version 5 and newer have enhanced firmware to provide different performance/thermal modes.

<Snip>

Quoted 16 lines

So we recently had another driver show up with almost the same interface / thing:

https://patchwork.kernel.org/patch/11774509/

So I believe that we really should come up with a standardize sysfs interface for this under /sys/class/<some-name>

Please see the "RFC: offering a standardized (/sys/class) userspace API for selecting system/laptop performance-profiles" mail thread which I just started.

Note I've not looked at the rest of this patch at all yet. But this patch should not be merged until the userspace API question is settled so nack to this patch for now (sorry).

Quoted 6 lines

Mark, once we have an agreement on what the userspace API for this should look like I can implement a small helper-library / class-core for registering the class device for this, modify this patch to use that and test it on a X1C8.

Or if you prefer you can do this yourself. Please let me know how you want to proceed with this.

I'll join in that thread and depending on what is involved and the level of kernel expertise involved will contribute as much as I can. For sure will modify, integrate and test this implementation once that is available.

If there is a way I can 'tweak' this patch to expose the current performance mode to users in a way that is acceptable until the generic solution is available let me know and I'll do that. I'm just guessing that a generic solution needing input from multiple vendors could take a little while to develop - having a way to check what mode your system is in is really useful given you can change the mode using hotkeys.

Mark