interesting
/
riscv-openocd
mirror of https://github.com/riscv/riscv-openocd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
riscv-openocd/README.OSX

35 lines
1.3 KiB
Plaintext
Raw Normal View History

README* refactoring This is an attempt to bring the README files in line with the current status of the OpenOCD development. - remove some obsolete information and duplicated instructions - reword some statements - restructure in a way more appealing to a regular user - add a supported hardware list to allow a potential user to determine if his/her usecase is covered by a freetext keyword search through the document - Add OSX notes (courtesy GrizzlyAdams and inca) Since most ftdi-based adapters are now covered by the ftdi driver, I think it's ok to remove some of the libftdi/ftd2xx instructions, the few users who still need them should refer to upstream docs instead. I'm not sure if README.Windows should come with the DOS line endings, but i'd expect many windows users to use their silly notepad to view it, and notepad ignores LF apparently. (Decided to use LF anyway.) I understand discussing and reviewing such a massive README change is a somewhat demanding task but I feel it's a necessity to move forward maintaining proper documentation. Change-Id: Idfde3014c72dd5c32ad292ee1ab205322e51a138 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1503 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2013-09-11 16:05:16 -05:00
Building OpenOCD for OSX
------------------------
There are a few prerequisites you will need first:
- Xcode 4 (install from the AppStore)
- Command Line Tools (install from Xcode 4 -> Preferences -> Downloads)
- MacPorts (http://www.macports.org/install.php)
or
- Homebrew (http://mxcl.github.io/homebrew/)
libusb: require pkg-config support An alternative approach to show how much cleaner the pure pkg-config way is. This changes the discovery procedures for libusb-1.0 and libusb-0.1, making them depend on pkg-config being properly installed and configured, including the necessary build host configuration for the cross-builds (see http://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.html) It should make it possible to compile OpenOCD without changes and extra effort on GNU/Linux, FreeBSD users would need to supply a .pc file for their libusb implementation or add LIBUSB1_LIBS and LIBUSB1_CFLAGS to the configure environment. Change-Id: I826e378dd1e0d101a549a573b2c63212a7e00b64 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1467 Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Tested-by: Spencer Oliver <spen@spen-soft.co.uk>
2013-09-11 16:07:59 -05:00
libtool, automake, autoconf, pkg-config and libusb can be easily
installed via MacPorts:
sudo port install libtool automake autoconf pkgconfig libusb [libusb-compat]
README* refactoring This is an attempt to bring the README files in line with the current status of the OpenOCD development. - remove some obsolete information and duplicated instructions - reword some statements - restructure in a way more appealing to a regular user - add a supported hardware list to allow a potential user to determine if his/her usecase is covered by a freetext keyword search through the document - Add OSX notes (courtesy GrizzlyAdams and inca) Since most ftdi-based adapters are now covered by the ftdi driver, I think it's ok to remove some of the libftdi/ftd2xx instructions, the few users who still need them should refer to upstream docs instead. I'm not sure if README.Windows should come with the DOS line endings, but i'd expect many windows users to use their silly notepad to view it, and notepad ignores LF apparently. (Decided to use LF anyway.) I understand discussing and reviewing such a massive README change is a somewhat demanding task but I feel it's a necessity to move forward maintaining proper documentation. Change-Id: Idfde3014c72dd5c32ad292ee1ab205322e51a138 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1503 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2013-09-11 16:05:16 -05:00
or with Homebrew:
Add CMSIS-DAP information to the READMEs. Change-Id: I8c87d559adf07b0f0702fe9d388f26bf046bcb8b Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/1880 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2014-01-17 05:25:53 -06:00
brew install libtool automake libusb [libusb-compat] [hidapi]
README* refactoring This is an attempt to bring the README files in line with the current status of the OpenOCD development. - remove some obsolete information and duplicated instructions - reword some statements - restructure in a way more appealing to a regular user - add a supported hardware list to allow a potential user to determine if his/her usecase is covered by a freetext keyword search through the document - Add OSX notes (courtesy GrizzlyAdams and inca) Since most ftdi-based adapters are now covered by the ftdi driver, I think it's ok to remove some of the libftdi/ftd2xx instructions, the few users who still need them should refer to upstream docs instead. I'm not sure if README.Windows should come with the DOS line endings, but i'd expect many windows users to use their silly notepad to view it, and notepad ignores LF apparently. (Decided to use LF anyway.) I understand discussing and reviewing such a massive README change is a somewhat demanding task but I feel it's a necessity to move forward maintaining proper documentation. Change-Id: Idfde3014c72dd5c32ad292ee1ab205322e51a138 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1503 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2013-09-11 16:05:16 -05:00
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]
If you're using Homebrew, no custom flags are necessary.
See README for the generic building instructions.
README.OSX: add 10.9 specific hints Change-Id: I8c684f2964262fb0670ed74fded26676833aee10 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/2080 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2014-03-31 12:23:22 -05:00
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:
README* refactoring This is an attempt to bring the README files in line with the current status of the OpenOCD development. - remove some obsolete information and duplicated instructions - reword some statements - restructure in a way more appealing to a regular user - add a supported hardware list to allow a potential user to determine if his/her usecase is covered by a freetext keyword search through the document - Add OSX notes (courtesy GrizzlyAdams and inca) Since most ftdi-based adapters are now covered by the ftdi driver, I think it's ok to remove some of the libftdi/ftd2xx instructions, the few users who still need them should refer to upstream docs instead. I'm not sure if README.Windows should come with the DOS line endings, but i'd expect many windows users to use their silly notepad to view it, and notepad ignores LF apparently. (Decided to use LF anyway.) I understand discussing and reviewing such a massive README change is a somewhat demanding task but I feel it's a necessity to move forward maintaining proper documentation. Change-Id: Idfde3014c72dd5c32ad292ee1ab205322e51a138 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1503 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2013-09-11 16:05:16 -05:00
sudo kextunload FTDIUSBSerialDriver.kext
README.OSX: add 10.9 specific hints Change-Id: I8c684f2964262fb0670ed74fded26676833aee10 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/2080 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2014-03-31 12:23:22 -05:00
To learn more on the topic please refer to the official libusb FAQ:
https://github.com/libusb/libusb/wiki/FAQ