docs: driver-api: firmware: clarify userspace requirements
authorJacek Lawrynowicz <jacek.lawrynowicz@linux.intel.com>
Fri, 14 Mar 2025 10:01:36 +0000 (11:01 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 17 Mar 2025 23:04:32 +0000 (17:04 -0600)
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 <jacek.lawrynowicz@linux.intel.com>
Acked-by: Dave Airlie <airlied@redhat.com>
[jc: fixed "no trailing newline"]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250314100137.2972355-1-jacek.lawrynowicz@linux.intel.com
Documentation/driver-api/firmware/firmware-usage-guidelines.rst

index fdcfce42c6d28b175969aa9af0386f7ff7849d3b..336e912281c321430384f606d9dbf56f1cd2980c 100644 (file)
@@ -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.