Skip to contentSkip to conversation

platform/chrome: chromeos_acpi: print hex string for ACPI_TYPE_BUFFER

PATCH Applied Tzung-Bi Shih 3 participants 4 messages Aug 3, 2023 – Aug 11, 2023

Subsystems (2)
lore
Share & tools
lore

Tzung-Bi Shih

author maintainer
#0 lore raw

PATCH v3 1/1 platform/chrome: chromeos_acpi: print hex string for ACPI_TYPE_BUFFER

element->buffer.pointer should be binary blob. %s doesn't work perfect for them.

Print hex string for ACPI_TYPE_BUFFER. Also update the documentation to reflect this.

Fixes 0a4cad9c11ad ("platform/chrome: Add ChromeOS ACPI device driver")

---
Changes from v2[1]:
- Use dev_info_once() instead of dev_info().
- Update documentation.
- Add Fixes tag.

Changes from v1[2]:
- Use hex_dump_to_buffer().
- Rewrite the loop for catching edge cases for truncating.

[1]: https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/
[2]: https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/

 .../ABI/testing/sysfs-driver-chromeos-acpi    |  2 +-
 drivers/platform/chrome/chromeos_acpi.c       | 31 ++++++++++++++++++-
 2 files changed, 31 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-driver-chromeos-acpi +1 -1
index c308926e1568..7c8e129fc100 100644
@@ -134,4 +134,4 @@ KernelVersion:	5.19
 Description:
 		Returns the verified boot data block shared between the
 		firmware verification step and the kernel verification step
