Skip to content

Commit 9d3f337

Browse files
committed
doc: document adapter drivers linuxgpiod and sysfsgpio
Change-Id: If894092a7ae04bb95fa1913d2e3c8465c2d0f75c Signed-off-by: Antonio Borneo <[email protected]> Reviewed-on: http://openocd.zylin.com/5961 Tested-by: jenkins Reviewed-by: Tarek BOCHKATI <[email protected]>
1 parent 2bbd85a commit 9d3f337

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/openocd.texi

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -623,6 +623,13 @@ emulation model of target hardware.
623623
@item @b{xlnx_pcie_xvc}
624624
@* A JTAG driver exposing Xilinx Virtual Cable over PCI Express to OpenOCD as JTAG/SWD interface.
625625

626+
@item @b{linuxgpiod}
627+
@* A bitbang JTAG driver using Linux GPIO through library libgpiod.
628+
629+
@item @b{sysfsgpio}
630+
@* A bitbang JTAG driver using Linux legacy sysfs GPIO.
631+
This is deprecated from Linux v5.3; prefer using @b{linuxgpiod}.
632+
626633
@end itemize
627634

628635
@node About Jim-Tcl
@@ -3240,6 +3247,22 @@ pinout.
32403247
@end deffn
32413248

32423249

3250+
@deffn {Interface Driver} {linuxgpiod}
3251+
Linux provides userspace access to GPIO through libgpiod since Linux kernel version v4.6.
3252+
The driver emulates either JTAG and SWD transport through bitbanging.
3253+
3254+
See @file{interface/dln-2-gpiod.cfg} for a sample config.
3255+
@end deffn
3256+
3257+
3258+
@deffn {Interface Driver} {sysfsgpio}
3259+
Linux legacy userspace access to GPIO through sysfs is deprecated from Linux kernel version v5.3.
3260+
Prefer using @b{linuxgpiod}, instead.
3261+
3262+
See @file{interface/sysfsgpio-raspberrypi.cfg} for a sample config.
3263+
@end deffn
3264+
3265+
32433266
@deffn {Interface Driver} {openjtag}
32443267
OpenJTAG compatible USB adapter.
32453268
This defines some driver-specific commands:

0 commit comments

Comments
 (0)