license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / sdcard_sd / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2015 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, see <http://www.gnu.org/licenses/>.
18 ##
19
20 import sigrokdecode as srd
21 from common.sdcard import (cmd_names, acmd_names, accepted_voltages, card_status, sd_status)
22
23 class Decoder(srd.Decoder):
24     api_version = 2
25     id = 'sdcard_sd'
26     name = 'SD card (SD mode)'
27     longname = 'Secure Digital card (SD mode)'
28     desc = 'Secure Digital card (SD mode) low-level protocol.'
29     license = 'gplv2+'
30     inputs = ['logic']
31     outputs = ['sdcard_sd']
32     channels = (
33         {'id': 'cmd',  'name': 'CMD',  'desc': 'Command'},
34         {'id': 'clk',  'name': 'CLK',  'desc': 'Clock'},
35     )
36     optional_channels = (
37         {'id': 'dat0', 'name': 'DAT0', 'desc': 'Data pin 0'},
38         {'id': 'dat1', 'name': 'DAT1', 'desc': 'Data pin 1'},
39         {'id': 'dat2', 'name': 'DAT2', 'desc': 'Data pin 2'},
40         {'id': 'dat3', 'name': 'DAT3', 'desc': 'Data pin 3'},
41     )
42     annotations = \
43         tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
44         tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
45         ('bits', 'Bits'),
46         ('field-start', 'Start bit'),
47         ('field-transmission', 'Transmission bit'),
48         ('field-cmd', 'Command'),
49         ('field-arg', 'Argument'),
50         ('field-crc', 'CRC'),
51         ('field-end', 'End bit'),
52         ('decoded-bits', 'Decoded bits'),
53         ('decoded-fields', 'Decoded fields'),
54     )
55     annotation_rows = (
56         ('raw-bits', 'Raw bits', (128,)),
57         ('decoded-bits', 'Decoded bits', (135,)),
58         ('decoded-fields', 'Decoded fields', (136,)),
59         ('fields', 'Fields', tuple(range(129, 135))),
60         ('cmd', 'Commands', tuple(range(128))),
61     )
62
63     def __init__(self):
64         self.state = 'GET COMMAND TOKEN'
65         self.token = []
66         self.oldpins = None
67         self.oldclk = 0
68         self.is_acmd = False # Indicates CMD vs. ACMD
69         self.cmd = None
70         self.arg = None
71
72     def start(self):
73         self.out_ann = self.register(srd.OUTPUT_ANN)
74
75     def putbit(self, b, data):
76         self.put(self.token[b][0], self.token[b][1], self.out_ann, [135, data])
77
78     def putt(self, data):
79         self.put(self.token[0][0], self.token[47][1], self.out_ann, data)
80
81     def putt2(self, data):
82         self.put(self.token[47][0], self.token[0][1], self.out_ann, data)
83
84     def putf(self, s, e, data):
85         self.put(self.token[s][0], self.token[e][1], self.out_ann, data)
86
87     def puta(self, s, e, data):
88         self.put(self.token[47 - 8 - e][0], self.token[47 - 8 - s][1],
89                  self.out_ann, data)
90
91     def putc(self, cmd, desc):
92         self.putt([cmd, ['%s: %s' % (self.cmd_str, desc), self.cmd_str,
93                          self.cmd_str.split(' ')[0]]])
94
95     def putr(self, cmd, desc):
96         self.putt([cmd, ['Reply: %s' % desc]])
97
98     def putr2(self, cmd, desc):
99         self.putt2([cmd, ['Reply: %s' % desc]])
100
101     def reset(self):
102         self.cmd, self.arg = None, None
103         self.token, self.state = [], 'GET COMMAND TOKEN'
104
105     def cmd_name(self, cmd):
106         c = acmd_names if self.is_acmd else cmd_names
107         return c.get(cmd, 'Unknown')
108
109     def get_token_bits(self, cmd, n):
110         # Get a bit, return True if we already got 'n' bits, False otherwise.
111         self.token.append([self.samplenum, self.samplenum, cmd])
112         if len(self.token) > 0:
113             self.token[len(self.token) - 2][1] = self.samplenum
114         if len(self.token) < n:
115             return False
116         self.token[n - 1][1] += self.token[n - 1][0] - self.token[n - 2][0]
117         return True
118
119     def handle_common_token_fields(self):
120         s = self.token
121
122         # Annotations for each individual bit.
123         for bit in range(len(self.token)):
124             self.putf(bit, bit, [128, ['%d' % s[bit][2]]])
125
126         # CMD[47:47]: Start bit (always 0)
127         self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
128
129         # CMD[46:46]: Transmission bit (1 == host)
130         t = 'host' if s[1][2] == 1 else 'card'
131         self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
132
133         # CMD[45:40]: Command index (BCD; valid: 0-63)
134         self.cmd = int('0b' + ''.join([str(s[i][2]) for i in range(2, 8)]), 2)
135         c = '%s (%d)' % (self.cmd_name(self.cmd), self.cmd)
136         self.putf(2, 7, [131, ['Command: ' + c, 'Cmd: ' + c,
137                                'CMD%d' % self.cmd, 'Cmd', 'C']])
138
139         # CMD[39:08]: Argument
140         self.putf(8, 39, [132, ['Argument', 'Arg', 'A']])
141
142         # CMD[07:01]: CRC7
143         self.crc = int('0b' + ''.join([str(s[i][2]) for i in range(40, 47)]), 2)
144         self.putf(40, 46, [133, ['CRC: 0x%x' % self.crc, 'CRC', 'C']])
145
146         # CMD[00:00]: End bit (always 1)
147         self.putf(47, 47, [134, ['End bit', 'End', 'E']])
148
149     def get_command_token(self, cmd):
150         # Command tokens (48 bits) are sent serially (MSB-first) by the host
151         # (over the CMD line), either to one SD card or to multiple ones.
152         #
153         # Format:
154         #  - Bits[47:47]: Start bit (always 0)
155         #  - Bits[46:46]: Transmission bit (1 == host)
156         #  - Bits[45:40]: Command index (BCD; valid: 0-63)
157         #  - Bits[39:08]: Argument
158         #  - Bits[07:01]: CRC7
159         #  - Bits[00:00]: End bit (always 1)
160
161         if not self.get_token_bits(cmd, 48):
162             return
163
164         self.handle_common_token_fields()
165
166         # Handle command.
167         s = 'ACMD' if self.is_acmd else 'CMD'
168         self.cmd_str = '%s%d (%s)' % (s, self.cmd, self.cmd_name(self.cmd))
169         if self.cmd in (0, 2, 3, 4, 6, 7, 8, 9, 10, 13, 41, 51, 55):
170             self.state = 'HANDLE CMD%d' % self.cmd
171         else:
172             self.state = 'HANDLE CMD999'
173             self.putc(self.cmd, '%s%d' % (s, self.cmd))
174
175     def handle_cmd0(self):
176         # CMD0 (GO_IDLE_STATE) -> no response
177         self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
178         self.putc(0, 'Reset all SD cards')
179         self.token, self.state = [], 'GET COMMAND TOKEN'
180
181     def handle_cmd2(self):
182         # CMD2 (ALL_SEND_CID) -> R2
183         self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
184         self.putc(2, 'Ask card for CID number')
185         self.token, self.state = [], 'GET RESPONSE R2'
186
187     def handle_cmd3(self):
188         # CMD3 (SEND_RELATIVE_ADDR) -> R6
189         self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
190         self.putc(3, 'Ask card for new relative card address (RCA)')
191         self.token, self.state = [], 'GET RESPONSE R6'
192
193     def handle_cmd6(self):
194         # CMD6 (SWITCH_FUNC) -> R1
195         self.putc(6, 'Switch/check card function')
196         self.token, self.state = [], 'GET RESPONSE R1'
197
198     def handle_cmd7(self):
199         # CMD7 (SELECT/DESELECT_CARD) -> R1b
200         self.putc(7, 'Select / deselect card')
201         self.token, self.state = [], 'GET RESPONSE R6'
202
203     def handle_cmd8(self):
204         # CMD8 (SEND_IF_COND) -> R7
205         self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
206         self.puta(8, 11, [136, ['Supply voltage', 'Voltage', 'VHS', 'V']])
207         self.puta(0, 7, [136, ['Check pattern', 'Check pat', 'Check', 'C']])
208         self.putc(0, 'Send interface condition to card')
209         self.token, self.state = [], 'GET RESPONSE R7'
210         # TODO: Handle case when card doesn't reply with R7 (no reply at all).
211
212     def handle_cmd9(self):
213         # CMD9 (SEND_CSD) -> R2
214         self.puta(16, 31, [136, ['RCA', 'R']])
215         self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
216         self.putc(9, 'Send card-specific data (CSD)')
217         self.token, self.state = [], 'GET RESPONSE R2'
218
219     def handle_cmd10(self):
220         # CMD10 (SEND_CID) -> R2
221         self.puta(16, 31, [136, ['RCA', 'R']])
222         self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
223         self.putc(9, 'Send card identification data (CID)')
224         self.token, self.state = [], 'GET RESPONSE R2'
225
226     def handle_cmd13(self):
227         # CMD13 (SEND_STATUS) -> R1
228         self.puta(16, 31, [136, ['RCA', 'R']])
229         self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
230         self.putc(13, 'Send card status register')
231         self.token, self.state = [], 'GET RESPONSE R1'
232
233     def handle_cmd16(self):
234         # CMD16 (SET_BLOCKLEN) -> R1
235         self.blocklen = self.arg
236         self.puta(0, 31, [136, ['Block length', 'Blocklen', 'BL', 'B']])
237         self.putc(16, 'Set the block length to %d bytes' % self.blocklen)
238         self.token, self.state = [], 'GET RESPONSE R1'
239
240     def handle_cmd55(self):
241         # CMD55 (APP_CMD) -> R1
242         self.puta(16, 31, [136, ['RCA', 'R']])
243         self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
244         self.putc(55, 'Next command is an application-specific command')
245         self.is_acmd = True
246         self.token, self.state = [], 'GET RESPONSE R1'
247
248     def handle_acmd6(self):
249         # ACMD6 (SET_BUS_WIDTH) -> R1
250         self.putc(64 + 6, 'Read SD config register (SCR)')
251         self.token, self.state = [], 'GET RESPONSE R1'
252
253     def handle_acmd13(self):
254         # ACMD13 (SD_STATUS) -> R1
255         self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
256         self.putc(64 + 13, 'Set SD status')
257         self.token, self.state = [], 'GET RESPONSE R1'
258
259     def handle_acmd41(self):
260         # ACMD41 (SD_SEND_OP_COND) -> R3
261         self.puta(0, 23, [136, ['VDD voltage window', 'VDD volt', 'VDD', 'V']])
262         self.puta(24, 24, [136, ['S18R']])
263         self.puta(25, 27, [136, ['Reserved', 'Res', 'R']])
264         self.puta(28, 28, [136, ['XPC']])
265         self.puta(29, 29, [136, ['Reserved for eSD', 'Reserved', 'Res', 'R']])
266         self.puta(30, 30, [136, ['Host capacity support info', 'Host capacity',
267                                  'HCS', 'H']])
268         self.puta(31, 31, [136, ['Reserved', 'Res', 'R']])
269         self.putc(64 + 41, 'Send HCS info and activate the card init process')
270         self.token, self.state = [], 'GET RESPONSE R3'
271
272     def handle_acmd51(self):
273         # ACMD51 (SEND_SCR) -> R1
274         self.putc(64 + 51, 'Read SD config register (SCR)')
275         self.token, self.state = [], 'GET RESPONSE R1'
276
277     def handle_cmd999(self):
278         self.token, self.state = [], 'GET RESPONSE R1'
279
280     def handle_acmd999(self):
281         self.token, self.state = [], 'GET RESPONSE R1'
282
283     # Response tokens can have one of four formats (depends on content).
284     # They can have a total length of 48 or 136 bits.
285     # They're sent serially (MSB-first) by the card that the host
286     # addressed previously, or (synchronously) by all connected cards.
287
288     def handle_response_r1(self, cmd):
289         # R1: Normal response command
290         #  - Bits[47:47]: Start bit (always 0)
291         #  - Bits[46:46]: Transmission bit (0 == card)
292         #  - Bits[45:40]: Command index (BCD; valid: 0-63)
293         #  - Bits[39:08]: Card status
294         #  - Bits[07:01]: CRC7
295         #  - Bits[00:00]: End bit (always 1)
296         if not self.get_token_bits(cmd, 48):
297             return
298         self.handle_common_token_fields()
299         self.putr(55, 'R1')
300         self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
301         for i in range(32):
302             self.putbit(8 + i, [card_status[31 - i]])
303         self.token, self.state = [], 'GET COMMAND TOKEN'
304
305     def handle_response_r1b(self, cmd):
306         # R1b: Same as R1 with an optional busy signal (on the data line)
307         if not self.get_token_bits(cmd, 48):
308             return
309         self.handle_common_token_fields()
310         self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
311         self.putr(55, 'R1b')
312         self.token, self.state = [], 'GET COMMAND TOKEN'
313
314     def handle_response_r2(self, cmd):
315         # R2: CID/CSD register
316         #  - Bits[135:135]: Start bit (always 0)
317         #  - Bits[134:134]: Transmission bit (0 == card)
318         #  - Bits[133:128]: Reserved (always 0b111111)
319         #  - Bits[127:001]: CID or CSD register including internal CRC7
320         #  - Bits[000:000]: End bit (always 1)
321         if not self.get_token_bits(cmd, 136):
322             return
323         # Annotations for each individual bit.
324         for bit in range(len(self.token)):
325             self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
326         self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
327         t = 'host' if self.token[1][2] == 1 else 'card'
328         self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
329         self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
330         self.putf(8, 134, [132, ['Argument', 'Arg', 'A']])
331         self.putf(135, 135, [134, ['End bit', 'End', 'E']])
332         self.putf(8, 134, [136, ['CID/CSD register', 'CID/CSD', 'C']])
333         self.putf(0, 135, [55, ['R2']])
334         self.token, self.state = [], 'GET COMMAND TOKEN'
335
336     def handle_response_r3(self, cmd):
337         # R3: OCR register
338         #  - Bits[47:47]: Start bit (always 0)
339         #  - Bits[46:46]: Transmission bit (0 == card)
340         #  - Bits[45:40]: Reserved (always 0b111111)
341         #  - Bits[39:08]: OCR register
342         #  - Bits[07:01]: Reserved (always 0b111111)
343         #  - Bits[00:00]: End bit (always 1)
344         if not self.get_token_bits(cmd, 48):
345             return
346         self.putr(55, 'R3')
347         # Annotations for each individual bit.
348         for bit in range(len(self.token)):
349             self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
350         self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
351         t = 'host' if self.token[1][2] == 1 else 'card'
352         self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
353         self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
354         self.putf(8, 39, [132, ['Argument', 'Arg', 'A']])
355         self.putf(40, 46, [133, ['Reserved', 'Res', 'R']])
356         self.putf(47, 47, [134, ['End bit', 'End', 'E']])
357         self.puta(0, 31, [136, ['OCR register', 'OCR reg', 'OCR', 'O']])
358         self.token, self.state = [], 'GET COMMAND TOKEN'
359
360     def handle_response_r6(self, cmd):
361         # R6: Published RCA response
362         #  - Bits[47:47]: Start bit (always 0)
363         #  - Bits[46:46]: Transmission bit (0 == card)
364         #  - Bits[45:40]: Command index (always 0b000011)
365         #  - Bits[39:24]: Argument[31:16]: New published RCA of the card
366         #  - Bits[23:08]: Argument[15:0]: Card status bits
367         #  - Bits[07:01]: CRC7
368         #  - Bits[00:00]: End bit (always 1)
369         if not self.get_token_bits(cmd, 48):
370             return
371         self.handle_common_token_fields()
372         self.puta(0, 15, [136, ['Card status bits', 'Status', 'S']])
373         self.puta(16, 31, [136, ['Relative card address', 'RCA', 'R']])
374         self.putr(55, 'R6')
375         self.token, self.state = [], 'GET COMMAND TOKEN'
376
377     def handle_response_r7(self, cmd):
378         # R7: Card interface condition
379         #  - Bits[47:47]: Start bit (always 0)
380         #  - Bits[46:46]: Transmission bit (0 == card)
381         #  - Bits[45:40]: Command index (always 0b001000)
382         #  - Bits[39:20]: Reserved bits (all-zero)
383         #  - Bits[19:16]: Voltage accepted
384         #  - Bits[15:08]: Echo-back of check pattern
385         #  - Bits[07:01]: CRC7
386         #  - Bits[00:00]: End bit (always 1)
387         if not self.get_token_bits(cmd, 48):
388             return
389         self.handle_common_token_fields()
390
391         self.putr(55, 'R7')
392
393         # Arg[31:12]: Reserved bits (all-zero)
394         self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
395
396         # Arg[11:08]: Voltage accepted
397         v = ''.join(str(i[2]) for i in self.token[28:32])
398         av = accepted_voltages.get(int('0b' + v, 2), 'Unknown')
399         self.puta(8, 11, [136, ['Voltage accepted: ' + av, 'Voltage', 'Volt', 'V']])
400
401         # Arg[07:00]: Echo-back of check pattern
402         self.puta(0, 7, [136, ['Echo-back of check pattern', 'Echo', 'E']])
403
404         self.token, self.state = [], 'GET COMMAND TOKEN'
405
406     def decode(self, ss, es, data):
407         for (self.samplenum, pins) in data:
408
409             # Ignore identical samples early on (for performance reasons).
410             if self.oldpins == pins:
411                 continue
412             self.oldpins, (cmd, clk, dat0, dat1, dat2, dat3) = pins, pins
413
414             # Wait for a rising CLK edge.
415             if not (self.oldclk == 0 and clk == 1):
416                 self.oldclk = clk
417                 continue
418             self.oldclk = clk
419
420             # State machine.
421             if self.state == 'GET COMMAND TOKEN':
422                 if len(self.token) == 0:
423                     # Wait for start bit (CMD = 0).
424                     if cmd != 0:
425                         continue
426                 self.get_command_token(cmd)
427             elif self.state.startswith('HANDLE CMD'):
428                 # Call the respective handler method for the command.
429                 a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower()
430                 handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
431                 handle_cmd()
432                 # Leave ACMD mode again after the first command after CMD55.
433                 if self.is_acmd and cmdstr not in ('55', '63'):
434                     self.is_acmd = False
435             elif self.state.startswith('GET RESPONSE'):
436                 if len(self.token) == 0:
437                     # Wait for start bit (CMD = 0).
438                     if cmd != 0:
439                         continue
440                 # Call the respective handler method for the response.
441                 s = 'handle_response_%s' % self.state[13:].lower()
442                 handle_response = getattr(self, s)
443                 handle_response(cmd)