srd: JTAG: Add some more docs.
[libsigrokdecode.git] / decoders / jtag / __init__.py
1 ##
2 ## This file is part of the sigrok project.
3 ##
4 ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 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 General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19 ##
20
21 '''
22 JTAG protocol decoder.
23
24 JTAG (Joint Test Action Group), a.k.a. "IEEE 1149.1: Standard Test Access Port
25 and Boundary-Scan Architecture", is a protocol used for testing, debugging,
26 and flashing various digital ICs.
27
28 TODO: Protocol details.
29
30 TODO: Protocol decoder output format description.
31
32 Details:
33 https://en.wikipedia.org/wiki/Joint_Test_Action_Group
34 http://focus.ti.com/lit/an/ssya002c/ssya002c.pdf
35 '''
36
37 from .jtag import *
38