OPENOCD(1)

💖 OPENOCD(1) 💖

okay bestie, sit DOWN, because we're about to talk about openocd — a free and open on-chip debugging, in-system programming and boundary-scan testing tool for ARM and MIPS systems. she's giving General Commands Manual energy and honestly? iconic. let's get into it 🫶

---

✨ NAME ✨

openocd — A free and open on-chip debugging, in-system programming and boundary-scan testing tool for ARM and MIPS systems

---

✨ SYNOPSIS ✨

openocd [-fsdlcphv] [--file <filename>] [--search <dirname>] [--debug
<debuglevel>] [--log_output <filename>] [--command <cmd>] [--pipe]
[--help] [--version]

---

✨ DESCRIPTION ✨

so like. OpenOCD is an on-chip debugging, in-system programming and boundary-scan testing tool for various ARM and MIPS systems. no cap, that's the whole vibe. 💅

the debugger uses an IEEE 1149-1 compliant JTAG TAP bus master to access on-chip debug functionality available on ARM based microcontrollers or system-on-chip solutions. and for MIPS systems? the EJTAG interface is supported. she does both, she contains multitudes. 🦋

user interaction is realized through:

• a telnet command line interface
• a gdb (the GNU debugger) remote protocol server
• a simplified RPC connection that can be used to interface with OpenOCD's Jim Tcl engine

OpenOCD supports various different types of JTAG interfaces/programmers — pls check the openocd info page for the complete list, bestie, I'm not gonna list them all here, that's a whole other saga. 🌸

---

✨ OPTIONS ✨

• -f, --file <filename> — this is a shortcut for a -c "[script <filename>]" command, using a search path to load the configuration file <filename>. in order to specify multiple config files, you can use multiple --file arguments. If no such -c options are included, the first config file openocd.cfg in the search path will be used. 🎀
• -s, --search <dirname> — add <dirname> to the search path used for config files and scripts. the search path begins with the current directory, then includes these additional directories before other components such as the standard OpenOCD script libraries. she's queued up in order, periodt.
• -d, --debug <debuglevel> — set debug level. possible values are:
  • 0 (errors)
  • 1 (warnings)
  • 2 (informational messages)
  • 3 (debug messages)

the default level is 2. 👑

• -l, --log_output <filename> — redirect log output to the file <filename>. per default the log output is printed on stderr. so if you don't say anything, she's yapping straight to stderr, iykyk.
• -c, --command <cmd> — add the command <cmd> to a list of commands executed on server startup. 🚨 note that you will need to explicitly invoke init if the command requires access to a target or flash. don't forget it, bestie, or she'll just sit there like 👁️👄👁️
• -p, --pipe — use pipes when talking to gdb. 💬
• -h, --help — show a help text and exit. classic.
• -v, --version — show version information and exit. 🏆

---

🐛 BUGS 🐛

pls report any bugs on the mailing list at openocd-devel@lists.sourceforge.net. they wanna hear from you fr fr, don't be shy. 🙈

---

📜 LICENCE 📜

OpenOCD is covered by the GNU General Public License (GPL), version 2 or later. slay, legally speaking. ⭐

---

👀 SEE ALSO 👀

• jtag(1)

the full documentation for openocd is maintained as a Texinfo manual. If the info (or pinfo) and openocd programs are properly installed at your site, the command info openocd should give you access to the complete manual. go read it, it's giving encyclopedic. 📚

---

💜 AUTHORS 💜

please see the file AUTHORS.

this manual page was written by Uwe Hermann <uwe@hermann-uwe.de>. it is licensed under the terms of the GNU GPL (version 2 or later).

---

and that's the whole page, bestie!! 🎀✨ no gatekeeping, only open-source debugging realness. go forth and JTAG responsibly 🦋💖

November 24, 2009 — OPENOCD(1) 💅 that's the date and the source version, mwah, signing off 😭👑