Skip to content

Commit 4c0f8f8

Browse files
committed
doc: add descriptions for rpiboot resouce and driver
1 parent bb1066e commit 4c0f8f8

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

doc/configuration.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,6 +1347,32 @@ Arguments:
13471347
Used by:
13481348
- none
13491349

1350+
1351+
RpibootDevice
1352+
~~~~~~
1353+
1354+
A :any:`RpibootDevice`describes an attached raspberry pi device in boot mode.
1355+
This driver does not control power or the reset button. So in order to be
1356+
able to set a pi into boot mode relays or simular need to be used to set the
1357+
raspberry pi into bootmode.
1358+
When then pi is in boot mode this resouce will become available and the
1359+
rpiboot driver can be used to make the pi act like a MassStorageDevice.
1360+
When the pi has been put into boot mode this driver can be used to make the
1361+
pi act like a MassStorageDevice.
1362+
1363+
.. code-block:: yaml
1364+
1365+
RpibootDevice:
1366+
match:
1367+
ID_SERIAL: 'Broadcom_BCM2711_Boot_124e610f'
1368+
1369+
1370+
Arguments:
1371+
- match (dict): key and value pairs for a udev match, see `udev Matching`_
1372+
1373+
Used by:
1374+
- RpibootDriver
1375+
13501376
Providers
13511377
~~~~~~~~~
13521378
Providers describe directories that are accessible by the target over a
@@ -3407,6 +3433,30 @@ Implements:
34073433
Arguments:
34083434
- None
34093435

3436+
RpibootDriver
3437+
~~~~~~~~~~~~~~~~~~~~~~~~~
3438+
The :any:`RpibootDriver` uses a `RpibootDevice`_ resource to enable a raspberry
3439+
pi as an MassStorageDevice. Allowing for using `USBStorageDriver`_ to bootstrap
3440+
a raspberry pi.
3441+
3442+
Binds to:
3443+
rpi:
3444+
- `RpibootDevice`_
3445+
- `NetworkRpibootDevice`_
3446+
3447+
Implements:
3448+
- None
3449+
3450+
Arguments:
3451+
- None (yet)
3452+
3453+
before using this driver the raspberry pi needs to be put into usbboot mode.
3454+
This is done by pressing a EMMC-DISABLE / nRPIBOOT button on rpi cm expansion
3455+
board or grounding pins using a jumper wire.
3456+
How this is done is dependent on what raspberry pi is being used.
3457+
For compute models and rpi5 `rpi-usbboot <https://github.com/raspberrypi/usbboot?tab=readme-ov-file#running>`_
3458+
and for rpi4 `use gpio to enable RPIBOOT <https://github.com/raspberrypi/usbboot/tree/master/secure-boot-recovery#extra-steps-for-raspberry-pi-4b--pi-400>`.
3459+
34103460
.. _conf-strategies:
34113461

34123462
Strategies

0 commit comments

Comments
 (0)