8bc12d98e7
Refactor the document structure to align with README.Windows and fix two line-length issues so that the file is free of Markdown linter [1] errors. [1] https://github.com/jackdewinter/pymarkdown Change-Id: Iab5ca09aeed2225e43934c8c2bd952a3a4b32cd0 Signed-off-by: Marc Schink <dev@zapb.de> Reviewed-on: https://review.openocd.org/c/openocd/+/9403 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
2.0 KiB
OpenOCD for macOS
This README contains instructions that are specific to macOS.
Building
There are a few prerequisites you will need first:
- Xcode (install from the AppStore)
- Command Line Tools (install from Xcode -> Preferences -> Downloads)
- One of the following tools:
- Gentoo Prefix (https://wiki.gentoo.org/wiki/Project:Prefix/Bootstrap)
- Homebrew (https://brew.sh/)
- MacPorts (https://www.macports.org/install.php)
If you're building manually you need Texinfo version 5.0 or later. The
simplest way to get it is to use Homebrew (brew install texinfo) and
then export PATH=/usr/local/opt/texinfo/bin:$PATH.
With Gentoo Prefix you can build the release version or the latest devel version (-9999) the usual way described in the Gentoo documentation. Alternatively, install the prerequisites and build manually from the sources.
With Homebrew you can either run:
brew install [--HEAD] open-ocd
Where --HEAD asks brew to install the current Git version instead of the
lastest release.
You can also run:
brew install libtool automake libusb [hidapi] [libftdi]
to install the needed dependencies and then proceed with the manual building procedure.
For building with MacPorts you need to run:
sudo port install libtool automake autoconf pkgconfig libusb [libftdi1]
You should also specify LDFLAGS and CPPFLAGS to allow configure to use
MacPorts' libraries, so run configure like this:
LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]
See README for the generic building instructions.
If you're using a USB adapter and have a driver kext matched to it, you will need to unload it prior to running OpenOCD. E.g. with Apple driver (OS X 10.9 or later) for FTDI run:
sudo kextunload -b com.apple.driver.AppleUSBFTDI
for FTDI vendor driver use:
sudo kextunload FTDIUSBSerialDriver.kext
To learn more on the topic please refer to the official libusb FAQ: https://github.com/libusb/libusb/wiki/FAQ