2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2016 Elias Oenal <sigrok@eliasoenal.com>
5 ## All rights reserved.
7 ## Redistribution and use in source and binary forms, with or without
8 ## modification, are permitted provided that the following conditions are met:
10 ## 1. Redistributions of source code must retain the above copyright notice,
11 ## this list of conditions and the following disclaimer.
12 ## 2. Redistributions in binary form must reproduce the above copyright notice,
13 ## this list of conditions and the following disclaimer in the documentation
14 ## and/or other materials provided with the distribution.
16 ## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 ## AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 ## IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 ## ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 ## LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 ## CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 ## SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 ## INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 ## CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 ## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 ## POSSIBILITY OF SUCH DAMAGE.
29 import sigrokdecode as srd
31 class Decoder(srd.Decoder):
35 longname = 'Management Data Input/Output'
36 desc = 'Half-duplex sync serial bus for MII management between MAC and PHY.'
41 {'id': 'mdc', 'name': 'MDC', 'desc': 'Clock'},
42 {'id': 'mdio', 'name': 'MDIO', 'desc': 'Data'},
45 {'id': 'show_debug_bits', 'desc': 'Show debug bits',
46 'default': 'no', 'values': ('yes', 'no')},
49 ('bit-val', 'Bit value'),
50 ('bit-num', 'Bit number'),
52 ('frame-idle', 'Bus idle state'),
53 ('frame-error', 'Frame error'),
57 ('bit-val', 'Bit value', (0,)),
58 ('bit-num', 'Bit number', (1,)),
59 ('frame', 'Frame', (2, 3)),
60 ('frame-error', 'Frame error', (4,)),
61 ('decode', 'Decode', (5,)),
65 self.initial_pins = [1, 1]
68 self.clause45_addr = -1 # Clause 45 is context sensitive.
69 self.reset_decoder_state()
72 self.out_python = self.register(srd.OUTPUT_PYTHON)
73 self.out_ann = self.register(srd.OUTPUT_ANN)
75 def putbit(self, mdio, ss, es):
76 self.put(ss, es, self.out_ann, [0, ['%d' % mdio]])
77 if self.options['show_debug_bits'] == 'yes':
78 self.put(ss, es, self.out_ann, [1, ['%d' % (self.bitcount - 1), '%d' % ((self.bitcount - 1) % 10)]])
80 def putff(self, data):
81 self.put(self.ss_frame_field, self.samplenum, self.out_ann, data)
84 self.put(self.ss_frame_field, self.mdiobits[0][2], self.out_ann,
85 [2, ['DATA: %04X' % self.data, 'DATA', 'D']])
87 if self.clause45 and self.opcode == 0:
88 self.clause45_addr = self.data
91 if self.opcode > 0 or not self.clause45:
93 if self.clause45 and self.clause45_addr != -1:
94 decoded_min += str.format('ADDR: %04X ' % self.clause45_addr)
96 decoded_min += str.format('ADDR: UKWN ' % self.clause45_addr)
98 if self.clause45 and self.opcode > 1 \
99 or (not self.clause45 and self.opcode):
100 decoded_min += str.format('READ: %04X' % self.data)
103 decoded_min += str.format('WRITE: %04X' % self.data)
105 decoded_ext = str.format(' %s: %02d' % \
106 ('PRTAD' if self.clause45 else 'PHYAD', self.portad))
107 decoded_ext += str.format(' %s: %02d' % \
108 ('DEVAD' if self.clause45 else 'REGAD', self.devad))
109 if self.ta_invalid or self.op_invalid:
110 decoded_ext += ' ERROR'
111 self.put(self.ss_frame, self.mdiobits[0][2], self.out_ann,
112 [5, [decoded_min + decoded_ext, decoded_min]])
114 self.put(self.ss_frame, self.mdiobits[0][2], self.out_python,
115 [(bool(self.clause45), int(self.clause45_addr), \
116 bool(is_read), int(self.portad), int(self.devad), \
119 # Post read increment address.
120 if self.clause45 and self.opcode == 2 and self.clause45_addr != -1:
121 self.clause45_addr += 1
123 def reset_decoder_state(self):
129 self.ss_frame_field = -1
130 self.preamble_len = 0
141 def state_PRE(self, mdio):
143 if mdio == 0: # Stay in illegal bus state.
145 else: # Leave and continue parsing.
147 self.put(self.ss_illegal, self.samplenum, self.out_ann,
148 [4, ['ILLEGAL BUS STATE', 'ILL']])
149 self.ss_frame = self.samplenum
151 if self.ss_frame == -1:
152 self.ss_frame = self.samplenum
155 self.preamble_len += 1
157 # Valid MDIO can't clock more than 16 succeeding ones without being
158 # in either IDLE or PRE.
159 if self.preamble_len > 16:
160 if self.preamble_len >= 10000 + 32:
161 self.put(self.ss_frame, self.mdiobits[32][1], self.out_ann,
162 [3, ['IDLE #%d' % (self.preamble_len - 32), 'IDLE', 'I']])
163 self.ss_frame = self.mdiobits[32][1]
164 self.preamble_len = 32
165 # This is getting out of hand, free some memory.
166 del self.mdiobits[33:-1]
168 if self.preamble_len < 32:
169 self.ss_frame = self.mdiobits[self.preamble_len][1]
170 self.put(self.ss_frame, self.samplenum, self.out_ann,
171 [4, ['SHORT PREAMBLE', 'SHRT PRE']])
172 elif self.preamble_len > 32:
173 self.ss_frame = self.mdiobits[32][1]
174 self.put(self.mdiobits[self.preamble_len][1],
175 self.mdiobits[32][1], self.out_ann,
176 [3, ['IDLE #%d' % (self.preamble_len - 32),
178 self.preamble_len = 32
180 self.ss_frame = self.mdiobits[32][1]
181 self.put(self.ss_frame, self.samplenum, self.out_ann,
182 [2, ['PRE #%d' % self.preamble_len, 'PRE', 'P']])
183 self.ss_frame_field = self.samplenum
186 self.ss_illegal = self.ss_frame
189 def state_ST(self, mdio):
194 def state_OP(self, mdio):
195 if self.opcode == -1:
197 st = ['ST (Clause 45)', 'ST 45']
199 st = ['ST (Clause 22)', 'ST 22']
200 self.putff([2, st + ['ST', 'S']])
201 self.ss_frame_field = self.samplenum
212 if mdio == self.opcode:
213 self.op_invalid = 'invalid for Clause 22'
216 def state_PRTAD(self, mdio):
217 if self.portad == -1:
221 op = ['OP: ADDR', 'OP: A']
222 elif self.opcode == 1:
223 op = ['OP: WRITE', 'OP: W']
224 elif self.opcode == 2:
225 op = ['OP: READINC', 'OP: RI']
226 elif self.opcode == 3:
227 op = ['OP: READ', 'OP: R']
229 op = ['OP: READ', 'OP: R'] if self.opcode else ['OP: WRITE', 'OP: W']
230 self.putff([2, op + ['OP', 'O']])
232 self.putff([4, ['OP %s' % self.op_invalid, 'OP', 'O']])
233 self.ss_frame_field = self.samplenum
234 self.portad_bits -= 1
235 self.portad |= mdio << self.portad_bits
236 if not self.portad_bits:
239 def state_DEVAD(self, mdio):
243 prtad = ['PRTAD: %02d' % self.portad, 'PRT', 'P']
245 prtad = ['PHYAD: %02d' % self.portad, 'PHY', 'P']
246 self.putff([2, prtad])
247 self.ss_frame_field = self.samplenum
249 self.devad |= mdio << self.devad_bits
250 if not self.devad_bits:
253 def state_TA(self, mdio):
254 if self.ta_invalid == -1:
257 regad = ['DEVAD: %02d' % self.devad, 'DEV', 'D']
259 regad = ['REGAD: %02d' % self.devad, 'REG', 'R']
260 self.putff([2, regad])
261 self.ss_frame_field = self.samplenum
262 if mdio != 1 and ((self.clause45 and self.opcode < 2)
263 or (not self.clause45 and self.opcode == 0)):
264 self.ta_invalid = ' invalid (bit1)'
268 self.ta_invalid = ' invalid (bit1 and bit2)'
270 self.ta_invalid = ' invalid (bit2)'
273 def state_DATA(self, mdio):
276 self.putff([2, ['TURNAROUND', 'TA', 'T']])
278 self.putff([4, ['TURNAROUND%s' % self.ta_invalid,
279 'TA%s' % self.ta_invalid, 'TA', 'T']])
280 self.ss_frame_field = self.samplenum
282 self.data |= mdio << self.data_bits
283 if not self.data_bits:
285 self.mdiobits[0][2] = self.mdiobits[0][1] + self.quartile_cycle_length()
287 self.putbit(self.mdiobits[0][0], self.mdiobits[0][1], self.mdiobits[0][2])
289 self.reset_decoder_state()
291 def process_state(self, argument, mdio):
292 method_name = 'state_' + str(argument)
293 method = getattr(self, method_name)
296 # Returns the first quartile point of the frames cycle lengths. This is a
297 # conservative guess for the end of the last cycle. On average it will be
298 # more likely to fall short, than being too long, which makes for better
299 # readability in GUIs.
300 def quartile_cycle_length(self):
301 # 48 is the minimum number of samples we have to have at the end of a
302 # frame. The last sample only has a leading clock edge and is ignored.
304 for i in range(1, 49):
305 bitlen.append(self.mdiobits[i][2] - self.mdiobits[i][1])
306 bitlen = sorted(bitlen)
309 def handle_bit(self, mdio):
311 self.mdiobits.insert(0, [mdio, self.samplenum, -1])
313 if self.bitcount > 0:
314 self.mdiobits[1][2] = self.samplenum # Note end of last cycle.
315 # Output the last bit we processed.
316 self.putbit(self.mdiobits[1][0], self.mdiobits[1][1], self.mdiobits[1][2])
318 self.process_state(self.state, mdio)
322 # Process pin state upon rising MDC edge.
323 pins = self.wait({0: 'r'})
324 self.handle_bit(pins[1])