From 2d03b61380c3fec5f6d5b744c588eb76957db138 Mon Sep 17 00:00:00 2001 From: Clifford Wolf Date: Thu, 31 Dec 2015 11:16:27 +0100 Subject: Documentation updates (install notes for OSX and Archlinux) --- docs/index.html | 17 +++++++++--- docs/notes_osx.html | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/notes_osx.md | 39 -------------------------- 3 files changed, 93 insertions(+), 43 deletions(-) create mode 100644 docs/notes_osx.html delete mode 100644 docs/notes_osx.md diff --git a/docs/index.html b/docs/index.html index 337673e..ecd4449 100644 --- a/docs/index.html +++ b/docs/index.html @@ -76,10 +76,6 @@ sudo apt-get install build-essential clang bison flex libreadline-dev \ xdot pkg-config python python3 libftdi-dev -

-If you are an Archlinux user, just install icestorm-git, arachne-pnr-git and yosys-git from the Arch User Repository (no need for the following installation steps). -

-

Installing the IceStorm Tools (icepack, icebox, iceprog):

@@ -112,6 +108,19 @@ Note: The Arachne-PNR build depends on files installed by IceStorm. Always rebui after updating your IceStorm installation.

+

+Notes for Archlinux: just install icestorm-git, arachne-pnr-git and yosys-git from the Arch User Repository (no need to follow the install instructions above). +

+ +

+Notes for OSX: Please follow the additional instructions for OSX to install on OSX. +

+ +

+Please file an issue on github if you have additional notes to +share regarding the install procedures on the operating system of your choice. +

+

What are the IceStorm Tools?

IcePack/IceUnpack

diff --git a/docs/notes_osx.html b/docs/notes_osx.html new file mode 100644 index 0000000..24b9bd9 --- /dev/null +++ b/docs/notes_osx.html @@ -0,0 +1,80 @@ + + +Project IceStorm – Notes for Installing on OSX + +

Project IceStorm – Notes for Installing on OSX

+ +

+The toolchain should be easy to install on OSX platforms. Below are a few troubleshooting items found on Mountain Lion (10.8.2). +

+ +

Installing FTDI Library

+ +

+The libftdi package (.so lib binary and the ftdi.h header) has been renamed to libftdi0, so either do: +

+ + + +

iceprog make error on "ftdi.h not found"

+ +

+Note that Mac Ports installs to /opt instead of /usr, so change the first two lines in iceprog/Makefile to: +

+ +
+LDLIBS = -L/usr/local/lib -L/opt/local/lib -lftdi -lm
+CFLAGS = -MD -O0 -ggdb -Wall -std=c99 -I/usr/local/include -I/opt/local/include/
+
+ +

+Basically you are indicating where to find the lib with -L/opt/local/lib and where to find the .h with -I/opt/local/include/. +

+ +

yosys make error on "<tuple> not found"

+ +

+This is a compiler issue, i.e., you are probably running on clang and you can circumvent this error by compiling against another compiler. +Edit the Makefile of yosys and replace the two first lines for this, i.e., comment the first line (clang) and uncomment the second (gcc): +

+ +
+#CONFIG := clang
+CONFIG := gcc
+
+ +

error "Can't find iCE FTDI USB device (vedor_id 0x0403, device_id 0x6010)." while uploading code to FPGA (e.g., "iceprog example.bin")

+ +

+You need to unload the FTDI driver. (notes below are from Mountain Lion, 10.8.2). +First check if it is running: +

+ +
+kextstat | grep FTDIUSBSerialDriver
+
+ +

+If you see if on the kextstat, we need to unload it: +

+ +
+sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver`
+
+ +

+Repeat the kextstat command and check that the driver was successfully unloaded. +

+ +

+Try running iceprog example.bin again. It should be working now. +

+ +

+Note: On newer OSes perhaps you need to also kextunload the com.apple.driver.AppleUSBFTDI driver. +

+ diff --git a/docs/notes_osx.md b/docs/notes_osx.md deleted file mode 100644 index 6b542d6..0000000 --- a/docs/notes_osx.md +++ /dev/null @@ -1,39 +0,0 @@ -# OSX Install -The toolchain should be easy to install on OSX platforms. Below are a few troubleshooting items found on Mountain Lion (10.8.2). - -## installing ftdi library -- libftdi (allows you to have .so lib binary and the ftdi.h header) -libftdi has been renamed to libftdi0, so either do: - -`port install libftdi0` (note that ports installs the tool to /opt instead of /usr, see next note) - -`brew install libftdi0` - -## iceprog make error on "ftdi.h not found" -Note that Mac Ports installs to /opt instead of /usr, so change the makefile's first two lines to: - -` LDLIBS = -L/usr/local/lib -L/opt/local/lib -lftdi -lm` - -` CFLAGS = -MD -O0 -ggdb -Wall -std=c99 -I/usr/local/include -I/opt/local/include/` - -Basically you are indicating where to find the lib with -L/opt/local/lib and where to find the .h with -I/opt/local/include/ - -## yosis make error on " not found" -This is a compiler issue, i.e., you are probably running on clang and you can circumvent this error by compiling against another compiler. -Edit the Makefile of yosis and replace the two first lines for this, i.e., comment the first line (clang) and uncomment the second (gcc): - -`#CONFIG := clang` - -` CONFIG := gcc` - -## error "Can't find iCE FTDI USB device (vedor_id 0x0403, device_id 0x6010)." while uploading code to FPGA (e.g., `iceprog example.bin`) -You need to unload the FTDI driver. (notes below are from Mountain Lion, 10.8.2). -First check if it is running: `kextstat | grep FTDIUSBSerialDriver` - -If you see if on the kextstat, we need to unload it: `sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver` - -Repeat the kextstat command and check that the driver was successfully unloaded. - -Repeat your `iceprog example.bin` - -Note: On newer OSes perhaps you need to also kextunload the `com.apple.driver.AppleUSBFTDI` -- cgit v1.2.3