chipsalliance / f4pga-examples

Example designs showing different ways to use F4PGA toolchains.
https://f4pga-examples.readthedocs.io
Apache License 2.0
264 stars 77 forks source link

udev permissions: add info to docs #239

Open tcal-x opened 2 years ago

tcal-x commented 2 years ago

The user's first experience with an FPGA board might be with this repo, so they may encounter the usual udev permission issues while doing the examples here. Add the info about how to update udev rules for the supported boards.

fyi @betocool-prog

pgielda commented 2 years ago

I would say this is both "jtag" specific (you need permissions to access a usb device if your JTAG is a usb device) and also distro specific (you can have a distro without udev), and over all its a general problem with using anything that you connect over USB when you're not running as root. So the question is if we should really be covering this. I guess in practice this is usually related to using openocd so maybe we should point to https://openocd.org/doc/html/Running.html where its stated that "On Linux, this usually involves installing a file in /etc/udev/rules.d, so OpenOCD has permissions."

Running (OpenOCD User’s Guide)
Running (OpenOCD User’s Guide)

It could be a note, probably somewhere here: https://symbiflow-examples.readthedocs.io/en/latest/building-examples.html

Btw I think we should potentially move this whole section to "running-examples.html", thats where I was looking for it (and failed)

pgielda commented 2 years ago

@kgugala

mithro commented 2 years ago

I think we should probably move to using openFPGALoader?