sys64738
/
blackmagic
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

driver: Written a README.md to explain the purpose of each of the files and under what situation each should be used

This commit is contained in:
dragonmux 2022-06-08 09:54:18 -04:00 committed by Piotr Esden-Tempski
parent 8baf1e73c5
commit b4131ef637
1 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
driver/README.md Normal file
View File

@ -0,0 +1,51 @@
# Driver and access files for BMP
This directory contains a few different important files described in the sections below. These are:
* [99-blackmagic-plugdev.rules](#99-blackmagic-plugdevrules)
* [99-blackmagic-uucp.rules](#99-blackmagic-uucprules)
* [blackmagic.inf](#blackmagicinf)
* [blackmagic_upgrade.inf](#blackmagic_upgradeinf)
## 99-blackmagic-plugdev.rules
This file contains [udev](https://www.freedesktop.org/wiki/Software/systemd) rules for Linux
systems that use 'plugdev' as the access group for plug-in devices. This allows GDB, dfu-util,
and other utilities access to your Black Magic Probe hardware without needing `sudo` / root on
the computer you're trying to access the hardware from.
Distros that use 'plugdev' for this purpose include:
* Debian
* Ubuntu
* Linux Mint
## 99-blackmagic-uucp.rules
This file contains [udev](https://www.freedesktop.org/wiki/Software/systemd) rules for Linux
systems that use 'uucp' as the access group for plug-in devices. This allows GDB, dfu-util,
and other utilities access to your Black Magic Probe hardware without needing `sudo` / root on
the computer you're trying to access the hardware from.
Distros that use 'uucp' for this purpose include:
* Arch
* Manjaro
## Notes about udev rules
Our udev rules include use of the 'uaccess' tag which means either rules file should just work
on any modern distro that uses systemd. The specific user access group only matters when not using
systemd, or on older distros that predate the user access tag.
## blackmagic.inf
This is a windows driver "installation" (actually binding) information file which when
right-clicked and after clicking Install will name the serial ports Black Magic Probe provides
properly and provide them their proper vendor names.
## blackmagic_upgrade.inf
This is a windows driver "installation" (binding) information file which when right-clicked and
after clicking Install will bind suitable drivers and names to the DFU (firmware upgrade) and
Trace/Capture interfaces that Black Magic Probe provides + give them their proper vendor names.