summaryrefslogtreecommitdiffstats
path: root/contrib/cp210x-program/build/lib/cp210x/valuefile.py
blob: ae665d26e662a8930b880253e02a306b3f7c8ee3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# -*- coding: utf-8 -*-
# Copyright (c) 2007 Johannes Hölzl <johannes.hoelzl@gmx.de>
#
# This library is covered by the GNU LGPL, read LICENSE for details.

# For documentation of the baudrate table see:
#
# [AN205] Silicon Labs Application Note 205 Rev. 0.3
# http://www.silabs.com/public/documents/tpub_doc/anote/Microcontrollers/Interface/en/an205.pdf

import re
from ConfigParser import ConfigParser

import cp210x
from cp210x import VALUES, SIZE_BAUDRATES

__all__ = ['read_file', 'write_file', 'update_values', 'PrescalerIsZero',
           'ValuesFileError']

class ValuesError(StandardError):
    pass

class PrescalerIsZero(ValuesError):
    pass

class ValuesFileError(ValuesError):
    pass

version_pattern = re.compile(r'^\s*(\d\d?)\.(\d\d?)\s*$')
def read_version(s):
    match = version_pattern.match(s)
    if match is None:
        raise ValueError("Version does not match 'xx.yy'")
    return (int(match.group(1)), int(match.group(2)))
def write_version(v):
    return "%d.%02d" % v

def read_hex(s):
    return int(s.strip(), 16)

def write_hex(num):
    return "%04X" % num

def write_bool(b):
    if b:
        return 'yes'
    else:
        return 'no'

def read_bool(s):
    s = s.strip().lower()
    if s not in ['true', 'yes', 'false', 'no']:
        raise ValueError("Boolean must be either 'true', 'yes', 'false' or 'no'.")
    return s in ['true', 'yes']

def read_baudrate_info(s):
    values = s.split(',')
    if len(values) != 3:
         raise ValueError("Baudrate info must be three comma-separated items")
    try:
        baudgen = read_hex(values[0])
    except ValueError:
        raise ValueError("The first baudrate info must be a hex-value")
    try:
        timer0 = read_hex(values[1])
    except ValueError:
        raise ValueError("The second baudrate info must be a hex-value")
    try:
        prescale = int(values[2])
    except ValueError:
        raise ValueError("The thirdbaudrate info must be a number")
    return (baudgen, timer0, prescale)

TYPES = {
    'boolean':  (read_bool, write_bool),
    'int':      (int, str),
    'id':       (read_hex, write_hex),
    'string':   (str, str),
    'version':  (read_version, write_version),
}

def read_file(fp):
    cp = ConfigParser()
    if isinstance(fp, str):
        cp.read([fp])
    else:
        cp.readfp(fp)
    
    values = {}
    
    for name, type in VALUES:
        if name is 'baudrate_table':
            continue
        reader, _ = TYPES[type]
        if cp.has_option('usb device', name):
            try:
                values[name] = reader(cp.get('usb device', name))
            except ValueError, err:
                raise ValuesFileError("Key '%s': %s" % (name, str(err)))
    
    if cp.has_section('baudrate table'):
        baudrate_table = []
        for name, value in cp.items('baudrate table'):
            try:
                baudrate = int(name)
            except ValueError:
                raise ValuesFileError("Key names in 'baudrate table' must be"
                                      " baudrate numbers.")
            try:
                baudrate_table.append(read_baudrate_info(value) + (baudrate, ))
            except ValueError, err:
                raise ValuesFileError("Wrong baudrate info %i: %s"
                                      % (baudrate, str(err)))
        baudrate_table.sort(key=(lambda i: i[3]), reverse=True)
        
        values['baudrate_table'] = baudrate_table
    return values