-		(binary).
+		(hex dump).
drivers/platform/chrome/chromeos_acpi.c +30 -1
index 50d8a4d4352d..1312aaaa8750 100644
@@ -90,7 +90,36 @@ static int chromeos_acpi_handle_package(struct device *dev, union acpi_object *o
 	case ACPI_TYPE_STRING:
 		return sysfs_emit(buf, "%s\n", element->string.pointer);
 	case ACPI_TYPE_BUFFER:
-		return sysfs_emit(buf, "%s\n", element->buffer.pointer);
+		{
+			int i, r, at, room_left;
+			const int byte_per_line = 16;
+
+			at = 0;
+			room_left = PAGE_SIZE - 1;
+			for (i = 0; i < element->buffer.length && room_left; i += byte_per_line) {
+				r = hex_dump_to_buffer(element->buffer.pointer + i,
+						       element->buffer.length - i,
+						       byte_per_line, 1, buf + at, room_left,
+						       false);
+				if (r > room_left)
+					goto truncating;
+				at += r;
+				room_left -= r;
+
+				r = sysfs_emit_at(buf, at, "\n");
+				if (!r)
+					goto truncating;
+				at += r;
+				room_left -= r;
+			}
+
+			buf[at] = 0;
+			return at;
+truncating:
+			dev_info_once(dev, "truncating sysfs content for %s\n", name);
+			sysfs_emit_at(buf, PAGE_SIZE - 4, "..\n");
+			return PAGE_SIZE - 1;
+		}
 	default:
 		dev_err(dev, "element type %d not supported\n", element->type);
 		return -EINVAL;
Signature · 1 line
2.41.0.585.gd2178a4bd4-goog
Reviewed-by on v3 1/1
#1 lore raw
Quoted 8 lines · Tzung-Bi Shih

element->buffer.pointer should be binary blob. %s doesn't work perfect for them.

Print hex string for ACPI_TYPE_BUFFER. Also update the documentation to reflect this.

Fixes 0a4cad9c11ad ("platform/chrome: Add ChromeOS ACPI device driver")
Quoted 69 lines

---
Changes from v2[1]:
- Use dev_info_once() instead of dev_info().
- Update documentation.
- Add Fixes tag.

Changes from v1[2]:
- Use hex_dump_to_buffer().
- Rewrite the loop for catching edge cases for truncating.

[1]: https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/
[2]: https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/

 .../ABI/testing/sysfs-driver-chromeos-acpi    |  2 +-
 drivers/platform/chrome/chromeos_acpi.c       | 31 ++++++++++++++++++-
 2 files changed, 31 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-driver-chromeos-acpi +1 -1
index c308926e1568..7c8e129fc100 100644
@@ -134,4 +134,4 @@ KernelVersion:	5.19
 Description:
 		Returns the verified boot data block shared between the
 		firmware verification step and the kernel verification step
-		(binary).
+		(hex dump).
drivers/platform/chrome/chromeos_acpi.c +30 -1
index 50d8a4d4352d..1312aaaa8750 100644
@@ -90,7 +90,36 @@ static int chromeos_acpi_handle_package(struct device *dev, union acpi_object *o
 	case ACPI_TYPE_STRING:
 		return sysfs_emit(buf, "%s\n", element->string.pointer);
 	case ACPI_TYPE_BUFFER:
-		return sysfs_emit(buf, "%s\n", element->buffer.pointer);
+		{
+			int i, r, at, room_left;
+			const int byte_per_line = 16;
+
+			at = 0;
+			room_left = PAGE_SIZE - 1;
+			for (i = 0; i < element->buffer.length && room_left; i += byte_per_line) {
+				r = hex_dump_to_buffer(element->buffer.pointer + i,
+						       element->buffer.length - i,
+						       byte_per_line, 1, buf + at, room_left,
+						       false);
+				if (r > room_left)
+					goto truncating;
+				at += r;
+				room_left -= r;
+
+				r = sysfs_emit_at(buf, at, "\n");
+				if (!r)
+					goto truncating;
+				at += r;
+				room_left -= r;
+			}
+
+			buf[at] = 0;
+			return at;
+truncating:
+			dev_info_once(dev, "truncating sysfs content for %s\n", name);
+			sysfs_emit_at(buf, PAGE_SIZE - 4, "..\n");
+			return PAGE_SIZE - 1;
+		}
 	default:
 		dev_err(dev, "element type %d not supported\n", element->type);
 		return -EINVAL;
#2 lore raw
In reply to Tzung-Bi Shih
This patch was applied to chrome-platform/linux.git (for-kernelci) by Tzung-Bi Shih <[email protected]>:

Hello:

This patch was applied to chrome-platform/linux.git (for-kernelci) by Tzung-Bi Shih <[email protected]>:

Quoted 10 lines · On Thu, 3 Aug 2023 09:12:45 +0800 you wrote:

element->buffer.pointer should be binary blob. %s doesn't work perfect for them.

Print hex string for ACPI_TYPE_BUFFER. Also update the documentation to reflect this.

Fixes 0a4cad9c11ad ("platform/chrome: Add ChromeOS ACPI device driver")

[...]

Here is the summary with links:
- [v3] platform/chrome: chromeos_acpi: print hex string for ACPI_TYPE_BUFFER

    https://git.kernel.org/chrome-platform/c/0820debb7d48

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
#3 lore raw
In reply to Tzung-Bi Shih
This patch was applied to chrome-platform/linux.git (for-next) by Tzung-Bi Shih <[email protected]>:

Hello:

This patch was applied to chrome-platform/linux.git (for-next) by Tzung-Bi Shih <[email protected]>:

Quoted 10 lines · On Thu, 3 Aug 2023 09:12:45 +0800 you wrote:

element->buffer.pointer should be binary blob. %s doesn't work perfect for them.

Print hex string for ACPI_TYPE_BUFFER. Also update the documentation to reflect this.

Fixes 0a4cad9c11ad ("platform/chrome: Add ChromeOS ACPI device driver")

[...]

Here is the summary with links:
- [v3] platform/chrome: chromeos_acpi: print hex string for ACPI_TYPE_BUFFER

    https://git.kernel.org/chrome-platform/c/0820debb7d48

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html