zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
tinyriscv-openocd/README.Windows

61 lines
2.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 21:05:16 +00: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 15:21:35 +00: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 21:05:16 +00:00
host. See README for the generic instructions.
README.Windows: clarify the kernel drivers installation HID and composite devices need to be mentioned explicitly due to windows oddities. Change-Id: I7cdbaa50c60ceb1950c934e0249986d46c875cff Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/2506 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2015-01-27 10:37:51 +00:00
Also, the MSYS2 project provides both ready-made binaries and an easy
way to self-compile from their software repository out of the box.
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 15:21:35 +00: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 21:07:59 +00: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 15:21:35 +00: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 21:07:59 +00: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 21:05:16 +00:00
USB adapters
------------
README.Windows: clarify the kernel drivers installation HID and composite devices need to be mentioned explicitly due to windows oddities. Change-Id: I7cdbaa50c60ceb1950c934e0249986d46c875cff Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/2506 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2015-01-27 10:37:51 +00:00
For the adapters that use a HID-based protocol, e.g. CMSIS-DAP, you do
not need to perform any additional configuration.
For all the others you usually need to have WinUSB.sys (or
libusbK.sys) driver installed. 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 latest Zadig installer:
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 21:05:16 +00:00
doc: update README.Windows with new Zadig download URL As the old SF repository indicates, newer downloads have been moved to an alternate server, and 3 new releases of Zadig have already occurred there. Change-Id: I8ff967fd834e9c8dd2cce9dcbbe07e03d2b33e4a Signed-off-by: Pete Batard <pete@akeo.ie> Reviewed-on: http://openocd.zylin.com/1940 Tested-by: jenkins Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2014-02-06 19:47:46 +00:00
http://zadig.akeo.ie
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 21:05:16 +00:00
README.Windows: clarify the kernel drivers installation HID and composite devices need to be mentioned explicitly due to windows oddities. Change-Id: I7cdbaa50c60ceb1950c934e0249986d46c875cff Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/2506 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2015-01-27 10:37:51 +00:00
When using a composite USB device, it's often necessary to assign
WinUSB.sys to the composite parent instead of the specific
interface. To do that one needs to activate an advanced option in the
Zadig installer.
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 21:05:16 +00:00
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.
ft2232: Mark interface driver as deprecated Change-Id: I5ebc924ab66c86f1902942bebc203a34d97abc64 Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1899 Reviewed-by: Paul Fertser <fercerpav@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Tested-by: Spencer Oliver <spen@spen-soft.co.uk>
2014-03-22 13:09:06 +00:00
If you need to use the same adapter with other applications that may
require another driver, a solution for Windows Vista and above is to
activate the IgnoreHWSerNum registry setting for the USB device.
That setting forces Windows to associate the driver per port instead of
per serial number, the same behaviour as when the device does not contain
a serial number. So different drivers can be installed for the adapter on
different ports and you just need to plug the adapter into the correct
port depending on which application to use.
For more information, see:
http://msdn.microsoft.com/en-us/library/windows/hardware/jj649944(v=vs.85).aspx
http://www.ftdichip.com/Support/Knowledgebase/index.html?ignorehardwareserialnumber.htm