• Stars
    star
    119
  • Rank 297,930 (Top 6 %)
  • Language
    C
  • License
    GNU General Publi...
  • Created over 10 years ago
  • Updated almost 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Fork of OpenOCD
Welcome to OpenOCD!
===================

OpenOCD provides on-chip programming and debugging support with a
layered architecture of JTAG interface and TAP support including:

- (X)SVF playback to facilitate automated boundary scan and FPGA/CPLD
  programming;
- debug target support (e.g. ARM, MIPS): single-stepping,
  breakpoints/watchpoints, gprof profiling, etc;
- flash chip drivers (e.g. CFI, NAND, internal flash);
- embedded TCL interpreter for easy scripting.

Several network interfaces are available for interacting with OpenOCD:
telnet, TCL, and GDB. The GDB server enables OpenOCD to function as a
"remote target" for source-level debugging of embedded systems using
the GNU GDB program (and the others who talk GDB protocol, e.g. IDA
Pro).

This README file contains an overview of the following topics:

- quickstart instructions,
- how to find and build more OpenOCD documentation,
- list of the supported hardware,
- the installation and build process,
- packaging tips.


============================
Quickstart for the impatient
============================

If you have a popular board then just start OpenOCD with its config,
e.g.:

  openocd -f board/stm32f4discovery.cfg

If you are connecting a particular adapter with some specific target,
you need to source both the jtag interface and the target configs,
e.g.:

  openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \
          -f target/ti_calypso.cfg

  openocd -f interface/stlink-v2-1.cfg -c "transport select hla_swd" \
          -f target/stm32l0.cfg

After OpenOCD startup, connect GDB with

  (gdb) target extended-remote localhost:3333


=====================
OpenOCD Documentation
=====================

In addition to the in-tree documentation, the latest manuals may be
viewed online at the following URLs:

  OpenOCD User's Guide:
    http://openocd.org/doc/html/index.html

  OpenOCD Developer's Manual:
    http://openocd.org/doc/doxygen/html/index.html

These reflect the latest development versions, so the following section
introduces how to build the complete documentation from the package.

For more information, refer to these documents or contact the developers
by subscribing to the OpenOCD developer mailing list:

	[email protected]

Building the OpenOCD Documentation
----------------------------------

By default the OpenOCD build process prepares documentation in the
"Info format" and installs it the standard way, so that "info openocd"
can access it.

Additionally, the OpenOCD User's Guide can be produced in the
following different formats:

  # If PDFVIEWER is set, this creates and views the PDF User Guide.
  make pdf && ${PDFVIEWER} doc/openocd.pdf

  # If HTMLVIEWER is set, this creates and views the HTML User Guide.
  make html && ${HTMLVIEWER} doc/openocd.html/index.html

The OpenOCD Developer Manual contains information about the internal
architecture and other details about the code:

  # NB! make sure doxygen is installed, type doxygen --version
  make doxygen && ${HTMLVIEWER} doxygen/index.html


==================
Supported hardware
==================

JTAG adapters
-------------

AICE, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432,
BCM2835, Bus Blaster, Buspirate, Chameleon, CMSIS-DAP, Cortino, DENX,
Digilent JTAG-SMT2, DLC 5, DLP-USB1232H, embedded projects, eStick,
FlashLINK, FlossJTAG, Flyswatter, Flyswatter2, Gateworks, Hoegl, ICDI,
ICEBear, J-Link, JTAG VPI, JTAGkey, JTAGkey2, JTAG-lock-pick, KT-Link,
Lisa/L, LPC1768-Stick, MiniModule, NGX, NXHX, OOCDLink, Opendous,
OpenJTAG, Openmoko, OpenRD, OSBDM, Presto, Redbee, RLink, SheevaPlug
devkit, Stellaris evkits, ST-LINK (SWO tracing supported),
STM32-PerformanceStick, STR9-comStick, sysfsgpio, TUMPA, Turtelizer,
ULINK, USB-A9260, USB-Blaster, USB-JTAG, USBprog, VPACLink, VSLLink,
Wiggler, XDS100v2, Xverve.

