From 5b8f85d081da449ab35e4bd009d7c00afaab2fab Mon Sep 17 00:00:00 2001 From: Jacek Lawrynowicz Date: Fri, 14 Mar 2025 11:01:36 +0100 Subject: [PATCH] docs: driver-api: firmware: clarify userspace requirements The guidelines mention that firmware updates can't break the kernel, but it doesn't state directly that they can't break userspace programs. Make it explicit that firmware updates cannot break UAPI. Signed-off-by: Jacek Lawrynowicz Acked-by: Dave Airlie [jc: fixed "no trailing newline"] Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20250314100137.2972355-1-jacek.lawrynowicz@linux.intel.com --- .../driver-api/firmware/firmware-usage-guidelines.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/driver-api/firmware/firmware-usage-guidelines.rst b/Documentation/driver-api/firmware/firmware-usage-guidelines.rst index fdcfce42c6d2..336e912281c3 100644 --- a/Documentation/driver-api/firmware/firmware-usage-guidelines.rst +++ b/Documentation/driver-api/firmware/firmware-usage-guidelines.rst @@ -42,3 +42,8 @@ then of course these rules will not apply strictly.) deprecating old major versions, then this should only be done as a last option, and be stated clearly in all communications. +* Firmware files that affect the User API (UAPI) shall not introduce + changes that break existing userspace programs. Updates to such firmware + must ensure backward compatibility with existing userspace applications. + This includes maintaining consistent interfaces and behaviors that + userspace programs rely on. -- 2.25.1