2-5 minor typos (#673)

* OpenBSD-Patch: Added the #include <sys/socket.h> in xvc_server.cpp to allow for compilation. Added a section to the README.md.

* Moved the Note regarding OpenBSD from the README.md into the doc/guide/troubleshooting.rst.

* reverted the README.md back to its original form.

* Removed a copy&paste error in the main.cpp file. Updated the documentation on OpenBSD.

* slight change to reflect the nomenclature of modules/devices in OpenBSD.

* "Windows" is spelled with only one "o".
This commit is contained in:
dettus 2026-05-30 11:40:19 +02:00 committed by GitHub
parent c6ca4e571b
commit 1e16f33dfb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 23 additions and 6 deletions

View File

@ -12,7 +12,7 @@
<strong><a href="https://trabucayre.github.io/openFPGALoader/guide/first-steps.html">First steps</a><a href="https://trabucayre.github.io/openFPGALoader/guide/install.html">Install</a><a href="https://trabucayre.github.io/openFPGALoader/guide/troubleshooting.html">Troubleshooting</a></strong><a href="https://trabucayre.github.io/openFPGALoader/guide/advanced.html">Advanced usage</a>
</p>
Universal utility for programming FPGAs. Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic, Cologne Chip). openFPGALoader works on Linux, Windows and macOS.
Universal utility for programming FPGAs. Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic, Cologne Chip). openFPGALoader works on Linux, Windows, macOS and OpenBSD.
Not sure if your hardware is supported? Check the hardware compatibility lists:

View File

@ -83,13 +83,28 @@ Unable to flash device on OpenBSD: `JTAG init failed with: DirtyJtag: fails to o
Certain evaluation boards may show the following error message when running openFPGAloader on OpenBSD:
.. code:: bash
fail to read data usb bulk read failed
JTAG init failed with: low level FTDI init failed
This issue is most likely caused by the uftdi module, which has already locked the device.
Disabling the module can be achieved with the following commands:
This issue is most likely caused by the uftdi(4) module, which has attached itself to the device, whereas openFPGALoader requires it to be accessible as a ugen(4) device.
Unfortunately, due to the security concept of OpenBSD, it is not possible to detach it without modifying the kernel and rebooting the system. However, there are two ways to resolve the issue: Either by patching and recompiling the kernel; or by deactivating the uftdi(4) module.
After COMMENTING OUT the problematic devices in `/usr/src/sys/dev/usb/uftdi.c`, the code would look like this:
.. code:: c
{ USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SEMC_DSS20 },
//{ USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_2232C },
{ USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_2232L },
With this manual patch applied, the steps in `https://www.openbsd.org/faq/faq5.html <https://www.openbsd.org/faq/faq5.html#Custom>` can be used to recompile the kernel.
Without recompilation, DEACTIVATING uftdi(4) can be achieved using the following commands:
.. code:: bash
# doas config -e -f -o /bsd.nouftdi /bsd
OpenBSD 7.8 (GENERIC) #54: Sun Oct 12 12:45:58 MDT 2025
deraadt@amd64.openbsd.org:/usr/src/sys/arch/amd64/compile/GENERIC
@ -105,8 +120,10 @@ Disabling the module can be achieved with the following commands:
At the boot prompt, typing in
.. code:: bash
boot> boot /bsd.nouftdi
will boot the new kernel with the disabled module.
Afterwards, openFPGALoader will access the development board as a generic USB device.
Either way, openFPGALoader will then be able to access the development board as a generic USB device via ugen(4).

View File

@ -569,7 +569,7 @@ int main(int argc, char **argv)
fpga = new CologneChip(jtag, args.bit_file, args.file_type,
args.prg_type, args.board, args.cable, args.verify, args.verbose);
#else
printError("Support for Gowin FPGAs was not enabled at compile time");
printError("Support for Cologne Chip FPGAs was not enabled at compile time");
delete(jtag);
return EXIT_FAILURE;
#endif
@ -756,7 +756,7 @@ int spi_comm(struct arguments args, const cable_t &cable,
board->reset_pin, board->done_pin, DBUS6, board->oe_pin,
args.verify, args.verbose);
#else
printError("Support for Gowin FPGAs was not enabled at compile time");
printError("Support for Cologne Chip FPGAs was not enabled at compile time");
return EXIT_FAILURE;
#endif
} else {