]>
Commit | Line | Data |
---|---|---|
1 | ## | |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2017 Joel Holdsworth <joel@airwebreathe.org.uk> | |
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 3 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.srdhelper import bitpack_lsb | |
22 | ||
23 | def disabled_enabled(v): | |
24 | return ['Disabled', 'Enabled'][v] | |
25 | ||
26 | def output_power(v): | |
27 | return '{:+d}dBm'.format([-4, -1, 2, 5][v]) | |
28 | ||
29 | regs = { | |
30 | # reg: name offset width parser | |
31 | 0: [ | |
32 | ('FRAC', 3, 12, None), | |
33 | ('INT', 15, 16, lambda v: 'Not Allowed' if v < 32 else v) | |
34 | ], | |
35 | 1: [ | |
36 | ('MOD', 3, 12, None), | |
37 | ('Phase', 15, 12, None), | |
38 | ('Prescalar', 27, 1, lambda v: ['4/5', '8/9'][v]), | |
39 | ('Phase Adjust', 28, 1, lambda v: ['Off', 'On'][v]), | |
40 | ], | |
41 | 2: [ | |
42 | ('Counter Reset', 3, 1, disabled_enabled), | |
43 | ('Charge Pump Three-State', 4, 1, disabled_enabled), | |
44 | ('Power-Down', 5, 1, disabled_enabled), | |
45 | ('PD Polarity', 6, 1, lambda v: ['Negative', 'Positive'][v]), | |
46 | ('LDP', 7, 1, lambda v: ['10ns', '6ns'][v]), | |
47 | ('LDF', 8, 1, lambda v: ['FRAC-N', 'INT-N'][v]), | |
48 | ('Charge Pump Current Setting', 9, 4, lambda v: '{:0.2f}mA @ 5.1kΩ'.format( | |
49 | [0.31, 0.63, 0.94, 1.25, 1.56, 1.88, 2.19, 2.50, | |
50 | 2.81, 3.13, 3.44, 3.75, 4.06, 4.38, 4.69, 5.00][v])), | |
51 | ('Double Buffer', 13, 1, disabled_enabled), | |
52 | ('R Counter', 14, 10, None), | |
53 | ('RDIV2', 24, 1, disabled_enabled), | |
54 | ('Reference Doubler', 25, 1, disabled_enabled), | |
55 | ('MUXOUT', 26, 3, lambda v: | |
56 | ['Three-State Output', 'DVdd', 'DGND', 'R Counter Output', 'N Divider Output', | |
57 | 'Analog Lock Detect', 'Digital Lock Detect', 'Reserved'][v]), | |
58 | ('Low Noise and Low Spur Modes', 29, 2, lambda v: | |
59 | ['Low Noise Mode', 'Reserved', 'Reserved', 'Low Spur Mode'][v]) | |
60 | ], | |
61 | 3: [ | |
62 | ('Clock Divider', 3, 12, None), | |
63 | ('Clock Divider Mode', 15, 2, lambda v: | |
64 | ['Clock Divider Off', 'Fast Lock Enable', 'Resync Enable', 'Reserved'][v]), | |
65 | ('CSR Enable', 18, 1, disabled_enabled), | |
66 | ('Charge Cancellation', 21, 1, disabled_enabled), | |
67 | ('ABP', 22, 1, lambda v: ['6ns (FRAC-N)', '3ns (INT-N)'][v]), | |
68 | ('Band Select Clock Mode', 23, 1, lambda v: ['Low', 'High'][v]) | |
69 | ], | |
70 | 4: [ | |
71 | ('Output Power', 3, 2, output_power), | |
72 | ('Output Enable', 5, 1, disabled_enabled), | |
73 | ('AUX Output Power', 6, 2, output_power), | |
74 | ('AUX Output Select', 8, 1, lambda v: ['Divided Output', 'Fundamental'][v]), | |
75 | ('AUX Output Enable', 9, 1, disabled_enabled), | |
76 | ('MTLD', 10, 1, disabled_enabled), | |
77 | ('VCO Power-Down', 11, 1, lambda v: | |
78 | 'VCO Powered {updown}'.format(updown = 'Down' if v else 'Up')), | |
79 | ('Band Select Clock Divider', 12, 8, None), | |
80 | ('RF Divider Select', 20, 3, lambda v: '÷{:d}'.format(2 ** v)), | |
81 | ('Feedback Select', 23, 1, lambda v: ['Divided', 'Fundamental'][v]), | |
82 | ], | |
83 | 5: [ | |
84 | ('LD Pin Mode', 22, 2, lambda v: | |
85 | ['Low', 'Digital Lock Detect', 'Low', 'High'][v]) | |
86 | ] | |
87 | } | |
88 | ||
89 | ANN_REG = 0 | |
90 | ANN_WARN = 1 | |
91 | ||
92 | class Decoder(srd.Decoder): | |
93 | api_version = 3 | |
94 | id = 'adf435x' | |
95 | name = 'ADF435x' | |
96 | longname = 'Analog Devices ADF4350/1' | |
97 | desc = 'Wideband synthesizer with integrated VCO.' | |
98 | license = 'gplv3+' | |
99 | inputs = ['spi'] | |
100 | outputs = [] | |
101 | tags = ['Clock/timing', 'IC', 'Wireless/RF'] | |
102 | annotations = ( | |
103 | # Sent from the host to the chip. | |
104 | ('write', 'Register write'), | |
105 | ('warning', "Warnings"), | |
106 | ) | |
107 | annotation_rows = ( | |
108 | ('writes', 'Register writes', (ANN_REG,)), | |
109 | ('warnings', 'Warnings', (ANN_WARN,)), | |
110 | ) | |
111 | ||
112 | def __init__(self): | |
113 | self.reset() | |
114 | ||
115 | def reset(self): | |
116 | self.bits = [] | |
117 | ||
118 | def start(self): | |
119 | self.out_ann = self.register(srd.OUTPUT_ANN) | |
120 | ||
121 | def putg(self, ss, es, cls, data): | |
122 | self.put(ss, es, self.out_ann, [ cls, data, ]) | |
123 | ||
124 | def decode_bits(self, offset, width): | |
125 | '''Extract a bit field. Expects LSB input data.''' | |
126 | bits = self.bits[offset:][:width] | |
127 | ss, es = bits[-1][1], bits[0][2] | |
128 | value = bitpack_lsb(bits, 0) | |
129 | return ( value, ( ss, es, )) | |
130 | ||
131 | def decode_field(self, name, offset, width, parser): | |
132 | '''Interpret a bit field. Emits an annotation.''' | |
133 | val, ( ss, es, ) = self.decode_bits(offset, width) | |
134 | val = parser(val) if parser else '{}'.format(val) | |
135 | text = ['{name}: {val}'.format(name = name, val = val)] | |
136 | self.putg(ss, es, ANN_REG, text) | |
137 | ||
138 | def decode_word(self, ss, es, bits): | |
139 | '''Interpret a 32bit word after accumulation completes.''' | |
140 | # SPI transfer content must be exactly one 32bit word. | |
141 | count = len(self.bits) | |
142 | if count != 32: | |
143 | text = [ | |
144 | 'Frame error: Bit count: want 32, got {}'.format(count), | |
145 | 'Frame error: Bit count', | |
146 | 'Frame error', | |
147 | ] | |
148 | self.putg(ss, es, ANN_WARN, text) | |
149 | return | |
150 | # Holding bits in LSB order during interpretation simplifies | |
151 | # bit field extraction. And annotation emitting routines expect | |
152 | # this reverse order of bits' timestamps. | |
153 | self.bits.reverse() | |
154 | # Determine which register was accessed. | |
155 | reg_addr, ( reg_ss, reg_es, ) = self.decode_bits(0, 3) | |
156 | text = [ | |
157 | 'Register: {addr}'.format(addr = reg_addr), | |
158 | 'Reg: {addr}'.format(addr = reg_addr), | |
159 | '[{addr}]'.format(addr = reg_addr), | |
160 | ] | |
161 | self.putg(reg_ss, reg_es, ANN_REG, text) | |
162 | # Interpret the register's content (when parsers are available). | |
163 | field_descs = regs.get(reg_addr, None) | |
164 | if not field_descs: | |
165 | return | |
166 | for field_desc in field_descs: | |
167 | self.decode_field(*field_desc) | |
168 | ||
169 | def decode(self, ss, es, data): | |
170 | ptype, _, _ = data | |
171 | ||
172 | if ptype == 'TRANSFER': | |
173 | # Process accumulated bits after completion of a transfer. | |
174 | self.decode_word(ss, es, self.bits) | |
175 | self.bits.clear() | |
176 | ||
177 | if ptype == 'BITS': | |
178 | _, mosi_bits, miso_bits = data | |
179 | # Accumulate bits in MSB order as they are seen in SPI frames. | |
180 | msb_bits = mosi_bits.copy() | |
181 | msb_bits.reverse() | |
182 | self.bits.extend(msb_bits) |