Debug targets
-------------

ARM11, ARM7, ARM9, AVR32, Cortex-A, Cortex-R, Cortex-M, LS102x-SAP,
Feroceon/Dragonite, DSP563xx, DSP5680xx, FA526, MIPS EJTAG, NDS32,
XScale, Intel Quark.

Flash drivers
-------------

ADUC702x, AT91SAM, AVR, CFI, DSP5680xx, EFM32, EM357, FM3, FM4, Kinetis,
LPC8xx/LPC1xxx/LPC2xxx/LPC541xx, LPC2900, LPCSPIFI, Marvell QSPI,
Milandr, NIIET, NuMicro, PIC32mx, PSoC4, SiM3x, Stellaris, STM32, STMSMI,
STR7x, STR9x, nRF51; NAND controllers of AT91SAM9, LPC3180, LPC32xx,
i.MX31, MXC, NUC910, Orion/Kirkwood, S3C24xx, S3C6400, XMC1xxx, XMC4xxx.


==================
Installing OpenOCD
==================

A Note to OpenOCD Users
-----------------------

If you would rather be working "with" OpenOCD rather than "on" it, your
operating system or JTAG interface supplier may provide binaries for
you in a convenient-enough package.

Such packages may be more stable than git mainline, where
bleeding-edge development takes place. These "Packagers" produce
binary releases of OpenOCD after the developers produces new "release"
versions of the source code. Previous versions of OpenOCD cannot be
used to diagnose problems with the current release, so users are
encouraged to keep in contact with their distribution package
maintainers or interface vendors to ensure suitable upgrades appear
regularly.

Users of these binary versions of OpenOCD must contact their Packager to
ask for support or newer versions of the binaries; the OpenOCD
developers do not support packages directly.

A Note to OpenOCD Packagers
---------------------------

You are a PACKAGER of OpenOCD if you:

- Sell dongles and include pre-built binaries;
- Supply tools or IDEs (a development solution integrating OpenOCD);
- Build packages (e.g. RPM or DEB files for a GNU/Linux distribution).

As a PACKAGER, you will experience first reports of most issues.
When you fix those problems for your users, your solution may help
prevent hundreds (if not thousands) of other questions from other users.

If something does not work for you, please work to inform the OpenOCD
developers know how to improve the system or documentation to avoid
future problems, and follow-up to help us ensure the issue will be fully
resolved in our future releases.

That said, the OpenOCD developers would also like you to follow a few
suggestions:

- Send patches, including config files, upstream, participate in the
  discussions;
- Enable all the options OpenOCD supports, even those unrelated to your
  particular hardware;
- Use "ftdi" interface adapter driver for the FTDI-based devices.


================
Building OpenOCD
================

The INSTALL file contains generic instructions for running 'configure'
and compiling the OpenOCD source code. That file is provided by
default for all GNU autotools packages. If you are not familiar with
the GNU autotools, then you should read those instructions first.

The remainder of this document tries to provide some instructions for
those looking for a quick-install.

OpenOCD Dependencies
--------------------

GCC or Clang is currently required to build OpenOCD. The developers
have begun to enforce strict code warnings (-Wall, -Werror, -Wextra,
and more) and use C99-specific features: inline functions, named
initializers, mixing declarations with code, and other tricks. While
it may be possible to use other compilers, they must be somewhat
modern and could require extending support to conditionally remove
GCC-specific extensions.

You'll also need:

- make
- libtool
- pkg-config >= 0.23 (or compatible)

Additionally, for building from git:

- autoconf >= 2.64
- automake >= 1.14
- texinfo

USB-based adapters depend on libusb-1.0 and some older drivers require
libusb-0.1 or libusb-compat-0.1. A compatible implementation, such as
FreeBSD's, additionally needs the corresponding .pc files.

