├── COPYING
├── COPYING.LESSER
├── JTAGduino
└── JTAGduino.ino
├── README
├── doc
├── balau_notes.txt
├── references.txt
├── serial_protocol.txt
├── tap_states.dot
└── tap_states.svg
└── test
├── host_test.py
├── jtagduino.py
└── read_idcodes.py
/COPYING:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/COPYING.LESSER:
--------------------------------------------------------------------------------
1 | GNU LESSER GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 |
9 | This version of the GNU Lesser General Public License incorporates
10 | the terms and conditions of version 3 of the GNU General Public
11 | License, supplemented by the additional permissions listed below.
12 |
13 | 0. Additional Definitions.
14 |
15 | As used herein, "this License" refers to version 3 of the GNU Lesser
16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU
17 | General Public License.
18 |
19 | "The Library" refers to a covered work governed by this License,
20 | other than an Application or a Combined Work as defined below.
21 |
22 | An "Application" is any work that makes use of an interface provided
23 | by the Library, but which is not otherwise based on the Library.
24 | Defining a subclass of a class defined by the Library is deemed a mode
25 | of using an interface provided by the Library.
26 |
27 | A "Combined Work" is a work produced by combining or linking an
28 | Application with the Library. The particular version of the Library
29 | with which the Combined Work was made is also called the "Linked
30 | Version".
31 |
32 | The "Minimal Corresponding Source" for a Combined Work means the
33 | Corresponding Source for the Combined Work, excluding any source code
34 | for portions of the Combined Work that, considered in isolation, are
35 | based on the Application, and not on the Linked Version.
36 |
37 | The "Corresponding Application Code" for a Combined Work means the
38 | object code and/or source code for the Application, including any data
39 | and utility programs needed for reproducing the Combined Work from the
40 | Application, but excluding the System Libraries of the Combined Work.
41 |
42 | 1. Exception to Section 3 of the GNU GPL.
43 |
44 | You may convey a covered work under sections 3 and 4 of this License
45 | without being bound by section 3 of the GNU GPL.
46 |
47 | 2. Conveying Modified Versions.
48 |
49 | If you modify a copy of the Library, and, in your modifications, a
50 | facility refers to a function or data to be supplied by an Application
51 | that uses the facility (other than as an argument passed when the
52 | facility is invoked), then you may convey a copy of the modified
53 | version:
54 |
55 | a) under this License, provided that you make a good faith effort to
56 | ensure that, in the event an Application does not supply the
57 | function or data, the facility still operates, and performs
58 | whatever part of its purpose remains meaningful, or
59 |
60 | b) under the GNU GPL, with none of the additional permissions of
61 | this License applicable to that copy.
62 |
63 | 3. Object Code Incorporating Material from Library Header Files.
64 |
65 | The object code form of an Application may incorporate material from
66 | a header file that is part of the Library. You may convey such object
67 | code under terms of your choice, provided that, if the incorporated
68 | material is not limited to numerical parameters, data structure
69 | layouts and accessors, or small macros, inline functions and templates
70 | (ten or fewer lines in length), you do both of the following:
71 |
72 | a) Give prominent notice with each copy of the object code that the
73 | Library is used in it and that the Library and its use are
74 | covered by this License.
75 |
76 | b) Accompany the object code with a copy of the GNU GPL and this license
77 | document.
78 |
79 | 4. Combined Works.
80 |
81 | You may convey a Combined Work under terms of your choice that,
82 | taken together, effectively do not restrict modification of the
83 | portions of the Library contained in the Combined Work and reverse
84 | engineering for debugging such modifications, if you also do each of
85 | the following:
86 |
87 | a) Give prominent notice with each copy of the Combined Work that
88 | the Library is used in it and that the Library and its use are
89 | covered by this License.
90 |
91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license
92 | document.
93 |
94 | c) For a Combined Work that displays copyright notices during
95 | execution, include the copyright notice for the Library among
96 | these notices, as well as a reference directing the user to the
97 | copies of the GNU GPL and this license document.
98 |
99 | d) Do one of the following:
100 |
101 | 0) Convey the Minimal Corresponding Source under the terms of this
102 | License, and the Corresponding Application Code in a form
103 | suitable for, and under terms that permit, the user to
104 | recombine or relink the Application with a modified version of
105 | the Linked Version to produce a modified Combined Work, in the
106 | manner specified by section 6 of the GNU GPL for conveying
107 | Corresponding Source.
108 |
109 | 1) Use a suitable shared library mechanism for linking with the
110 | Library. A suitable mechanism is one that (a) uses at run time
111 | a copy of the Library already present on the user's computer
112 | system, and (b) will operate properly with a modified version
113 | of the Library that is interface-compatible with the Linked
114 | Version.
115 |
116 | e) Provide Installation Information, but only if you would otherwise
117 | be required to provide such information under section 6 of the
118 | GNU GPL, and only to the extent that such information is
119 | necessary to install and execute a modified version of the
120 | Combined Work produced by recombining or relinking the
121 | Application with a modified version of the Linked Version. (If
122 | you use option 4d0, the Installation Information must accompany
123 | the Minimal Corresponding Source and Corresponding Application
124 | Code. If you use option 4d1, you must provide the Installation
125 | Information in the manner specified by section 6 of the GNU GPL
126 | for conveying Corresponding Source.)
127 |
128 | 5. Combined Libraries.
129 |
130 | You may place library facilities that are a work based on the
131 | Library side by side in a single library together with other library
132 | facilities that are not Applications and are not covered by this
133 | License, and convey such a combined library under terms of your
134 | choice, if you do both of the following:
135 |
136 | a) Accompany the combined library with a copy of the same work based
137 | on the Library, uncombined with any other library facilities,
138 | conveyed under the terms of this License.
139 |
140 | b) Give prominent notice with the combined library that part of it
141 | is a work based on the Library, and explaining where to find the
142 | accompanying uncombined form of the same work.
143 |
144 | 6. Revised Versions of the GNU Lesser General Public License.
145 |
146 | The Free Software Foundation may publish revised and/or new versions
147 | of the GNU Lesser General Public License from time to time. Such new
148 | versions will be similar in spirit to the present version, but may
149 | differ in detail to address new problems or concerns.
150 |
151 | Each version is given a distinguishing version number. If the
152 | Library as you received it specifies that a certain numbered version
153 | of the GNU Lesser General Public License "or any later version"
154 | applies to it, you have the option of following the terms and
155 | conditions either of that published version or of any later version
156 | published by the Free Software Foundation. If the Library as you
157 | received it does not specify a version number of the GNU Lesser
158 | General Public License, you may choose any version of the GNU Lesser
159 | General Public License ever published by the Free Software Foundation.
160 |
161 | If the Library as you received it specifies that a proxy can decide
162 | whether future versions of the GNU Lesser General Public License shall
163 | apply, that proxy's public statement of acceptance of any version is
164 | permanent authorization for you to choose that version for the
165 | Library.
166 |
--------------------------------------------------------------------------------
/JTAGduino/JTAGduino.ino:
--------------------------------------------------------------------------------
1 | /* This file is part of JTAGduino project.
2 | *
3 | * Copyright 2011 Francesco Balducci
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Lesser General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Lesser General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | void set_array_bit(int i_bit, byte *data, int value) {
20 | int i_byte;
21 | byte mask;
22 |
23 | i_byte = i_bit >> 3; // floor(i_bit/8)
24 | mask = 1<<(i_bit&0x7);
25 | if(value == 0) {
26 | data[i_byte] &= ~mask;
27 | } else {
28 | data[i_byte] |= mask;
29 | }
30 | }
31 |
32 | int get_array_bit(int i_bit, const byte *data) {
33 | int i_byte;
34 | byte mask;
35 | i_byte = i_bit >> 3; // floor(i_bit/8)
36 | mask = 1<<(i_bit&0x7);
37 | return ((data[i_byte]&mask)==0)?0:1;
38 | }
39 |
40 | /* JTAG and digital pins functionality */
41 |
42 | enum jtag_pins {
43 | TCK = 0,
44 | TMS = 1,
45 | TDI = 2,
46 | TDO = 3,
47 | TRST = 4,
48 |
49 | N_JTAG_PINS = 5,
50 | };
51 |
52 | enum jtag_errors {
53 | JTAG_NO_ERROR = 0,
54 | JTAG_ERROR_BAD_PIN = -1,
55 | JTAG_ERROR_BAD_SPEED = -2,
56 | JTAG_ERROR_BAD_SEQUENCE_LEN = -3,
57 | };
58 |
59 | enum jtag_constants {
60 | JTAG_MAX_SPEED_KHZ = 500,
61 | JTAG_MAX_SEQUENCE_LEN = 256,
62 | JTAG_MAX_SEQUENCE_LEN_BYTES = JTAG_MAX_SEQUENCE_LEN/8, //32
63 | };
64 |
65 | int jtag_pin_map[N_JTAG_PINS] = { 2, 3, 4, 5, 6 };
66 | const int jtag_pin_dir[N_JTAG_PINS] = { OUTPUT, OUTPUT, OUTPUT, INPUT, OUTPUT };
67 | unsigned long jtag_last_tck_micros;
68 | unsigned long jtag_min_tck_micros;
69 |
70 | void jtag_setup() {
71 | int i_pin;
72 | for(i_pin = 0; i_pin < N_JTAG_PINS; i_pin++) {
73 | pinMode(jtag_pin_map[i_pin], jtag_pin_dir[i_pin]);
74 | }
75 | jtag_last_tck_micros = micros();
76 | jtag_min_tck_micros = 1;
77 | }
78 |
79 | int jtag_write_pin(int pin, int value) {
80 | if(pin >= N_JTAG_PINS || pin < 0) {
81 | return JTAG_ERROR_BAD_PIN;
82 | }
83 | if(jtag_pin_dir[pin] != OUTPUT) {
84 | return JTAG_ERROR_BAD_PIN;
85 | }
86 | digitalWrite(jtag_pin_map[pin], value);
87 | return JTAG_NO_ERROR;
88 | }
89 |
90 | int jtag_set_pin(int pin) {
91 | return jtag_write_pin(pin, HIGH);
92 | }
93 |
94 | int jtag_clear_pin(int pin) {
95 | return jtag_write_pin(pin, LOW);
96 | }
97 |
98 | int jtag_get_pin(int pin) {
99 | if(pin >= N_JTAG_PINS || pin < 0) {
100 | return JTAG_ERROR_BAD_PIN;
101 | }
102 | if(jtag_pin_dir[pin] != INPUT) {
103 | return JTAG_ERROR_BAD_PIN;
104 | }
105 | if(digitalRead(jtag_pin_map[pin]) == HIGH)
106 | return 1;
107 | else
108 | return 0;
109 | }
110 |
111 | int jtag_pulse_high(int pin, unsigned int us) {
112 | int jtag_error;
113 | jtag_error = jtag_set_pin(pin);
114 | if(jtag_error != JTAG_NO_ERROR) {
115 | return jtag_error;
116 | }
117 | delayMicroseconds(us);
118 | jtag_error = jtag_clear_pin(pin);
119 | if(jtag_error != JTAG_NO_ERROR) {
120 | return jtag_error;
121 | }
122 | return JTAG_NO_ERROR;
123 | }
124 |
125 | int jtag_pulse_low(int pin, unsigned int us) {
126 | int jtag_error;
127 | jtag_error = jtag_clear_pin(pin);
128 | if(jtag_error != JTAG_NO_ERROR) {
129 | return jtag_error;
130 | }
131 | delayMicroseconds(us);
132 | jtag_error = jtag_set_pin(pin);
133 | if(jtag_error != JTAG_NO_ERROR) {
134 | return jtag_error;
135 | }
136 | return JTAG_NO_ERROR;
137 | }
138 |
139 | int jtag_assign_pin(int jtag_pin, int digital_pin) {
140 | int i_pin;
141 | if(jtag_pin >= N_JTAG_PINS || jtag_pin < 0) {
142 | return JTAG_ERROR_BAD_PIN;
143 | }
144 | if(digital_pin > 13 || digital_pin < 0) {
145 | return JTAG_ERROR_BAD_PIN;
146 | }
147 | for(i_pin = 0; i_pin < N_JTAG_PINS; i_pin++) {
148 | if(i_pin != jtag_pin && digital_pin == jtag_pin_map[i_pin]) {
149 | return JTAG_ERROR_BAD_PIN;
150 | }
151 | }
152 | jtag_pin_map[jtag_pin] = digital_pin;
153 | pinMode(digital_pin, jtag_pin_dir[jtag_pin]);
154 | return JTAG_NO_ERROR;
155 | }
156 |
157 | int jtag_set_speed(unsigned int khz) {
158 | if(khz == 0 || khz > JTAG_MAX_SPEED_KHZ) {
159 | return JTAG_ERROR_BAD_SPEED;
160 | }
161 | // Mininum time for TCK to be stable is half the clock period.
162 | // For 100kHz of TCK frequency the period is 10us so jtag_min_tck_micros is 5us.
163 | jtag_min_tck_micros = (500U + khz - 1)/khz; //ceil
164 |
165 | return JTAG_NO_ERROR;
166 | }
167 |
168 | int jtag_clock(int tms, int tdi) {
169 | unsigned long cur_micros;
170 | int tdo;
171 |
172 | // Setting TDI and TMS before rising edge of TCK.
173 | jtag_write_pin(TDI, tdi);
174 | jtag_write_pin(TMS, tms);
175 | // Waiting until TCK has been stable for at least jtag_min_tck_micros.
176 | cur_micros = micros();
177 | if(cur_micros < jtag_last_tck_micros + jtag_min_tck_micros) {
178 | delayMicroseconds(jtag_last_tck_micros + jtag_min_tck_micros - cur_micros);
179 | }
180 | tdo = jtag_get_pin(TDO); // TDO changes on falling edge of TCK, we are reading value changed during last jtag_clock.
181 | jtag_set_pin(TCK); // Rising edge of TCK. TDI and TMS are sampled in.
182 | delayMicroseconds(jtag_min_tck_micros);
183 | jtag_clear_pin(TCK); // Falling edge of TCK. TDO is changing.
184 | jtag_last_tck_micros = micros(); // Saving timestamp of last TCK change.
185 |
186 | return tdo;
187 | }
188 |
189 | int jtag_sequence(unsigned int n, const byte *tms, const byte *tdi, byte *tdo) {
190 | unsigned int i_seq;
191 | if(n > JTAG_MAX_SEQUENCE_LEN) {
192 | return JTAG_ERROR_BAD_SEQUENCE_LEN;
193 | }
194 | for(i_seq = 0; i_seq < n; i_seq++) {
195 | set_array_bit(i_seq, tdo,
196 | jtag_clock(
197 | get_array_bit(i_seq, tms),
198 | get_array_bit(i_seq, tdi)
199 | )
200 | );
201 | }
202 | return JTAG_NO_ERROR;
203 | }
204 |
205 | /* JTAGduino command protocol */
206 |
207 | enum jtagduino_cmd {
208 | CMD_IF_VER = 0x1,
209 | CMD_FW_VER = 0x2,
210 | CMD_SET_SERIAL_SPEED = 0x3,
211 |
212 | CMD_SET_PIN = 0x10,
213 | CMD_CLEAR_PIN = 0x11,
214 | CMD_GET_PIN = 0x12,
215 | CMD_PULSE_HIGH = 0x13,
216 | CMD_PULSE_LOW = 0x14,
217 | CMD_ASSIGN_PIN = 0x15,
218 |
219 | CMD_SET_JTAG_SPEED = 0x20,
220 | CMD_JTAG_CLOCK = 0x21,
221 | CMD_JTAG_SEQUENCE = 0x22,
222 | };
223 |
224 | enum jtagduino_rsp {
225 | RSP_OK = 0,
226 | RSP_ERROR_BAD_CMD = 1,
227 | RSP_ERROR_UNKNOWN = 2,
228 | RSP_ERROR_BAD_PIN = 3,
229 | RSP_ERROR_BAD_SPEED = 4,
230 | RSP_BAD_SEQUENCE_LEN = 5,
231 | RSP_BAD_BAUD = 6,
232 | };
233 |
234 | enum jtagduino_constants {
235 | MAX_RSP_LEN = 1 + JTAG_MAX_SEQUENCE_LEN_BYTES,
236 | MAX_CMD_LEN = 1 + 1 + JTAG_MAX_SEQUENCE_LEN_BYTES + JTAG_MAX_SEQUENCE_LEN_BYTES,
237 | IF_VER_MAJOR = 0,
238 | IF_VER_MINOR = 1,
239 | FW_VER_MAJOR = 0,
240 | FW_VER_MINOR = 1,
241 | N_BAUD_RATES = 11,
242 | };
243 |
244 | enum jtagduino_parse_states {
245 | PARSE_STATE_IDLE = 0,
246 | PARSE_STATE_CMD = 1,
247 | };
248 |
249 | const long baud_rates[N_BAUD_RATES] = {
250 | 300, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200
251 | };
252 | const long DEFAULT_BAUD_RATE = 9600;
253 | byte cmd[MAX_CMD_LEN];
254 | byte rsp[MAX_RSP_LEN];
255 | long new_baud;
256 | int parse_state;
257 | int n_rx_bytes;
258 |
259 | void jtagduino_setup() {
260 | new_baud = 0;
261 | parse_state = PARSE_STATE_IDLE;
262 | n_rx_bytes = 0;
263 | }
264 |
265 | int jtagduino_parse(byte c) {
266 | int rsp_len = 0;
267 | switch(parse_state) {
268 | case PARSE_STATE_IDLE:
269 | switch(c) {
270 | case CMD_IF_VER:
271 | rsp[0] = RSP_OK;
272 | rsp[1] = IF_VER_MINOR & 0xFF;
273 | rsp[2] = (IF_VER_MINOR >> 8) & 0xFF;
274 | rsp[3] = IF_VER_MAJOR & 0xFF;
275 | rsp[4] = (IF_VER_MAJOR >> 8) & 0xFF;
276 | rsp_len = 5;
277 | break;
278 | case CMD_FW_VER:
279 | rsp[0] = RSP_OK;
280 | rsp[1] = FW_VER_MINOR & 0xFF;
281 | rsp[2] = (FW_VER_MINOR >> 8) & 0xFF;
282 | rsp[3] = FW_VER_MAJOR & 0xFF;
283 | rsp[4] = (FW_VER_MAJOR >> 8) & 0xFF;
284 | rsp_len = 5;
285 | break;
286 | case CMD_SET_SERIAL_SPEED:
287 |
288 | case CMD_SET_PIN:
289 | case CMD_CLEAR_PIN:
290 | case CMD_GET_PIN:
291 | case CMD_PULSE_HIGH:
292 | case CMD_PULSE_LOW:
293 | case CMD_ASSIGN_PIN:
294 | case CMD_SET_JTAG_SPEED:
295 | case CMD_JTAG_CLOCK:
296 | case CMD_JTAG_SEQUENCE:
297 | cmd[0] = c;
298 | n_rx_bytes = 1;
299 | parse_state = PARSE_STATE_CMD;
300 | break;
301 | default:
302 | rsp[0] = RSP_ERROR_BAD_CMD;
303 | rsp_len = 1;
304 | break;
305 | }
306 | break;
307 | case PARSE_STATE_CMD:
308 | cmd[n_rx_bytes] = c;
309 | n_rx_bytes++;
310 | switch(cmd[0]) {
311 | case CMD_SET_SERIAL_SPEED:
312 | if(n_rx_bytes == 5) {
313 | long baud = 0;
314 | int i_baud;
315 | baud += cmd[4];
316 | baud <<= 8;
317 | baud += cmd[3];
318 | baud <<= 8;
319 | baud += cmd[2];
320 | baud <<= 8;
321 | baud += cmd[1];
322 | rsp[0] = RSP_BAD_BAUD;
323 | rsp_len = 1;
324 | for(i_baud = 0; i_baud < N_BAUD_RATES; i_baud++) {
325 | if(baud_rates[i_baud] == baud) {
326 | new_baud = baud;
327 | rsp[0] = RSP_OK;
328 | break;
329 | }
330 | }
331 | parse_state = PARSE_STATE_IDLE;
332 | n_rx_bytes = 0;
333 |
334 | }
335 | break;
336 | case CMD_SET_PIN:
337 | if(n_rx_bytes == 2) {
338 | int jtag_err;
339 | jtag_err = jtag_set_pin(cmd[1]);
340 | if(jtag_err == JTAG_NO_ERROR) {
341 | rsp[0] = RSP_OK;
342 | } else {
343 | rsp[0] = RSP_ERROR_BAD_PIN;
344 | }
345 | parse_state = PARSE_STATE_IDLE;
346 | n_rx_bytes = 0;
347 | rsp_len = 1;
348 | }
349 | break;
350 | case CMD_CLEAR_PIN:
351 | if(n_rx_bytes == 2) {
352 | int jtag_err;
353 | jtag_err = jtag_clear_pin(cmd[1]);
354 | if(jtag_err == JTAG_NO_ERROR) {
355 | rsp[0] = RSP_OK;
356 | } else {
357 | rsp[0] = RSP_ERROR_BAD_PIN;
358 | }
359 | parse_state = PARSE_STATE_IDLE;
360 | n_rx_bytes = 0;
361 | rsp_len = 1;
362 | }
363 | break;
364 | case CMD_GET_PIN:
365 | if(n_rx_bytes == 2) {
366 | int val;
367 | val = jtag_get_pin(cmd[1]);
368 | if(val == JTAG_ERROR_BAD_PIN) {
369 | rsp[0] = RSP_ERROR_BAD_PIN;
370 | rsp_len = 1;
371 | } else {
372 | rsp[0] = RSP_OK;
373 | rsp[1] = val;
374 | rsp_len = 2;
375 | }
376 | parse_state = PARSE_STATE_IDLE;
377 | n_rx_bytes = 0;
378 | }
379 | break;
380 | case CMD_PULSE_HIGH:
381 | if(n_rx_bytes == 4) {
382 | int jtag_err;
383 | unsigned int us;
384 | us = cmd[2] + (cmd[3] << 8);
385 | jtag_err = jtag_pulse_high(cmd[1], us);
386 | if(jtag_err == JTAG_NO_ERROR) {
387 | rsp[0] = RSP_OK;
388 | } else {
389 | rsp[0] = RSP_ERROR_BAD_PIN;
390 | }
391 | parse_state = PARSE_STATE_IDLE;
392 | n_rx_bytes = 0;
393 | rsp_len = 1;
394 | }
395 | break;
396 | case CMD_PULSE_LOW:
397 | if(n_rx_bytes == 4) {
398 | int jtag_err;
399 | unsigned int us;
400 | us = cmd[2] + (cmd[3] << 8);
401 | jtag_err = jtag_pulse_low(cmd[1], us);
402 | if(jtag_err == JTAG_NO_ERROR) {
403 | rsp[0] = RSP_OK;
404 | } else {
405 | rsp[0] = RSP_ERROR_BAD_PIN;
406 | }
407 | parse_state = PARSE_STATE_IDLE;
408 | n_rx_bytes = 0;
409 | rsp_len = 1;
410 | }
411 | break;
412 | case CMD_ASSIGN_PIN:
413 | if(n_rx_bytes == 3) {
414 | int jtag_err;
415 | jtag_err = jtag_assign_pin(cmd[1], cmd[2]);
416 | if(jtag_err == JTAG_NO_ERROR) {
417 | rsp[0] = RSP_OK;
418 | } else {
419 | rsp[0] = RSP_ERROR_BAD_PIN;
420 | }
421 | parse_state = PARSE_STATE_IDLE;
422 | n_rx_bytes = 0;
423 | rsp_len = 1;
424 | }
425 | break;
426 | case CMD_SET_JTAG_SPEED:
427 | if(n_rx_bytes == 3) {
428 | int jtag_err;
429 | unsigned int khz;
430 | khz = cmd[1] + (cmd[2] << 8);
431 | jtag_err = jtag_set_speed(khz);
432 | if(jtag_err == JTAG_NO_ERROR) {
433 | rsp[0] = RSP_OK;
434 | } else {
435 | rsp[0] = RSP_ERROR_BAD_SPEED;
436 | }
437 | parse_state = PARSE_STATE_IDLE;
438 | n_rx_bytes = 0;
439 | rsp_len = 1;
440 | }
441 | break;
442 | case CMD_JTAG_CLOCK:
443 | if(n_rx_bytes == 2) {
444 | int tdi;
445 | int tms;
446 | int tdo;
447 | tms = cmd[1] & 1;
448 | tdi = (cmd[1] & 2) >> 1;
449 | tdo = jtag_clock(tms, tdi);
450 | rsp[0] = RSP_OK;
451 | rsp[1] = tdo;
452 | parse_state = PARSE_STATE_IDLE;
453 | n_rx_bytes = 0;
454 | rsp_len = 2;
455 | }
456 | break;
457 | case CMD_JTAG_SEQUENCE:
458 | do {
459 | int n_bytes;
460 | n_bytes = (cmd[1]+7)>>3; // ceil(cmd[1]/8)
461 | if(n_rx_bytes == 1 + 1 + n_bytes*2) {
462 | int jtag_err;
463 | jtag_err = jtag_sequence(cmd[1], &cmd[2], &cmd[2+n_bytes], &rsp[1]);
464 | if(jtag_err == JTAG_NO_ERROR) {
465 | rsp[0] = RSP_OK;
466 | rsp_len = 1 + n_bytes;
467 | } else {
468 | rsp[0] = RSP_BAD_SEQUENCE_LEN;
469 | rsp_len = 1;
470 | }
471 | parse_state = PARSE_STATE_IDLE;
472 | n_rx_bytes = 0;
473 | }
474 | } while(0);
475 | break;
476 | default:
477 | parse_state = PARSE_STATE_IDLE;
478 | n_rx_bytes = 0;
479 | rsp[0] = RSP_ERROR_UNKNOWN;
480 | rsp_len = 1;
481 | break;
482 | }
483 | break;
484 | default:
485 | parse_state = PARSE_STATE_IDLE;
486 | n_rx_bytes = 0;
487 | break;
488 | }
489 | return rsp_len;
490 | }
491 |
492 | void setup() {
493 | jtag_setup();
494 | jtagduino_setup();
495 | Serial.begin(DEFAULT_BAUD_RATE);
496 | }
497 |
498 | void loop() {
499 | if(Serial.available()) {
500 | byte c = Serial.read();
501 | int rsp_len;
502 | rsp_len = jtagduino_parse(c);
503 | if(rsp_len > 0) {
504 | Serial.write(rsp, rsp_len);
505 | }
506 | if(new_baud != 0) {
507 | /* Wait TX complete vefore changing BAUD rate */
508 | delay(27); /* worst case is 300 baud, so ~27ms to transmit a byte. */
509 | Serial.begin(new_baud);
510 | new_baud = 0;
511 | }
512 | }
513 | }
514 |
515 |
516 |
--------------------------------------------------------------------------------
/README:
--------------------------------------------------------------------------------
1 | This is the README file for the JTAGduino project.
2 | The JTAGduino project has the goal of using Arduino as a JTAG interface.
3 |
4 | Copyright (C) 2011 Francesco Balducci
5 |
6 | Copying and distribution of this file, with or without modification,
7 | are permitted in any medium without royalty provided the copyright
8 | notice and this notice are preserved.
9 |
10 | Primary repository: https://github.com/balau/JTAGduino
11 |
12 | JTAGduino is an open source project. See the file COPYING for copying conditions. (TODO: add COPYING with (L?)GPL license for software and TAPR (?) for hardware)
13 |
14 |
--------------------------------------------------------------------------------
/doc/balau_notes.txt:
--------------------------------------------------------------------------------
1 |
2 | communication protocol
3 | command-based
4 | without reliability
5 |
6 | digital pins:
7 | tdi
8 | tck
9 | tdo
10 | tms
11 | trst
12 | reset
13 | vref
14 |
15 | commands:
16 | set pin (pin)
17 | clear pin (pin)
18 | get pin (pin) --> bit value
19 | pulse high (pin, time)
20 | pulse low (pin, time)
21 | jtag sequence (number of bits, tdi[], tms[]) --> tdo[]
22 | scan chain (params?) --> ids[]
23 | jtag clock (tdi, tms) --> tdo
24 | get interface version --> minor, major
25 | get fw version --> minor, major
26 | set speed (khz)
27 | assign pin(pin, digitalpin)
28 |
29 | what's the "API" in openocd for jtag dongles?
30 | openocd contains many "drivers" in src/jtag/drivers
31 |
32 | commands are (src/jtag/commands.h):
33 |
34 | enum jtag_command_type {
35 | JTAG_SCAN = 1,
36 | JTAG_STATEMOVE = 2,
37 | JTAG_RUNTEST = 3,
38 | JTAG_RESET = 4,
39 | JTAG_PATHMOVE = 6,
40 | JTAG_SLEEP = 7,
41 | JTAG_STABLECLOCKS = 8
42 | };
43 |
44 | every driver has its own interface, like:
45 |
46 | struct jtag_interface ft2232_interface = {
47 | .name = "ft2232",
48 | .commands = ft2232_command_handlers,
49 |
50 | .init = ft2232_init,
51 | .quit = ft2232_quit,
52 | .speed = ft2232_speed,
53 | .speed_div = ft2232_speed_div,
54 | .khz = ft2232_khz,
55 | .execute_queue = ft2232_execute_queue,
56 | };
57 |
58 | execute_queue is the function that reads from a global variable the command to run.
59 | to execute commands there are "helper" functions (in src/jtag/jtag.h), like:
60 |
61 | tms_bits = tap_get_tms_path(tap_get_state(), tap_get_end_state());
62 | tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
63 |
64 | to set options there are:
65 |
66 | static const struct command_registration ft2232_command_handlers[] = {
67 | {
68 | .name = "ft2232_device_desc",
69 | .handler = &ft2232_handle_device_desc_command,
70 | .mode = COMMAND_CONFIG,
71 | .help = "set the USB device description of the FTDI FT2232 device",
72 | .usage = "description_string",
73 | },
74 | ...
75 | COMMAND_REGISTRATION_DONE
76 | };
77 |
78 | and inside there are functions that behave like "int main(int argc, char *argv[])" :
79 |
80 | COMMAND_HANDLER(ft2232_handle_layout_command)
81 | {
82 | if (CMD_ARGC == 0)
83 | return ERROR_OK;
84 |
85 | ft2232_layout = malloc(strlen(CMD_ARGV[0]) + 1);
86 | strcpy(ft2232_layout, CMD_ARGV[0]);
87 |
88 | return ERROR_OK;
89 | }
90 |
91 | log functions are:
92 | DEBUG_JTAG_IO
93 | LOG_DEBUG
94 | that are like printf.
95 |
96 | in src/jtag/interface.c there's state_follower that indicates the current JTAG state.
97 | then you use function tap_set_state to set the new state where you think you are.
98 |
99 | project should have these deliveries:
100 | - arduino code (wiring o C)
101 | - jtagduino shield schematics + layout --> PCB
102 | - openocd patches to add a jtagduino driver
103 | - API to develop from PC
104 | - text terminal to send commands
105 | - documentation of communication protocol
106 | - documentation for openocd
107 |
108 | jtag shield
109 | 10-pins connector
110 | 20-pins connector
111 | level shifters? (with jumpers/switches)
112 | form factor to make a castle of shields even with cables attached?
113 |
114 | first iteration could be only working with 5V targets, without level shifters and vrefs, and the power could come from USB cable with a jumper.
115 |
116 | additional functionalities:
117 | power supply
118 | power supply on/off da sw
119 | vref to check if it's alive
120 | vref to set input/output levels for Arduino
121 | rtck for adaptive speed
122 |
123 |
124 | openocd remote_bitbang?
125 |
126 |
--------------------------------------------------------------------------------
/doc/references.txt:
--------------------------------------------------------------------------------
1 | 1149.7-2009
2 | IEEE Standard for Reduced-Pin and Enhanced-Functionality Test Access Port and Boundary-Scan Architecture
3 | http://ieeexplore.ieee.org/xpl/freeabs_all.jsp?arnumber=5412866
4 |
5 | 1149.1-2001
6 | IEEE Standard Test Access Port and Boundary Scan Architecture
7 | http://standards.ieee.org/findstds/standard/1149.1-2001.html
8 |
9 | JTAG tutorial (Corelis)
10 | http://www.corelis.com/education/JTAG_Tutorial.htm
11 |
12 | OpenOCD user guide
13 | http://openocd.berlios.de/doc/pdf/openocd.pdf
14 |
15 | OpenOCD git repo
16 | http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd;a=summary
17 |
18 | Arduino SW reference
19 | http://arduino.cc/en/Reference/HomePage
20 |
21 | Arduino UNO schematics
22 | http://arduino.cc/en/uploads/Main/arduino-uno-schematic.pdf
23 |
24 | ATmega328 datasheet
25 | http://www.atmel.com/dyn/resources/prod_documents/doc8161.pdf
26 |
27 | Serial Vector Format Specification", Revision E, 8 March 1999
28 | http://www.asset-intertech.com/support/svf.pdf
29 |
30 | EBSp - Experimental Boundary Scan project homepage
31 | http://ebsp.sourceforge.net/
32 |
33 | TI CD40109B-Q1 CMOS quad voltage level shifter
34 | http://focus.ti.com/lit/ds/schs380/schs380.pdf
35 |
36 |
--------------------------------------------------------------------------------
/doc/serial_protocol.txt:
--------------------------------------------------------------------------------
1 | This file contains the specifications of the protocol used to communicate with
2 | JTAGduino through the serial port.
3 |
4 | The communication protocol distinguishes between the "device", which is an
5 | Arduino implementing the JTAGduino interface, and the "host", which is for
6 | example the PC that controls the JTAGduino through the USB port. The
7 | communication is always initiated by the host. The host sends a command to the
8 | device using subsequent bytes; the first byte is always a code identifying the
9 | command. The device receives the command, executes the actions specified by the
10 | command and prepares a sequence of bytes containing the response and sends it
11 | back to the host. The first byte of the response is always a code indicating the
12 | result of the operation. The protocol does not try to implement reliability, it
13 | is expected that the serial channel between the host and the device is ideal and
14 | lossless.
15 |
16 | Each command is specified in the following format:
17 |
18 |
19 | Description:
20 | .
21 | Command structure:
22 | Byte 0:
23 | Byte : . .
24 | Bytes : . .
25 | ...
26 | Length:
27 | Response structure:
28 | Byte 0: response code.
29 | ():
30 | Byte : . .
31 | Bytes : . .
32 | ...
33 | Length:
34 |
35 | Interface Version
36 | Description:
37 | Retrieves the version of the interface protocol between the host and the
38 | device. If the host and the device implement the interface with the same major
39 | and minor numbers, they are completely compatible. A host and a device
40 | implementing two protocols with the same major numbers but different minor
41 | number can communicate with each other using only functionality present in the
42 | version with the lower minor number. A host and a device implementing two
43 | protocols with different major numbers are not compatible with each other.
44 | Command structure:
45 | Byte 0: 0x01
46 | Length: 1 Byte
47 | Response structure:
48 | Byte 0: response code.
49 | RSP_OK (0x00): command received correctly.
50 | Bytes 1-2: Minor number. A 16-bit value indicating the minor version number.
51 | Bytes 3-4: Major number. A 16-bit value indicating the major version number.
52 | Length: 5 Bytes
53 |
54 | Firmware Version
55 | Description:
56 | Retrieves the version of the firmware that is running on the device.
57 | Command structure:
58 | Byte 0: 0x02
59 | Length: 1 Byte
60 | Response structure:
61 | Byte 0: response code.
62 | RSP_OK (0x00): command received correctly.
63 | Bytes 1-2: Minor number. A 16-bit value indicating the minor version number.
64 | Bytes 3-4: Major number. A 16-bit value indicating the major version number.
65 | Length: 5 Bytes
66 |
67 | Set Serial Speed
68 | Description:
69 | Changes the speed data rate in bits per seconds) of the serial
70 | communication, by setting the data rate in bits per seconds (baud). The default
71 | baud at reset is 9600. The baud rate can be one of 300, 1200, 2400, 4800, 9600,
72 | 14400, 19200, 28800, 38400, 57600, or 115200. The response is still sent in the
73 | old baud rate.
74 | Command structure:
75 | Byte 0: 0x03
76 | Byte 1-4: new baud rate. The baud is expressed as a 32-bit integer
77 | where the least significant byte is placed in byte 1 and the most significant
78 | byte is placed in byte 4 (little endian format). Length: 5 Bytes.
79 | Response structure:
80 | Byte 0: response code.
81 | RSP_OK (0x00): command received correctly. The next serial communication will
82 | be done in the new baud rate.
83 | RSP_BAD_BAUD (0x06): the new baud rate is not recognized as a valid value.
84 | Length: 1 Byte
85 |
86 |
87 |
--------------------------------------------------------------------------------
/doc/tap_states.dot:
--------------------------------------------------------------------------------
1 | digraph tap_states {
2 | node [shape=box];
3 | rankdir=TB;
4 | ranksep=0.1;
5 |
6 | reset -> idle [label=0];
7 |
8 | // on the same row
9 | subgraph noreset {
10 | rank=same;
11 |
12 | idle -> seldr [label=1];
13 | seldr -> selir [label=1];
14 | }
15 |
16 | subgraph drscan {
17 | // top to bottom
18 | seldr -> captdr [label=0];
19 | captdr -> shiftdr [label=0];
20 | shiftdr -> exit1dr [label=1];
21 | exit1dr -> pausedr [label=0];
22 | pausedr -> exit2dr [label=1];
23 | exit2dr -> updatedr [label=1];
24 | // self edges
25 | shiftdr:se -> shiftdr:ne [label=0, constraint=false];
26 | pausedr:se -> pausedr:ne [label=0, constraint=false];
27 | // other transitions
28 | captdr -> exit1dr [label=1, constraint=false];
29 | exit1dr -> updatedr [label=1, constraint=false];
30 | exit2dr -> shiftdr [label=0, constraint=false];
31 | // state names
32 | seldr [label="Select-DR-Scan"];
33 | captdr [label="Capture-DR"];
34 | shiftdr [label="Shift-DR"];
35 | exit1dr [label="Exit1-DR"];
36 | pausedr [label="Pause-DR"];
37 | exit2dr [label="Exit2-DR"];
38 | updatedr [label="Update-DR"];
39 | }
40 |
41 | subgraph irscan {
42 | // top to bottom
43 | selir -> captir [label=0];
44 | captir -> shiftir [label=0];
45 | shiftir -> exit1ir [label=1];
46 | exit1ir -> pauseir [label=0];
47 | pauseir -> exit2ir [label=1];
48 | exit2ir -> updateir [label=1];
49 | // self edges
50 | shiftir:se -> shiftir:ne [label=0, constraint=false];
51 | pauseir:se -> pauseir:ne [label=0, constraint=false];
52 | // other transitions
53 | captir -> exit1ir [label=1, constraint=false];
54 | exit1ir -> updateir [label=1, constraint=false];
55 | exit2ir -> shiftir [label=0, constraint=false];
56 | // state names
57 | selir [label="Select-IR-Scan"];
58 | captir [label="Capture-IR"];
59 | shiftir [label="Shift-IR"];
60 | exit1ir [label="Exit1-IR"];
61 | pauseir [label="Pause-IR"];
62 | exit2ir [label="Exit2-IR"];
63 | updateir [label="Update-IR"];
64 | }
65 |
66 | // self edges
67 | reset:sw -> reset:nw [label=1, constraint=false];
68 | idle:sw -> idle:nw [label=0, constraint=false];
69 | // other transitions
70 | selir -> reset [label=1, constraint=false];
71 | updatedr -> seldr [label=1, constraint=false];
72 | updateir -> seldr [label=1, constraint=false];
73 | updatedr -> idle [label=0, constraint=false];
74 | updateir -> idle [label=0, constraint=false];
75 | // state names
76 | reset [label="Test-Logic-Reset"];
77 | idle [label="Run-Test/Idle"];
78 | }
79 |
80 |
--------------------------------------------------------------------------------
/doc/tap_states.svg:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
1119 |
--------------------------------------------------------------------------------
/test/host_test.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/python
2 |
3 | # This file is part of JTAGduino project.
4 | #
5 | # Copyright 2011 Francesco Balducci
6 | #
7 | # This program is free software: you can redistribute it and/or modify
8 | # it under the terms of the GNU Lesser General Public License as published by
9 | # the Free Software Foundation, either version 3 of the License, or
10 | # (at your option) any later version.
11 | #
12 | # This program is distributed in the hope that it will be useful,
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 | # GNU General Public License for more details.
16 | #
17 | # You should have received a copy of the GNU Lesser General Public License
18 | # along with this program. If not, see .
19 |
20 | # This test needs python-serial installed and permission to access serial ports.
21 | # Your user needs to be in group "dialout" (usually)
22 | # In Debian-based distribution, you need to install python-serial package.
23 | # This script has been tested with python version 2.6.7
24 |
25 | import sys
26 | from jtagduino import *
27 |
28 | jtagduino_port = '/dev/ttyACM0'
29 | if (len(sys.argv) > 1):
30 | jtagduino_port = sys.argv[1]
31 |
32 | device = jtagduino(jtagduino_port)
33 |
34 | print 'if_ver_major = %d; if_ver_minor = %d' % device.if_ver()
35 | print 'fw_ver_major = %d; fw_ver_minor = %d' % device.fw_ver()
36 | print 'set_serial_speed(115200) = %d' % device.set_serial_speed(115200)
37 | print 'clear pin TDI rsp = %d' % device.clear_pin(jtag_pins.TDI)
38 | print 'set pin TDI rsp = %d' % device.set_pin(jtag_pins.TDI)
39 | print 'get pin TDO rsp = %d; val = %d' % device.get_pin(jtag_pins.TDO)
40 | print 'jtag_clock(1,1): rsp = %d; tdo = %d' % device.jtag_clock(1,1)
41 | print 'jtag_clock(1,0): rsp = %d; tdo = %d' % device.jtag_clock(1,0)
42 | (rsp, tdo_seq) = device.jtag_sequence([1,1,1,1], [1, 1, 0, 1])
43 | print ('jtag_sequence([1,1,1,1], [1, 1, 0, 1]), rsp = %d;' % rsp) + ' tdo_seq = ' + str(tdo_seq)
44 | (rsp, tdo_seq) = device.jtag_sequence([1] * 255, [1] * 255)
45 | print ('jtag_sequence([1] * 255, [1] * 255), rsp = %d;' % rsp) + ' tdo_seq = ' + str(tdo_seq)
46 | print 'device.set_jtag_speed(1) = %d' % device.set_jtag_speed(1)
47 | (rsp, tdo_seq) = device.jtag_sequence([1] * 255, [1] * 255)
48 | print ('jtag_sequence([1] * 255, [1] * 255), rsp = %d;' % rsp) + ' tdo_seq = ' + str(tdo_seq)
49 | sys.exit(0);
50 |
51 | #TODO: other commands
52 |
53 |
--------------------------------------------------------------------------------
/test/jtagduino.py:
--------------------------------------------------------------------------------
1 |
2 | # This file is part of JTAGduino project.
3 | #
4 | # Copyright 2011 Francesco Balducci
5 | #
6 | # This program is free software: you can redistribute it and/or modify
7 | # it under the terms of the GNU Lesser General Public License as published by
8 | # the Free Software Foundation, either version 3 of the License, or
9 | # (at your option) any later version.
10 | #
11 | # This program is distributed in the hope that it will be useful,
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | # GNU General Public License for more details.
15 | #
16 | # You should have received a copy of the GNU Lesser General Public License
17 | # along with this program. If not, see .
18 |
19 | import serial
20 | import time
21 |
22 | class jtagduino_cmd:
23 | CMD_IF_VER = 0x1
24 | CMD_FW_VER = 0x2
25 | CMD_SET_SERIAL_SPEED = 0x3
26 | CMD_SET_PIN = 0x10
27 | CMD_CLEAR_PIN = 0x11
28 | CMD_GET_PIN = 0x12
29 | CMD_PULSE_HIGH = 0x13
30 | CMD_PULSE_LOW = 0x14
31 | CMD_ASSIGN_PIN = 0x15
32 | CMD_SET_JTAG_SPEED = 0x20
33 | CMD_JTAG_CLOCK = 0x21
34 | CMD_JTAG_SEQUENCE = 0x22
35 |
36 | class jtagduino_rsp:
37 | RSP_OK = 0
38 | RSP_ERROR_BAD_CMD = 1
39 | RSP_ERROR_UNKNOWN = 2
40 | RSP_ERROR_BAD_PIN = 3
41 | RSP_ERROR_BAD_SPEED = 4
42 | RSP_BAD_SEQUENCE_LEN = 5
43 | RSP_BAD_BAUD = 6
44 |
45 | class jtag_pins:
46 | TCK = 0
47 | TMS = 1
48 | TDI = 2
49 | TDO = 3
50 | TRST = 4
51 | N_JTAG_PINS = 5
52 |
53 | class jtagduino:
54 | MAX_JTAG_SPEED_KHZ = 500
55 | BAUD_RATES = [300, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200]
56 | DEFAULT_BAUD_RATE = 9600
57 | def __init__(self, port='/dev/ttyACM0', baudrate=DEFAULT_BAUD_RATE):
58 | self.ser = serial.Serial(
59 | port = port,
60 | baudrate = baudrate,
61 | )
62 | time.sleep(1.5)
63 | self.ser.flushInput()
64 | self.ser.flushOutput()
65 | def if_ver(self):
66 | self.ser.write(chr(jtagduino_cmd.CMD_IF_VER))
67 | rsp = ord(self.ser.read(1))
68 | if (rsp == jtagduino_rsp.RSP_OK):
69 | if_ver_minor = ord(self.ser.read(1))
70 | if_ver_minor = if_ver_minor + (ord(self.ser.read(1)) * 256)
71 | if_ver_major = ord(self.ser.read(1))
72 | if_ver_major = if_ver_major + (ord(self.ser.read(1)) * 256)
73 | return (if_ver_major, if_ver_minor)
74 | else:
75 | return None
76 | def fw_ver(self):
77 | self.ser.write(chr(jtagduino_cmd.CMD_FW_VER))
78 | rsp = ord(self.ser.read(1))
79 | if (rsp == jtagduino_rsp.RSP_OK):
80 | fw_ver_minor = ord(self.ser.read(1))
81 | fw_ver_minor = fw_ver_minor + (ord(self.ser.read(1)) * 256)
82 | fw_ver_major = ord(self.ser.read(1))
83 | fw_ver_major = fw_ver_major + (ord(self.ser.read(1)) * 256)
84 | return (fw_ver_major, fw_ver_minor)
85 | else:
86 | return None
87 | def set_serial_speed(self, baud):
88 | self.ser.write(chr(jtagduino_cmd.CMD_SET_SERIAL_SPEED))
89 | self.ser.write(chr((baud >> 0) & 0xFF))
90 | self.ser.write(chr((baud >> 8) & 0xFF))
91 | self.ser.write(chr((baud >> 16) & 0xFF))
92 | self.ser.write(chr((baud >> 24) & 0xFF))
93 | rsp = ord(self.ser.read(1))
94 | if (rsp == jtagduino_rsp.RSP_OK):
95 | time.sleep(0.027) #time to switch baud rate for device, worst case.
96 | self.ser.baudrate = baud
97 | return rsp
98 | def set_pin(self, pin):
99 | self.ser.write(chr(jtagduino_cmd.CMD_SET_PIN))
100 | self.ser.write(chr(pin))
101 | rsp = ord(self.ser.read(1))
102 | return rsp
103 | def clear_pin(self, pin):
104 | self.ser.write(chr(jtagduino_cmd.CMD_CLEAR_PIN))
105 | self.ser.write(chr(pin))
106 | rsp = ord(self.ser.read(1))
107 | return rsp
108 | def get_pin(self, pin):
109 | self.ser.write(chr(jtagduino_cmd.CMD_GET_PIN))
110 | self.ser.write(chr(pin))
111 | rsp = ord(self.ser.read(1))
112 | if (rsp == jtagduino_rsp.RSP_OK):
113 | val = ord(self.ser.read(1))
114 | else:
115 | val = 0
116 | return (rsp, val)
117 | def pulse_high(self, pin, micros):
118 | self.ser.write(chr(jtagduino_cmd.CMD_PULSE_HIGH))
119 | self.ser.write(chr(pin))
120 | self.ser.write(chr((micros >> 0) & 0xFF))
121 | self.ser.write(chr((micros >> 8) & 0xFF))
122 | rsp = ord(self.ser.read(1))
123 | return rsp
124 | def pulse_low(self, pin, micros):
125 | self.ser.write(chr(jtagduino_cmd.CMD_PULSE_LOW))
126 | self.ser.write(chr(pin))
127 | self.ser.write(chr((micros >> 0) & 0xFF))
128 | self.ser.write(chr((micros >> 8) & 0xFF))
129 | rsp = ord(self.ser.read(1))
130 | return rsp
131 | def assign_pin(self, jtag_pin, arduino_pin):
132 | self.ser.write(chr(jtagduino_cmd.CMD_ASSIGN_PIN))
133 | self.ser.write(chr(jtag_pin))
134 | self.ser.write(chr(arduino_pin))
135 | rsp = ord(self.ser.read(1))
136 | return rsp
137 | def set_jtag_speed(self, khz):
138 | self.ser.write(chr(jtagduino_cmd.CMD_SET_JTAG_SPEED))
139 | self.ser.write(chr((khz >> 0) & 0xFF))
140 | self.ser.write(chr((khz >> 8) & 0xFF))
141 | rsp = ord(self.ser.read(1))
142 | return rsp
143 | def jtag_clock(self, tms, tdi):
144 | self.ser.write(chr(jtagduino_cmd.CMD_JTAG_CLOCK))
145 | jtag_in = 0
146 | if tms:
147 | jtag_in = jtag_in | 1
148 | if tdi:
149 | jtag_in = jtag_in | 2
150 | self.ser.write(chr(jtag_in))
151 | rsp = ord(self.ser.read(1))
152 | if (rsp == jtagduino_rsp.RSP_OK):
153 | tdo = ord(self.ser.read(1))
154 | else:
155 | tdo = 0
156 | return (rsp, tdo)
157 | def jtag_sequence(self, tms_seq, tdi_seq):
158 | if len(tms_seq) != len(tdi_seq):
159 | return (jtagduino_rsp.RSP_BAD_SEQUENCE_LEN, None)
160 | n_bytes = (len(tms_seq) + 7) >> 3 # ceil(len(tdi_seq)/8)
161 | i_seq = 0
162 | tms_bytes = bytearray(n_bytes)
163 | tdi_bytes = bytearray(n_bytes)
164 | while i_seq < len(tms_seq):
165 | i_byte = i_seq >> 3
166 | bit = 1<<(i_seq & 0x7)
167 | if tms_seq[i_seq]:
168 | tms_bytes[i_byte] = tms_bytes[i_byte] | bit
169 | if tdi_seq[i_seq]:
170 | tdi_bytes[i_byte] = tdi_bytes[i_byte] | bit
171 | i_seq += 1
172 | self.ser.write(chr(jtagduino_cmd.CMD_JTAG_SEQUENCE))
173 | self.ser.write(chr(len(tms_seq)))
174 | self.ser.write(tms_bytes)
175 | self.ser.write(tdi_bytes)
176 | tdo_seq = []
177 | rsp = ord(self.ser.read(1))
178 | if (rsp == jtagduino_rsp.RSP_OK):
179 | tdo_bytes = bytearray(n_bytes)
180 | for i_byte in range(n_bytes):
181 | tdo_bytes[i_byte] = ord(self.ser.read(1))
182 | i_seq = 0
183 | while i_seq < len(tms_seq):
184 | i_byte = i_seq >> 3
185 | bit = 1<<(i_seq & 0x7)
186 | if (tdo_bytes[i_byte] & bit) != 0:
187 | tdo_seq.append(1)
188 | else:
189 | tdo_seq.append(0)
190 | i_seq += 1
191 | return (rsp, tdo_seq)
192 |
193 |
194 |
--------------------------------------------------------------------------------
/test/read_idcodes.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | # This file is part of JTAGduino project.
4 | #
5 | # Copyright 2014 Francesco Balducci
6 | #
7 | # This program is free software: you can redistribute it and/or modify
8 | # it under the terms of the GNU Lesser General Public License as published by
9 | # the Free Software Foundation, either version 3 of the License, or
10 | # (at your option) any later version.
11 | #
12 | # This program is distributed in the hope that it will be useful,
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 | # GNU General Public License for more details.
16 | #
17 | # You should have received a copy of the GNU Lesser General Public License
18 | # along with this program. If not, see .
19 |
20 | # This test needs python-serial installed and permission to access serial ports.
21 | # Your user needs to be in group "dialout" (usually)
22 | # In Debian-based distribution, you need to install python-serial package.
23 | # This script has been tested with python version 2.7.8
24 |
25 | import sys
26 | from jtagduino import *
27 |
28 | def dev_id_reg_from_seq(seq):
29 | dev_id_reg = 0
30 | for i_bit in range(0, len(seq)):
31 | dev_id_reg = dev_id_reg + (seq[i_bit] << i_bit)
32 | return dev_id_reg
33 |
34 | def jtag_tap_state_move(device, tms):
35 | tdi = [0] * len(tms)
36 | (rsp, tdo) = device.jtag_sequence(tms, tdi)
37 | if rsp != 0:
38 | raise Exception('error: jtag_sequence returned %d' % rsp)
39 |
40 | def read_idcodes(device):
41 | dev_id_reg_len = 32
42 |
43 | tms_seq_idle = [1, 1, 1, 1, 1, 0]
44 | tms_seq_idle_to_shiftdr = [1, 0, 0]
45 | tms_seq_readid = [0] * (dev_id_reg_len - 1)
46 | tms_seq_readid.append(1)
47 | tdi_seq_readid = [0] * dev_id_reg_len
48 | tms_seq_exitdr_to_shiftdr = [0, 1, 0]
49 |
50 | jtag_tap_state_move(device, tms_seq_idle)
51 | jtag_tap_state_move(device, tms_seq_idle_to_shiftdr)
52 |
53 | chain_end = False
54 | taps = []
55 | while not chain_end:
56 | (rsp, tdo_seq) = device.jtag_sequence(tms_seq_readid, tdi_seq_readid)
57 | if rsp != 0:
58 | raise Exception('error: jtag_sequence returned %d' % rsp)
59 | dev_id_reg = dev_id_reg_from_seq(tdo_seq)
60 | if dev_id_reg == 0x00000000:
61 | chain_end = True
62 | jtag_tap_state_move(device, tms_seq_idle)
63 | else:
64 | taps.append(dev_id_reg)
65 | jtag_tap_state_move(device, tms_seq_exitdr_to_shiftdr)
66 |
67 | return taps
68 |
69 | if __name__ == '__main__':
70 | jtagduino_port = '/dev/ttyACM0'
71 | jtagduino_serial_baud = max(jtagduino.BAUD_RATES)
72 | jtagduino_jtag_khz = jtagduino.MAX_JTAG_SPEED_KHZ
73 |
74 | if (len(sys.argv) > 1):
75 | jtagduino_port = sys.argv[1]
76 |
77 | device = jtagduino(jtagduino_port)
78 | rsp = device.set_serial_speed(jtagduino_serial_baud)
79 | if rsp != 0: raise Exception('error: set_serial_speed returned %d' % rsp)
80 | rsp = device.set_jtag_speed(jtagduino_jtag_khz)
81 | if rsp != 0: raise Exception('error: set_jtag_speed returned %d' % rsp)
82 |
83 | taps = read_idcodes(device)
84 |
85 | print '#Taps = %d' % len(taps)
86 | print 'Device identifier registers (beginning from closest to TDO):'
87 | for tap in taps:
88 | print '0x%08X' % tap
89 |
90 |
--------------------------------------------------------------------------------