OpenOCD Free and Open On-Chip Debugging, In-System Programming and Boundary-Scan Testing Copyright (c) 2004-2007 Dominic Rath The debugger uses an IEEE 1149-1 compliant JTAG TAP bus master to access on-chip debug functionality available on ARM7 and ARM9 based microcontrollers / system-on-chip solutions. User interaction is realized through a telnet command line interface and a gdb (The GNU Debugger) remote protocol server. 1. JTAG hardware Currently, OpenOCD supports the following JTAG interfaces: - Parallel port wigglers. These devices connect to a PC's parallel port, providing direct access to the JTAG lines. The OpenOCD contains descriptions of a few Wiggler layouts, including the original 'Wiggler' design. Other layouts (i.e. mapping of parallel port pins to JTAG lines) can be added easily. Typical Wiggler speeds are around 12kByte/s code download to an ARM7's RAM. The list of supported parallel port devices includes: * Macraigor Wiggler JTAG cable * Gateworks GW16012 JTAG programmer * Xilinx DLC5 JTAG parallel cable III * Ka-Ro TRITON starterkit II JTAG cable * Lattice parallel port JTAG cable * ST FlashLINK programming cable * Wiggler 2 cable (basically a wiggler with an LED) - The Amontec JTAG Accelerator. This is a configuration for Amontec's Chameleon dongle, a parallel port interface based on a Xilinx CoolRunner CPLD. It uses the IEEE1284 EPP parallel port specification, providing many times the performance achievable with wiggler-style devices. Additional information is available on www.amontec.com. Typical JTAG Accelerator speeds are around 120-160kByte/s to an ARM7's RAM. - FTDI FT2232 based USB devices. The FT2232 (but not FT232 or FT245) features a multi-protocol synchronous serial engine (MPSSE) that can be used to run the serial JTAG protocol. There are several implemenations of FT2232 based devices: * USBJTAG: http://www.fh-augsburg.de/~hhoegl/proj/usbjtag/usbjtag.html The USBJTAG was designed by Prof. Hubert Hoegl to provide a high-speed USB interface for use with the OpenOCD. Schematics are available at the USBJTAG website, and a homebrew device can easily be built using the FTDI evaluation module DLP2232M. * OOCD-Link: http://www.joernonline.de/dw/doku.php?id=en:projects:oocdlink Similar to the USBJTAG, this design comes with free schematics, too. * Amontec JTAGkey: www.amontec.com The Amontec JTAGkey offers support for a wide variety of target voltages from 1.4V to 5V. It also allows the JTAG lines and reset signals to be tri-stated, allowing easy interfacing with a wide variety of targets. * Amontec JTAGkey-Tiny: www.amontec.com The Amontec JTAGkey offers support for a wide variety of target voltages from 2.8V to 5V. It also allows the reset signals to be tri-stated, allowing easy interfacing with a wide variety of targets. * Olimex ARM-USB-OCD: www.olimex.com The Olimex ARM-USB-OCD offers support for a wide vriety of target voltages from 2.0V to 5V. It also allows targets to be powered from the ARM-USB-OCD and features and additional RS232 UART. * eVerve Signalyzer: www.signalyzer.com The Signalyzer offers support for a wide variety of target voltages from 1.2V to 5.5V. A second connector provides access to a TTL level UART. * TinCanTools 'Flyswatter' USB JTAG programmer. * Turtelizer 2: http://www.ethernut.de/en/hardware/turtelizer/index.html Another USB JTAG programmer, with freely available schematics. It supports target voltages from 1.65V to 5.5V. * Hitex STR9-comStick: http://www.ehitex.de/p_info.php?products_id=292 A STR912FW44x microcontroller "board" with USB and JTAG functionality. * Hitex STM32-PerformanceStick: http://www.hitex.com/stm32-stick/ A STM32F103RBT6 microcontroller "board" with USB and JTAG functionality. * Luminary Micro development board evb_lm3s811 JTAG interface. * ASIX PRESTO: http://www.asix-tools.com/prg_presto.htm The ASIX PRESTO is a USB JTAG programmer for a wide range of components, e.g. microcontrollers, serial EEPROM and Flash memory chips, CPLDs and others. * usbprog: http://www.embedded-projects.net/index.php?page_id=165 The usbprog is a freely programmable USB adapter, which can (among other things) use a firmware which turns it into a JTAG programmer/debugger. * Altium universal JTAG cable All FT2232 based devices may be accessed using either FTDI's proprietary FTD2XX library (www.ftdichip.com) or using an open-source replacement from http://www.intra2net.com/de/produkte/opensource/ftdi/index.php, also included with many Linux distributions. 2. Supported cores This version of openocd supports the following ARM7/9 cores: - ARM7TDMI(-s) - ARM9TDMI - ARM920t - ARM922t - ARM926ej-s - ARM966e - Cortex-M3 Support for Intel XScale CPUs is also included: - PXA25x - PXA27x - IXP42x And support for the Marvell Feroceon CPU core as found in the Orion SoC family is included as well. 3. Host platforms OpenOCD was originally developed on x86-Linux, but has since then been ported to run on Windows/Cygwin, native Windows with MinGW, FreeBSD, IA64-Linux, AMD64-Linux, Alpha-Linux, ARM-Linux, and PowerPC OS-X. 4. Documentation Documentation for the OpenOCD is hosted in the Berlios OpenFacts Wiki at http://openfacts.berlios.de/index-en.phtml?title=Open_On-Chip_Debugger. There is also and openocd(1) manpage, the 'openocd --help' output and an OpenOCD info page (type 'info openocd'). 5. Coding Style The following rules try to describe formatting and naming conventions that should be followed to make the whole OpenOCD code look more consistent. The ultimate goal of coding style should be readability, and these rules may be ignored for a particular (small) piece of code if that makes it more readable. Formatting rules: - remove any trailing white space - use TAB characters for indentation, not spaces - displayed TAB width is 4 characters - make sure NOT to use DOS '\r\n' line feeds - do not add more than 2 empty lines to source files - do not add trailing empty lines to source files - do not use C++ style comments (//) - lines may be reasonably wide - there's no anachronistic 80 characters limit Naming rules: - identifiers use lower-case letters only - identifiers consisting of multiple words use underline characters between consecutive words - macros use upper-case letters only - structure names shall be appended with '_s' - typedefs shall be appended with '_t' Function calls: - function calls have no space between the functions name and the parameter list: my_func(param1, param2, ...) 6. Licensing OpenOCD is licensed under the terms of the GNU General Public License, see the file COPYING for details. 90' href='#n90'>90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145