def write_file(fp, values):
    fp.write("[usb device]\n")
    
    for name, type in VALUES:
        if name == 'baudrate_table':
            continue
        _, writer = TYPES[type]
        if name in values:
            fp.write("%s = %s\n" % (name, writer(values[name])))

    if 'baudrate_table' in values:
        fp.write("\n")
        fp.write("[baudrate table]\n")
        for (baudgen, timegen, prescaler, 
             baudrate) in sorted(values['baudrate_table'], key=(lambda i: i[3]),
                                 reverse=True):
            fp.write("%7d = %04X, %04X, %d # %s\n"
                     % (baudrate, baudgen, timegen, prescaler,
                        show_baudrate(baudgen, timegen, prescaler)))

def calc_baudrate(baudgen, timegen, prescaler):
    # This formulas are from AN205 page 5.
    if prescaler == 0:
        raise PrescalerIsZero("Prescaler is 0")
    baudrate = (24000000. / prescaler) / (0x10000 - baudgen)
    return (baudrate, (0x10000 - timegen) * 2)

def show_baudrate(baudgen, timegen, prescaler):
    try:
        baudrate, timeout = calc_baudrate(baudgen, timegen, prescaler)
    except PrescalerIsZero:
        return "Wrong data, Prescaler is 0."
    if timeout >= 1000:
        timeout = "%1.3f ms" % (float(timeout) / 1000)
    else:
        timeout = "%d us" % timeout
    if baudrate is None:
        return ", %s" % (baudrate, timeout)
    else:
        return "%7.0f Baud, %s" % (baudrate, timeout)

def update_values(v, new, dev):
    old_baudrate_table = v.get('baudrate_table')
    new_baudrate_table = new.get('baudrate_table')
    
    v.update(new)

    # update baudrate table
    # it is needed, that the baudrate table has 32 entries when it is written
    # to the eeprom or device.
    if ((old_baudrate_table is not None or new_baudrate_table is not None) and
        (new_baudrate_table is None or 
         len(new_baudrate_table) < SIZE_BAUDRATES)):
         
        if old_baudrate_table is not None:
            if len(old_baudrate_table) < SIZE_BAUDRATES:
                baudrate_table = old_baudrate_table
            else:
                baudrate_table = list(merge_baudrate_table(dev.baudrate_table, 
                                                           old_baudrate_table))
        else:
            baudrate_table = dev.baudrate_table
                                                               
        if new_baudrate_table:
            baudrate_table = list(merge_baudrate_table(baudrate_table, 
                                                       new_baudrate_table))        
        v['baudrate_table'] = baudrate_table
    
            
            
def merge_baudrate_table(old, new):
    for (old_info, (start, stop)) in zip(old, REQUEST_BAUDRATE_RANGES):
        for baudgen, timer, prescaler, baudrate in new:
            if ((start is None or baudrate <= start) and 
                baudrate >= stop):
                yield (baudgen, timer, prescaler, baudrate)
                break
        else:
            yield old_info
            
REQUEST_BAUDRATE_RANGES = [
# The table data is from AN205 Table 1 on page 1.
#     Start     End       Default Baudrate
    (None,    2457601), #  Undefined
    (2457600, 1474561), #  Undefined
    (1474560, 1053258), #  Undefined
    (1053257,  670255), #  921600
    ( 670254,  567139), #  576000
    ( 567138,  491521), #  500000
    ( 491520,  273067), #  460800
    ( 273066,  254235), #  256000
    ( 254234,  237833), #  250000
    ( 237832,  156869), #  230400
    ( 156868,  129348), #  153600
    ( 129347,  117029), #  128000
    ( 117028,   77609), #  115200
    (  77608,   64112), #   76800
    (  64111,   58054), #   64000
    (  58053,   56281), #   57600
    (  56280,   51559), #   56000
    (  51558,   38602), #   51200
    (  38601,   28913), #   38400
    (  28912,   19251), #   28800
    (  19250,   16063), #   19200
    (  16062,   14429), #   16000
    (  14428,    9613), #   14400
    (   9612,    7208), #    9600
    (   7207,    4804), #    7200
    (   4803,    4001), #    4800
    (   4000,    2401), #    4000
    (   2400,    1801), #    2400
    (   1800,    1201), #    1800
    (   1200,     601), #    1200
    (    600,     301), #     600
    (    300,      57), #     300
]