flash: fix mini51 cygwin build issues
[openocd.git] / NEWTAPS
1 Reporting Unknown JTAG TAP IDS
2 ------------------------------
3
4 If OpenOCD reports an UNKNOWN or Unexpected Tap ID please report it to
5 the development mailing list - However - keep reading.
6
7 openocd-devel@lists.sourceforge.net.
8
9 ========================================
10
11 About "UNEXPECTED" tap ids.
12
13   Before reporting an "UNEXPECTED TAP ID" - take a closer look.
14   Perhaps you have your OpenOCD configured the wrong way, maybe you
15   have the tap configured the wrong way? Or something else is wrong.
16   (Remember: OpenOCD does not stop if the tap is not present)
17
18   This "tap id check" is there for a purpose.
19   The goal is to help get the *right* configuration.
20
21 The idea is this:
22
23   Every JTAG tap is suppose to have "a unique 32bit tap id" number.
24   They are suppose to be "sort of unique" but they are not.  There are
25   no guarantees.
26
27 Version Number Changes:
28
29   Sometimes, the tap ID only differs by VERSION number. If so - it's
30   not a big deal.  Please do report this information.  We'd like to
31   know about it.
32
33   For example
34
35 Error:  ERROR: Tap: s3c4510.cpu - Expected id: 0x3f0f0f0f, Got: 0x1f0f0f0f
36 Error:  ERROR: expected: mfg: 0x787, part: 0xf0f0, ver: 0x3
37 Error:  ERROR:      got: mfg: 0x787, part: 0xf0f0, ver: 0x1
38
39 ========================================
40
41 Updating the Tap ID number your self
42
43   Why do this? You just want the warning to go away.  And don't want
44   to update your version/instance of OpenOCD.
45
46   On simple systems, to fix this problem, in your "openocd.cfg" file,
47   override the tap id.  Depending on the tap, add one of these 3
48   commands:
49
50         set CPUTAPID   newvalue
51   or    set BSTAPID    newvalue
52   or    set FLASHTAPID newvalue
53   or    set ETMTAPID   newvalue
54
55   Where "newvalue" is the new value you are seeing.
56
57   On complex systems, (with many taps and chips) you probably have a
58   custom configuration file. Its is more complicated, you're going to
59   have to read through the configuration files
60
61 ========================================
62
63 What to send:
64
65 Cut & paste the output of OpenOCD that pointed you at this file.
66
67 Please include the VERSION number of OpenOCD you are using.
68
69 And please include the information below.
70
71 ========================================
72
73 A) The JTAG TAP ID code.
74
75 This is always a 32bit hex number.
76
77 Examples:
78     0x1f0f0f0f - is an old ARM7TDMI
79     0x3f0f0f0f - is a newer ARM7TDMI
80     0x3ba00477 - is an ARM cortex M3
81
82 Some chips have multiple JTAG taps - be sure to list
83 each one individually - ORDER is important!
84
85 ========================================
86 B) The maker of the part
87
88 Examples:
89     Xilinx, Atmel, ST Micro Systems, Freescale
90
91 ========================================
92 C) The family of parts it belongs to
93
94 Examples:
95    "NXP LPC Series"
96    "Atmel SAM7 Series"
97
98 ========================================
99
100 D) The actual part number on the package
101
102    For example: "S3C45101x01"
103
104 ========================================
105
106 E) What type of board it is.
107
108 ie: a "commercial off the self eval board" that one can purchase (as
109 opposed to your private internal custom board)
110
111 For example: ST Micro systems has Eval boards, so does Analog Devices
112
113 Or - if it is inside something "hackers like to hack" that information
114 is helpful too.
115
116 For example: A consumer GPS unit or a cellphone
117
118 ========================================
119
120 (F)   The maker of the board
121         ie: Olimex, LogicPD, Freescale(eval board)
122
123 ========================================
124
125 (G)   Identifying information on the board.
126
127       Not good:   "iar red ST eval board"
128
129       Really good: "IAR STR912-SK evaluation board"
130
131 ========================================
132
133 (H) Are there other interesting (JTAG) chips on the board?
134
135     ie: An FPGA or CPLD ...
136
137 ========================================
138
139 (I) What target config files need updating?
140
141     In fact it's best if you submit a patch with those
142     updates.  Most of the other information listed here
143     is just to help create a good patch.
144
145 ========================================