[patch] bug fixes and documentation improvements by Greg Alexander

[fw/stlink] / README

diff --git a/README b/README
index 920786ebf407b57d062bafbfbba5ac5484630004..c251be1616580d0064391b9d6c3c65df43616b78 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,9 @@
 HOWTO
 =====
 
+First, load the sg kernel module.
+# modprobe sg
+
 To run the gdb server, do (you do not need sudo if you have set up
 permissions correctly):
 $ make -C build && sudo ./build/st-util 1234 /dev/sg1
@@ -26,6 +29,28 @@ Starting program: /home/whitequark/ST/apps/bally/firmware.elf
 Remember that you can shorten the commands. `tar ext :1111' is good enough
 for GDB.
 
+Setting up udev rules
+=====================
+
+For convenience, you may install udev rules file, 10-stlink.rules, located
+in the root of repository. You will need to copy it to /etc/udev/rules.d,
+and then either reboot or execute
+$ udevadm control --reload-rules
+
+Udev will now create a /dev/stlink file, which will point at appropriate
+/dev/sgX device. Good to not accidentally start debugging your flash drive.
+
+Setting up modprobe rules
+=========================
+
+You may install a modprobe rules file, stlink.modprobe.conf, located in
+the root of the repository.  You will need to copy it to /etc/modprobe.d
+and then 
+  $ rmmod usb-storage
+If you have usb-storage built as a module, then this will cause it to be
+loaded with a "quirks" parameter that will cause it to ignore the STLink,
+rather than causing repeated errors and resets.
+
 Running programs from SRAM
 ==========================