diff options
| author | Clifford Wolf <clifford@clifford.at> | 2015-12-31 11:16:27 +0100 |
|---|---|---|
| committer | Clifford Wolf <clifford@clifford.at> | 2015-12-31 11:18:05 +0100 |
| commit | 2d03b61380c3fec5f6d5b744c588eb76957db138 (patch) | |
| tree | 800717b251ea3235d280942a2f5f3dfc292754d5 | |
| parent | 264499a8f595aab2355e1d1bb315a5cf15708de7 (diff) | |
| download | icestorm-2d03b61380c3fec5f6d5b744c588eb76957db138.tar.gz icestorm-2d03b61380c3fec5f6d5b744c588eb76957db138.tar.bz2 icestorm-2d03b61380c3fec5f6d5b744c588eb76957db138.zip | |
Documentation updates (install notes for OSX and Archlinux)
| -rw-r--r-- | docs/index.html | 17 | ||||
| -rw-r--r-- | docs/notes_osx.html | 80 | ||||
| -rw-r--r-- | docs/notes_osx.md | 39 |
3 files changed, 93 insertions, 43 deletions
diff --git a/docs/index.html b/docs/index.html index 337673e..ecd4449 100644 --- a/docs/index.html +++ b/docs/index.html @@ -77,10 +77,6 @@ sudo apt-get install build-essential clang bison flex libreadline-dev \ </pre> <p> -If you are an Archlinux user, just install <a href="https://aur.archlinux.org/packages/icestorm-git/">icestorm-git</a>, <a href="https://aur.archlinux.org/packages/arachne-pnr-git/">arachne-pnr-git</a> and <a href="https://aur.archlinux.org/packages/yosys-git/">yosys-git</a> from the Arch User Repository (no need for the following installation steps). -</p> - -<p> Installing the <a href="https://github.com/cliffordwolf/icestorm">IceStorm Tools</a> (icepack, icebox, iceprog): </p> @@ -112,6 +108,19 @@ Note: The Arachne-PNR build depends on files installed by IceStorm. Always rebui after updating your IceStorm installation. </p> +<p> +<b>Notes for Archlinux:</b> just install <a href="https://aur.archlinux.org/packages/icestorm-git/">icestorm-git</a>, <a href="https://aur.archlinux.org/packages/arachne-pnr-git/">arachne-pnr-git</a> and <a href="https://aur.archlinux.org/packages/yosys-git/">yosys-git</a> from the Arch User Repository (no need to follow the install instructions above). +</p> + +<p> +<b>Notes for OSX:</b> Please follow the <a href="notes_osx.html">additional instructions for OSX</a> to install on OSX. +</p> + +<p> +Please <a href="https://github.com/cliffordwolf/icestorm/issues/new">file an issue on github</a> if you have additional notes to +share regarding the install procedures on the operating system of your choice. +</p> + <h2>What are the IceStorm Tools?</h2> <h3>IcePack/IceUnpack</h3> 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 @@ +<!DOCTYPE html> +<html><head><meta charset="UTF-8"> +<title>Project IceStorm – Notes for Installing on OSX</title> +</head><body> +<h1>Project IceStorm – Notes for Installing on OSX</h1> + +<p> +The toolchain should be easy to install on OSX platforms. Below are a few troubleshooting items found on Mountain Lion (10.8.2). +</p> + +<h2>Installing FTDI Library</h2> + +<p> +The libftdi package (.so lib binary and the ftdi.h header) has been renamed to libftdi0, so either do: +</p> + +<ul> +<li><p><tt>port install libftdi0</tt><br/> +(note that ports installs the tool to /opt instead of /usr, see next note)</p></li> +<li><p><tt>brew install libftdi0</tt></p></li> +</ul> + +<h2>iceprog make error on "ftdi.h not found"</h2> + +<p> +Note that Mac Ports installs to /opt instead of /usr, so change the first two lines in <tt>iceprog/Makefile</tt> to: +</p> + +<pre style="padding-left: 3em"> +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/ +</pre> + +<p> +Basically you are indicating where to find the lib with <tt>-L/opt/local/lib</tt> and where to find the .h with <tt>-I/opt/local/include/</tt>. +</p> + +<h2>yosys make error on "<tuple> not found"</h2> + +<p> +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): +</p> + +<pre style="padding-left: 3em"> +#CONFIG := clang +CONFIG := gcc +</pre> + +<h2>error "Can't find iCE FTDI USB device (vedor_id 0x0403, device_id 0x6010)." while uploading code to FPGA (e.g., "iceprog example.bin")</h2> + +<p> +You need to unload the FTDI driver. (notes below are from Mountain Lion, 10.8.2). +First check if it is running: +</p> + +<pre style="padding-left: 3em"> +kextstat | grep FTDIUSBSerialDriver +</pre> + +<p> +If you see if on the kextstat, we need to unload it: +</p> + +<pre style="padding-left: 3em"> +sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver` +</pre> + +<p> +Repeat the <tt>kextstat</tt> command and check that the driver was successfully unloaded. +</p> + +<p> +Try running <tt>iceprog example.bin</tt> again. It should be working now. +</p> + +<p> +Note: On newer OSes perhaps you need to also kextunload the <tt>com.apple.driver.AppleUSBFTDI</tt> driver. +</p> + 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 "<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 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` |