]>
Commit | Line | Data |
---|---|---|
1a751158 DS |
1 | ## |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2016 Daniel Schulte <trilader@schroedingers-bit.net> | |
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 | |
4539e9ca | 17 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
1a751158 DS |
18 | ## |
19 | ||
20 | import sigrokdecode as srd | |
37a2cca9 | 21 | from collections import namedtuple |
1a751158 DS |
22 | |
23 | class Ann: | |
37a2cca9 UH |
24 | BIT, START, STOP, PARITY_OK, PARITY_ERR, DATA, WORD = range(7) |
25 | ||
26 | Bit = namedtuple('Bit', 'val ss es') | |
1a751158 DS |
27 | |
28 | class Decoder(srd.Decoder): | |
6c0a0f61 | 29 | api_version = 3 |
1a751158 DS |
30 | id = 'ps2' |
31 | name = 'PS/2' | |
32 | longname = 'PS/2' | |
33 | desc = 'PS/2 keyboard/mouse interface.' | |
34 | license = 'gplv2+' | |
35 | inputs = ['logic'] | |
36 | outputs = ['ps2'] | |
f90269a3 | 37 | channels = ( |
1a751158 DS |
38 | {'id': 'clk', 'name': 'Clock', 'desc': 'Clock line'}, |
39 | {'id': 'data', 'name': 'Data', 'desc': 'Data line'}, | |
40 | ) | |
41 | annotations = ( | |
37a2cca9 | 42 | ('bit', 'Bit'), |
1a751158 DS |
43 | ('start-bit', 'Start bit'), |
44 | ('stop-bit', 'Stop bit'), | |
37a2cca9 UH |
45 | ('parity-ok', 'Parity OK bit'), |
46 | ('parity-err', 'Parity error bit'), | |
47 | ('data-bit', 'Data bit'), | |
48 | ('word', 'Word'), | |
49 | ) | |
50 | annotation_rows = ( | |
51 | ('bits', 'Bits', (0,)), | |
52 | ('fields', 'Fields', (1, 2, 3, 4, 5, 6)), | |
1a751158 DS |
53 | ) |
54 | ||
55 | def __init__(self): | |
56 | self.bits = [] | |
1a751158 | 57 | self.samplenum = 0 |
37a2cca9 | 58 | self.bitcount = 0 |
1a751158 DS |
59 | |
60 | def start(self): | |
61 | self.out_ann = self.register(srd.OUTPUT_ANN) | |
62 | ||
37a2cca9 UH |
63 | def putb(self, bit, ann_idx): |
64 | b = self.bits[bit] | |
65 | self.put(b.ss, b.es, self.out_ann, [ann_idx, [str(b.val)]]) | |
66 | ||
67 | def putx(self, bit, ann): | |
68 | self.put(self.bits[bit].ss, self.bits[bit].es, self.out_ann, ann) | |
69 | ||
1a751158 DS |
70 | def handle_bits(self, datapin): |
71 | # Ignore non start condition bits (useful during keyboard init). | |
37a2cca9 | 72 | if self.bitcount == 0 and datapin == 1: |
1a751158 DS |
73 | return |
74 | ||
37a2cca9 UH |
75 | # Store individual bits and their start/end samplenumbers. |
76 | self.bits.append(Bit(datapin, self.samplenum, self.samplenum)) | |
1a751158 | 77 | |
37a2cca9 UH |
78 | # Fix up end sample numbers of the bits. |
79 | if self.bitcount > 0: | |
80 | b = self.bits[self.bitcount - 1] | |
81 | self.bits[self.bitcount - 1] = Bit(b.val, b.ss, self.samplenum) | |
82 | if self.bitcount == 11: | |
83 | self.bitwidth = self.bits[1].es - self.bits[2].es | |
84 | b = self.bits[-1] | |
85 | self.bits[-1] = Bit(b.val, b.ss, b.es + self.bitwidth) | |
1a751158 DS |
86 | |
87 | # Find all 11 bits. Start + 8 data + odd parity + stop. | |
37a2cca9 UH |
88 | if self.bitcount < 11: |
89 | self.bitcount += 1 | |
1a751158 DS |
90 | return |
91 | ||
92 | # Extract data word. | |
93 | word = 0 | |
94 | for i in range(8): | |
37a2cca9 UH |
95 | word |= (self.bits[i + 1].val << i) |
96 | ||
97 | # Calculate parity. | |
98 | parity_ok = (bin(word).count('1') + self.bits[9].val) % 2 == 1 | |
99 | ||
100 | # Emit annotations. | |
101 | for i in range(11): | |
102 | self.putb(i, Ann.BIT) | |
103 | self.putx(0, [Ann.START, ['Start bit', 'Start', 'S']]) | |
104 | self.put(self.bits[1].ss, self.bits[8].es, self.out_ann, [Ann.WORD, | |
105 | ['Data: %02x' % word, 'D: %02x' % word, '%02x' % word]]) | |
106 | if parity_ok: | |
107 | self.putx(9, [Ann.PARITY_OK, ['Parity OK', 'Par OK', 'P']]) | |
1a751158 | 108 | else: |
37a2cca9 UH |
109 | self.putx(9, [Ann.PARITY_ERR, ['Parity error', 'Par err', 'PE']]) |
110 | self.putx(10, [Ann.STOP, ['Stop bit', 'Stop', 'St', 'T']]) | |
1a751158 | 111 | |
37a2cca9 | 112 | self.bits, self.bitcount = [], 0 |
1a751158 | 113 | |
6c0a0f61 GS |
114 | def decode(self): |
115 | while True: | |
116 | # Sample data bits on falling clock edge. | |
117 | clock_pin, data_pin = self.wait({0: 'f'}) | |
118 | self.handle_bits(data_pin) |