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.Windows

35 lines
1.2 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 Windows
----------------------------
README.Windows: MinGW-w64 is known to work for building, regular MinGW is quirky The regular MinGW doesn't work properly because it doesn't try to provide C99 compatibility currently. Change-Id: I27c1b9e1496a8c32032fab08a29cbe1124316edd Reported-by: Tomáš Voda <Voda.Tomas@seznam.cz> Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/1638 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2013-09-19 10:21:35 -05:00
You can build OpenOCD for Windows natively with either MinGW-w64/MSYS
or Cygwin (plain MinGW might work with --disable-werror but is not
recommended as it doesn't provide enough C99 compatibility).
Alternatively, one can cross-compile it using MinGW-w64 on a *nix
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
host. See README for the generic instructions.
README.Windows: MinGW-w64 is known to work for building, regular MinGW is quirky The regular MinGW doesn't work properly because it doesn't try to provide C99 compatibility currently. Change-Id: I27c1b9e1496a8c32032fab08a29cbe1124316edd Reported-by: Tomáš Voda <Voda.Tomas@seznam.cz> Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/1638 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2013-09-19 10:21:35 -05:00
Native MinGW-w64/MSYS compilation
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
-----------------------------
As MSYS doesn't come with pkg-config pre-installed, you need to add it
manually. The easiest way to do that is to download pkg-config-lite
from:
http://sourceforge.net/projects/pkgconfiglite/
README.Windows: MinGW-w64 is known to work for building, regular MinGW is quirky The regular MinGW doesn't work properly because it doesn't try to provide C99 compatibility currently. Change-Id: I27c1b9e1496a8c32032fab08a29cbe1124316edd Reported-by: Tomáš Voda <Voda.Tomas@seznam.cz> Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/1638 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2013-09-19 10:21:35 -05:00
Then simply unzip the archive to the root directory of your MinGW-w64
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
installation.
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
USB adapters
------------
You usually need to have WinUSB.sys (or libusbK.sys) driver installed
for a USB-based adapter. Some vendor software (e.g. for ST-LINKv2)
does it on its own. For the other cases the easiest way to assign
WinUSB to a device is to use the Zadig installer:
http://sourceforge.net/projects/libwdi/files/zadig/
For the old drivers that use libusb-0.1 API you might need to link
against libusb-win32 headers and install the corresponding driver with
Zadig.