sysfs-class-firmware 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. What: /sys/class/firmware/.../data
  2. Date: July 2022
  3. KernelVersion: 5.19
  4. Contact: Russ Weight <[email protected]>
  5. Description: The data sysfs file is used for firmware-fallback and for
  6. firmware uploads. Cat a firmware image to this sysfs file
  7. after you echo 1 to the loading sysfs file. When the firmware
  8. image write is complete, echo 0 to the loading sysfs file. This
  9. sequence will signal the completion of the firmware write and
  10. signal the lower-level driver that the firmware data is
  11. available.
  12. What: /sys/class/firmware/.../cancel
  13. Date: July 2022
  14. KernelVersion: 5.19
  15. Contact: Russ Weight <[email protected]>
  16. Description: Write-only. For firmware uploads, write a "1" to this file to
  17. request that the transfer of firmware data to the lower-level
  18. device be canceled. This request will be rejected (EBUSY) if
  19. the update cannot be canceled (e.g. a FLASH write is in
  20. progress) or (ENODEV) if there is no firmware update in progress.
  21. What: /sys/class/firmware/.../error
  22. Date: July 2022
  23. KernelVersion: 5.19
  24. Contact: Russ Weight <[email protected]>
  25. Description: Read-only. Returns a string describing a failed firmware
  26. upload. This string will be in the form of <STATUS>:<ERROR>,
  27. where <STATUS> will be one of the status strings described
  28. for the status sysfs file and <ERROR> will be one of the
  29. following: "hw-error", "timeout", "user-abort", "device-busy",
  30. "invalid-file-size", "read-write-error", "flash-wearout". The
  31. error sysfs file is only meaningful when the current firmware
  32. upload status is "idle". If this file is read while a firmware
  33. transfer is in progress, then the read will fail with EBUSY.
  34. What: /sys/class/firmware/.../loading
  35. Date: July 2022
  36. KernelVersion: 5.19
  37. Contact: Russ Weight <[email protected]>
  38. Description: The loading sysfs file is used for both firmware-fallback and
  39. for firmware uploads. Echo 1 onto the loading file to indicate
  40. you are writing a firmware file to the data sysfs node. Echo
  41. -1 onto this file to abort the data write or echo 0 onto this
  42. file to indicate that the write is complete. For firmware
  43. uploads, the zero value also triggers the transfer of the
  44. firmware data to the lower-level device driver.
  45. What: /sys/class/firmware/.../remaining_size
  46. Date: July 2022
  47. KernelVersion: 5.19
  48. Contact: Russ Weight <[email protected]>
  49. Description: Read-only. For firmware upload, this file contains the size
  50. of the firmware data that remains to be transferred to the
  51. lower-level device driver. The size value is initialized to
  52. the full size of the firmware image that was previously
  53. written to the data sysfs file. This value is periodically
  54. updated during the "transferring" phase of the firmware
  55. upload.
  56. Format: "%u".
  57. What: /sys/class/firmware/.../status
  58. Date: July 2022
  59. KernelVersion: 5.19
  60. Contact: Russ Weight <[email protected]>
  61. Description: Read-only. Returns a string describing the current status of
  62. a firmware upload. The string will be one of the following:
  63. idle, "receiving", "preparing", "transferring", "programming".
  64. What: /sys/class/firmware/.../timeout
  65. Date: July 2022
  66. KernelVersion: 5.19
  67. Contact: Russ Weight <[email protected]>
  68. Description: This file supports the timeout mechanism for firmware
  69. fallback. This file has no affect on firmware uploads. For
  70. more information on timeouts please see the documentation
  71. for firmware fallback.