USB-Blaster, ASIX Presto and OpenJTAG interface adapter
drivers need:
  - libftdi: http://www.intra2net.com/en/developer/libftdi/index.php

CMSIS-DAP support needs HIDAPI library.

Permissions delegation
----------------------

Running OpenOCD with root/administrative permissions is strongly
discouraged for security reasons.

For USB devices on GNU/Linux you should use the contrib/60-openocd.rules
file. It probably belongs somewhere in /etc/udev/rules.d, but
consult your operating system documentation to be sure. Do not forget
to add yourself to the "plugdev" group.

For parallel port adapters on GNU/Linux and FreeBSD please change your
"ppdev" (parport* or ppi*) device node permissions accordingly.

For parport adapters on Windows you need to run install_giveio.bat
(it's also possible to use "ioperm" with Cygwin instead) to give
ordinary users permissions for accessing the "LPT" registers directly.

Compiling OpenOCD
-----------------

To build OpenOCD, use the following sequence of commands:

  ./bootstrap (when building from the git repository)
  ./configure [options]
  make
  sudo make install

The 'configure' step generates the Makefiles required to build
OpenOCD, usually with one or more options provided to it. The first
'make' step will build OpenOCD and place the final executable in
'./src/'. The final (optional) step, ``make install'', places all of
the files in the required location.

To see the list of all the supported options, run
  ./configure --help

Cross-compiling Options
-----------------------

Cross-compiling is supported the standard autotools way, you just need
to specify the cross-compiling target triplet in the --host option,
e.g. for cross-building for Windows 32-bit with MinGW on Debian:

  ./configure --host=i686-w64-mingw32 [options]

To make pkg-config work nicely for cross-compiling, you might need an
additional wrapper script as described at

  http://www.flameeyes.eu/autotools-mythbuster/pkgconfig/cross-compiling.html

This is needed to tell pkg-config where to look for the target
libraries that OpenOCD depends on. Alternatively, you can specify
*_CFLAGS and *_LIBS environment variables directly, see "./configure
--help" for the details.

Parallel Port Dongles
---------------------

If you want to access the parallel port using the PPDEV interface you
have to specify both --enable-parport AND --enable-parport-ppdev, since the
the later option is an option to the parport driver.

The same is true for the --enable-parport-giveio option, you have to
use both the --enable-parport AND the --enable-parport-giveio option
if you want to use giveio instead of ioperm parallel port access
method.


==========================
Obtaining OpenOCD From GIT
==========================

You can download the current GIT version with a GIT client of your
choice from the main repository:

   git://git.code.sf.net/p/openocd/code

You may prefer to use a mirror:

   http://repo.or.cz/r/openocd.git
   git://repo.or.cz/openocd.git

Using the GIT command line client, you might use the following command
to set up a local copy of the current repository (make sure there is no
directory called "openocd" in the current directory):

   git clone git://git.code.sf.net/p/openocd/code openocd

Then you can update that at your convenience using

   git pull

There is also a gitweb interface, which you can use either to browse
the repository or to download arbitrary snapshots using HTTP:

   http://repo.or.cz/w/openocd.git

Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
each at this writing.

More Repositories

1

Arduino

Arduino IDE 1.x
Java
14,104
star
2

arduino-cli

Arduino command line tool
Go
4,327
star
3

arduino-ide

Arduino IDE 2.x
TypeScript
2,230
star
4

ArduinoCore-avr

The Official Arduino AVR core
C
1,220
star
5

arduino-pro-ide

The Arduino IDE for advanced users and developers. Experimental alpha version.
884
star
6

ArduinoCore-samd

Arduino Core for SAMD21 CPU
C
463
star
7

arduino-builder

A command line tool for compiling Arduino sketches
Go
455
star
8

arduino-create-agent

The Arduino Create Agent
Go
415
star
9

ArduinoCore-mbed

C
345
star
10

ArduinoCore-arc32

C
327
star
11

ArduinoTensorFlowLiteTutorials

Jupyter Notebook
260
star
12

library-registry

Arduino Library Manager list
244
star
13

lab-micropython-editor

Arduino Lab for MicroPython is an Integrated Development Environment (IDE) for MicroPython.
JavaScript
220
star
14

ArduinoCore-API

Hardware independent layer of the Arduino cores defining the official API
C++
202
star
15

reference-en

Editable source for the Arduino Reference
165
star
16

docs-content

Arduino documentation (docs.arduino.cc)
Python
158
star
17

openwrt-yun

A custom version of OpenWrt, targeted to the Arduino Yรบn
C
148
star
18

toolchain-avr

The AVR toolchain used by the Arduino IDE
Shell
142
star
19

arduino-language-server

An Arduino Language Server based on Clangd to Arduino code autocompletion
Go
136
star
20

nina-fw

Firmware for u-blox NINA W102 WiFi/BT module
C
135
star
21

setup-protoc

GitHub Action to setup the protoc compiler for protocol buffers
TypeScript
134
star
22

ArduinoCore-renesas

C
111
star
23

setup-task

GitHub Actions action to make Task available for use in your workflow
TypeScript
104
star
24

arduino-lint

Tool to check for problems with Arduino projects
Go
104
star
25

linino

C
103
star
26

ArduinoCore-megaavr

Arduino Core for the ATMEGA4809 CPU
C++
103
star
27

wifishield

Arduino Wifi Shield
C
92
star
28

arduino-examples

Arduino IDE bundled examples
Shell
92
star
29

ArduinoCore-nRF528x-mbedos

[Archived] Arduino core supporting mbed-enabled boards
C
86
star
30

ArduinoCore-sam

HTML
79
star
31

setup-arduino-cli

GitHub Action to setup Arduino CLI
TypeScript
76
star
32

YunBridge

Python
72
star
33

BtSerial

A Bluetooth Serial library for Processing for Android
Java
71
star
34

ArduinoAI

Arduino AI content / demos
JavaScript
71
star
35

ArduinoCloudProviderExamples

Examples of how to connect various Arduino boards to cloud providers.
C
71
star
36

tutorials

C++
70
star
37

openwrt-packages-yun

Makefile
66
star
38

compile-sketches

GitHub Actions action that checks whether Arduino sketches compile and produces a report of data from the compilations
Python
65
star
39

AIoT-Dev-Summit-2019

C++
56
star
40

RXTX

Arduino version of RXTX
Shell
55
star
41

arduino-fwuploader

A Command Line Tool made to update the firmware and/or add SSL certificates for any Arduino board equipped with WINC or NINA Wi-Fi module.
Go
52
star
42

YunWebUI

Arduino/Genuino Yรบn or Yรบn Shield Web panel
JavaScript
51
star
43

arduino-preprocessor

Parses an Arduino Sketch and converts it into valid C++ source code
C++
49
star
44

Arduino-Science-Journal-Android

Use the sensors in your mobile devices to perform science experiments. Science doesnโ€™t just happen in the classroom or labโ€”tools like Science Journal let you see how the world works with just your phone.
Java
48
star
45

nicla-sense-me-fw

Arduino Nicla Sense ME resources (libraries, bootloader, host pc utilities)
C
47
star
46

language

This repository serves a central entry point to discussions concerning the Arduino Language.
46
star
47

arduino-lint-action

GitHub Actions action to check Arduino projects for problems
TypeScript
44
star
48

go-apt-client

Go
41
star
49

summer-of-code

Arduino @ Google Summer of Code
40
star
50

ArduinoCore-primo

Arduino core for nrf52 cpu
C
39
star
51

arduino-iot-js

Arduino IoT Cloud - Javascript SDK
JavaScript
38
star
52

ArduinoISP

C
37
star
53

TFTP-Bootloader

An unfinished TFTP bootloader for Arduino Ethernet
C
37
star
54

EduIntro

Arduino library aimed at making super-fast introductory workshops to Arduino. Based on the idea of having components as objects in the code.
C++
37
star
55

arduino-connector

Connector to the Arduino Create Cloud and IoT platform
Go
36
star
56

avrdude-build-script

avrdude build scripts for Arduino/Genuino
Shell
34
star
57

actions

Collection of custom Github actions
Python
34
star
58

arduino-create-agent-js-client

JS module providing discovery of the Arduino Create Plugin and communication with it
JavaScript
33
star
59

arduino-iot-cloud-py

Arduino IoT Cloud Python Client.
Python
28
star
60

mcuboot-arduino-stm32h7

C
27
star
61

uno-r4-wifi-usb-bridge

C++
27
star
62

arduino-usb-scanner

Tool that scans the USB bus autodetecting Arduino boards and their serial port names
26
star
63

uno-r4-library-compatibility

25
star
64

arduinoOTA

Go
25
star
65

rp2040tools

Go
23
star
66

iot-client-py

Python client for Arduino IoT API
Python
23
star
67

astyle

Scripts and patches used to build astyle, a code formatter used by the Arduino IDE
Shell
23
star
68

vscode-arduino-tools

Arduino Language Server extension for VS Code
TypeScript
23
star
69

arduino-cli-example

C++
23
star
70

ArduinoModule-CMSIS-Atmel

Atmel Smart ARM devices CMSIS module for Arduino IDE
C
23
star
71

iot-client-js

Javascript client for Arduino IoT API
JavaScript
23
star
72

mkrwan1300-fw

C++
22
star
73

dfu-utils-cross

scripts to compile (and cross-compile from a Linux machine) dfu-utils package for Linux (x86_64, x86, arm), OSX and Windows.
C
22
star
74

Arduino-Science-Journal-iOS

Use the sensors in your mobile devices to perform science experiments. Science doesnโ€™t just happen in the classroom or labโ€”tools like Science Journal let you see how the world works with just your phone.
Swift
22
star
75

Tests

Arduino
21
star
76

arduino-flash-tools

Arduino Tools for Create
C
21
star
77

HMC5983

Proof of concept of an Arduino library for Honeywell's HMC5983 magnetic sensor.
C++
20
star
78

serial-discovery

An Arduino IDE pluggable-discovery for Serial ports
Go
19
star
79

ethernet-bootloader

TFTP Bootloader for the Arduino Ethernet Board
C
19
star
80

iot-client-go

Go client for Arduino IoT API
Go
19
star
81

mdns-discovery

mdns (bonjour) pluggable discovery
Go
18
star
82

arduino-cloud-cli

Go
16
star
83

lab-micropython-installer

This repository hosts the entire code of the Arduino MicroPython Installer tool
C
16
star
84

cpp-test-action

A GitHub Actions action for testing C/C++ projects
15
star
85

serial-monitor

Arduino pluggable monitor for serial ports
Go
15
star
86

ctags

A mix of ctags and anjuta-tags for the perfect C++ ctags
C
15
star
87

livecast

Code for the examples presented at the Arduino Livecasts
C++
15
star
88

report-size-deltas

GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
Python
14
star
89

openwrt-yun-1505

Updated build system for OpenWrt - Yun family boards
C
14
star
90

reference-pt

Portuguese version of the Arduino Reference
14
star
91

portenta-containers

TypeScript
14
star
92

the-things-conference

C
13
star
93

WiFi101-FirmwareUpdater-Plugin

WiFi101 Firmware Updater Tool for Arduino IDE
Java
13
star
94

reference-fr

12
star
95

libraries-repository-engine

Arduino Library Manager index manager
Go
12
star
96

lmp-manifest

Shell
12
star
97

season-of-docs

Arduino and Google's Season of Docs 2019
12
star
98

tooling-project-assets

A collection of reusable assets for Arduino tooling projects
Python
12
star
99

lede-yun

C
11
star
100

cloud-examples

Examples for Arduino Cloud
JavaScript
11
star