Commit 5b8f85d0 authored by Jacek Lawrynowicz's avatar Jacek Lawrynowicz Committed by Jonathan Corbet
Browse files

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: default avatarJacek Lawrynowicz <jacek.lawrynowicz@linux.intel.com>
Acked-by: default avatarDave Airlie <airlied@redhat.com>
[jc: fixed "no trailing newline"]
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250314100137.2972355-1-jacek.lawrynowicz@linux.intel.com
parent 4e6b7141

Documentation/driver-api/firmware/firmware-usage-guidelines.rst

+5 −0
Original line number Diff line number Diff line
@@ -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.