Skip to content

Commit 7c99fbf

Browse files
doc/configuration: document missing network resources
Signed-off-by: Bastian Krause <[email protected]>
1 parent 4e144fb commit 7c99fbf

File tree

1 file changed

+62
-12
lines changed

1 file changed

+62
-12
lines changed

doc/configuration.rst

Lines changed: 62 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,11 @@ Used by:
351351
looking for, paths without the interface will fail to match since they use
352352
the ``usb`` driver.
353353

354+
NetworkUSBPowerPort
355+
+++++++++++++++++++
356+
A :any:`NetworkUSBPowerPort` describes a `USBPowerPort`_ resource available on
357+
a remote computer.
358+
354359
SiSPMPowerPort
355360
++++++++++++++
356361
A :any:`SiSPMPowerPort` describes a *GEMBIRD SiS-PM* as supported by
@@ -373,6 +378,11 @@ Arguments:
373378
Used by:
374379
- `SiSPMPowerDriver`_
375380

381+
NetworkSiSPMPowerPort
382+
+++++++++++++++++++++
383+
A :any:`NetworkSiSPMPowerPort` describes a `SiSPMPowerPort`_ resource available
384+
on a remote computer.
385+
376386
TasmotaPowerPort
377387
++++++++++++++++
378388
A :any:`TasmotaPowerPort` resource describes a switchable `Tasmota
@@ -474,6 +484,11 @@ Arguments:
474484
Used by:
475485
- `DeditecRelaisDriver`_
476486

487+
NetworkDeditecRelais8
488+
+++++++++++++++++++++
489+
A :any:`NetworkDeditecRelais8` describes a `DeditecRelais8`_ resource available
490+
on a remote computer.
491+
477492
OneWirePIO
478493
++++++++++
479494
A :any:`OneWirePIO` describes a *1-Wire* programmable I/O pin.
@@ -602,6 +617,11 @@ Arguments:
602617
Used by:
603618
- `GpioDigitalOutputDriver`_
604619

620+
NetworkSysfsGPIO
621+
++++++++++++++++
622+
A :any:`NetworkSysfsGPIO` describes a `SysfsGPIO`_ resource available on a
623+
remote computer.
624+
605625
MatchedSysfsGPIO
606626
++++++++++++++++
607627
A :any:`MatchedSysfsGPIO` describes a GPIO line, like a `SysfsGPIO`_.
@@ -803,6 +823,11 @@ Arguments:
803823
Used by:
804824
- `AndroidFastbootDriver`_
805825

826+
RemoteAndroidUSBFastboot
827+
~~~~~~~~~~~~~~~~~~~~~~~~
828+
A :any:`RemoteAndroidUSBFastboot` describes a `AndroidUSBFastboot`_ resource
829+
available on a remote computer.
830+
806831
AndroidNetFastboot
807832
~~~~~~~~~~~~~~~~~~
808833
An :any:`AndroidNetFastboot` resource describes a network device in *Fastboot
@@ -823,6 +848,11 @@ Arguments:
823848
Used by:
824849
- `AndroidFastbootDriver`_
825850

851+
RemoteAndroidNetFastboot
852+
~~~~~~~~~~~~~~~~~~~~~~~~
853+
A :any:`RemoteAndroidNetFastboot` describes an `AndroidNetFastboot`_ resource
854+
available on a remote computer.
855+
826856
DFUDevice
827857
~~~~~~~~~
828858
A :any:`DFUDevice` resource describes a USB device in DFU (Device Firmware
@@ -840,6 +870,11 @@ Arguments:
840870
Used by:
841871
- `DFUDriver`_
842872

873+
NetworkDFUDevice
874+
~~~~~~~~~~~~~~~~
875+
A :any:`NetworkDFUDevice` describes a `DFUDevice`_ resource available on a
876+
remote computer.
877+
843878
NetworkInterface
844879
~~~~~~~~~~~~~~~~
845880
A :any:`NetworkInterface` resource describes a network adapter (such as
@@ -897,6 +932,11 @@ Used by:
897932
- `OpenOCDDriver`_
898933
- `QuartusHPSDriver`_
899934

935+
NetworkAlteraUSBBlaster
936+
~~~~~~~~~~~~~~~~~~~~~~~
937+
A :any:`NetworkAlteraUSBBlaster` describes an `AlteraUSBBlaster`_ resource
938+
available on a remote computer.
939+
900940
USBDebugger
901941
~~~~~~~~~~~
902942
A :any:`USBDebugger` resource describes a JTAG USB adapter (for example an
@@ -914,6 +954,11 @@ Arguments:
914954
Used by:
915955
- `OpenOCDDriver`_
916956

957+
NetworkUSBDebugger
958+
~~~~~~~~~~~~~~~~~~
959+
A :any:`NetworkUSBDebugger` describes a `USBDebugger`_ resource available on a
960+
remote computer.
961+
917962
SNMPEthernetPort
918963
~~~~~~~~~~~~~~~~
919964
A :any:`SNMPEthernetPort` resource describes a port on an Ethernet switch,
@@ -985,6 +1030,11 @@ Used by:
9851030
- `SigrokPowerDriver`_
9861031
- `SigrokDmmDriver`_
9871032

1033+
NetworkSigrokUSBSerialDevice
1034+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1035+
A :any:`NetworkSigrokUSBSerialDevice` describes a `SigrokUSBSerialDevice`_
1036+
resource available on a remote computer.
1037+
9881038
USBSDMuxDevice
9891039
~~~~~~~~~~~~~~
9901040
A :any:`USBSDMuxDevice` resource describes a Pengutronix
@@ -1943,9 +1993,9 @@ USB or network *Fastboot state*.
19431993
Binds to:
19441994
fastboot:
19451995
- `AndroidUSBFastboot`_
1946-
- RemoteAndroidUSBFastboot
1996+
- `RemoteAndroidUSBFastboot`_
19471997
- `AndroidNetFastboot`_
1948-
- RemoteAndroidNetFastboot
1998+
- `RemoteAndroidNetFastboot`_
19491999

19502000
Implements:
19512001
- None (yet)
@@ -1973,7 +2023,7 @@ Firmware Upgrade) mode.
19732023
Binds to:
19742024
dfu:
19752025
- `DFUDevice`_
1976-
- NetworkDFUDevice
2026+
- `NetworkDFUDevice`_
19772027

19782028
Implements:
19792029
- None (yet)
@@ -2001,9 +2051,9 @@ Consider updating your OpenOCD version when using multiple USB Blasters.
20012051
Binds to:
20022052
interface:
20032053
- `AlteraUSBBlaster`_
2004-
- NetworkAlteraUSBBlaster
2054+
- `NetworkAlteraUSBBlaster`_
20052055
- `USBDebugger`_
2006-
- NetworkUSBDebugger
2056+
- `NetworkUSBDebugger`_
20072057

20082058
Implements:
20092059
- :any:`BootstrapProtocol`
@@ -2036,7 +2086,7 @@ flash a target's QSPI.
20362086
Binds to:
20372087
interface:
20382088
- `AlteraUSBBlaster`_
2039-
- NetworkAlteraUSBBlaster
2089+
- `NetworkAlteraUSBBlaster`_
20402090

20412091
Implements:
20422092
- None
@@ -2196,7 +2246,7 @@ target power state without user interaction.
21962246
Binds to:
21972247
hub:
21982248
- `USBPowerPort`_
2199-
- NetworkUSBPowerPort
2249+
- `NetworkUSBPowerPort`_
22002250

22012251
Implements:
22022252
- :any:`PowerProtocol`
@@ -2218,7 +2268,7 @@ target power state without user interaction.
22182268
Binds to:
22192269
port:
22202270
- `SiSPMPowerPort`_
2221-
- NetworkSiSPMPowerPort
2271+
- `NetworkSiSPMPowerPort`_
22222272

22232273
Implements:
22242274
- :any:`PowerProtocol`
@@ -2265,7 +2315,7 @@ Binds to:
22652315
gpio:
22662316
- `SysfsGPIO`_
22672317
- `MatchedSysfsGPIO`_
2268-
- NetworkSysfsGPIO
2318+
- `NetworkSysfsGPIO`_
22692319

22702320
Implements:
22712321
- :any:`DigitalOutputProtocol`
@@ -2443,7 +2493,7 @@ It can set and get the current state of the resource.
24432493
Binds to:
24442494
relais:
24452495
- `DeditecRelais8`_
2446-
- NetworkDeditecRelais8
2496+
- `NetworkDeditecRelais8`_
24472497

24482498
Implements:
24492499
- :any:`DigitalOutputProtocol`
@@ -2825,7 +2875,7 @@ control a programmable power supply.
28252875
Binds to:
28262876
sigrok:
28272877
- `SigrokUSBSerialDevice`_
2828-
- NetworkSigrokUSBSerialDevice
2878+
- `NetworkSigrokUSBSerialDevice`_
28292879

28302880
Implements:
28312881
- :any:`PowerProtocol`
@@ -2856,7 +2906,7 @@ Binds to:
28562906
- `SigrokUSBDevice`_
28572907
- `NetworkSigrokUSBDevice`_
28582908
- `SigrokUSBSerialDevice`_
2859-
- NetworkSigrokUSBSerialDevice
2909+
- `NetworkSigrokUSBSerialDevice`_
28602910

28612911
Implements:
28622912
- None yet

0 commit comments

Comments
 (0)