summaryrefslogtreecommitdiff
path: root/tools/bootloader.py
blob: 74321913c9e27b8abdfce6d825f120c287d768f7 (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
# binwatch - Tiny binary wristwatch. {{{
#
# Copyright (C) 2010 Nicolas Schodet
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# Contact :
#        Web: http://ni.fr.eu.org/
#      Email: <nico at ni.fr.eu.org>
# }}} */
"""binwatch bootloader control."""
import struct
import dev2.twi

class ProtocolError (RuntimeError):
    pass

class Bootloader:

    INFO = 0
    START = 1
    READ = 2
    PAGE_WRITE = 3
    READ_FUSES = 4

    def __init__ (self, address, serial):
        """Initialise and set address and serial object to use."""
        self.address = address
        self.twi = dev2.twi.Twi (serial)

    def _command (self, command, fmt, rfmt, *params):
        """Send a command and check response.
        
         - command: command to send.
         - fmt: command format (see struct).
         - rfmt: response format.
         - params: command parameters.
           
        Will return unpacked response or None on error."""
        s = struct.pack ('<B' + fmt, command, *params)
        n = self.twi.send (self.address, s)
        if n != len (s):
            raise ProtocolError ("send command fail")
        rlen = struct.calcsize ('<B' + rfmt)
        r = self.twi.recv (self.address, rlen)
        if len (r) != rlen:
            raise ProtocolError ("receive ack fail")
        rl = struct.unpack ('<B' + rfmt, r)
        if rl[0] != command:
            raise ProtocolError ("received nack")
        return rl[1:]

    def info (self):
        """Check the bootloader signature, return signature, page size and flash size."""
        r = self._command (self.INFO, '', '12sBH')
        if r[0] != 'bwbootloader' and r[0] != 'bwbootstrapp':
            raise ProtocolError ("bad signature")
        return r

    def start (self):
        """Start application."""
        self._command (self.START, '', '')

    def read (self, address, size):
        """Read data from flash."""
        r = self._command (self.READ, 'HB', 'H%ds' % size, address, size)
        if r[0] != address:
            raise ProtocolError ("read fail")
        return r[1]

    def page_write (self, address, size, data):
        """Write one flash page."""
        r = self._command (self.PAGE_WRITE, 'HB%ds' % size, 'H', address, size,
                data)
        if r[0] != address:
            raise ProtocolError ("page write fail")

    def read_fuses (self):
        """Read fuses, return them in a dict."""
        r = self._command (self.READ_FUSES, '', 'BBB')
        return dict (lfuse = r[0], hfuse = r[1], efuse = r[2])

def flash (bootloader, data, verify = True, progress = None):
    """Flash given data using bootloader."""
    # Get bootloader parameters.
    _, page_size, flash_size = bootloader.info ()
    # Pad data to page size.
    pad = (page_size - len (data) % page_size) % page_size
    data = data + '\xff' * pad
    # Check binary size.
    if len (data) > flash_size:
        raise RuntimeError ("flash too small")
    # Program pages.
    for page in xrange (0, len (data), page_size):
        bootloader.page_write (page, page_size, data[page:page + page_size])
        if progress:
            progress ('program', page + page_size, len (data))
    # Verify.
    if verify:
        for page in xrange (0, len (data), page_size):
            r = bootloader.read (page, page_size)
            if page == 0:
                match = r[2:] == data[page + 2:page + page_size]
            else:
                match = r == data[page:page + page_size]
            if not match:
                raise RuntimeError (
                        "verification mismatch at address 0x04x" % page)
            if progress:
                progress ('verify', page + page_size, len (data))

def dump (bootloader, progress = None):
    """Dump all flash data using bootloader."""
    # Get bootloader parameters.
    _, page_size, flash_size = bootloader.info ()
    data = [ ]
    for page in xrange (0, flash_size, page_size):
        r = bootloader.read (page, page_size)
        data.append (r)
        if progress:
            progress ('dump', page + page_size, flash_size)
    return ''.join (data)

def progress (step, current, total):
    """Print current progress."""
    print "\r%s: %3d%%" % (step, current * 100 / total),
    if current == total:
        print ''
    import sys
    sys.stdout.flush ()

def command (args = None):
    """Implement command line interface."""
    # Parse options.
    import optparse
    parser = optparse.OptionParser ()
    parser.add_option ('-d', '--dump',
            help = "dump flash to FILE", metavar = 'FILE')
    parser.add_option ('-f', '--flash',
            help = "flash from FILE", metavar = 'FILE')
    parser.add_option ('-s', '--start', action = 'store_true',
            help = "start application program")
    parser.add_option ('-i', '--info', action = 'store_true',
            help = "get page and flash size")
    parser.add_option ('-t', '--tty',
            help = "tty connected to dev2", metavar = 'TTY')
    parser.add_option ('-a', '--address', type = 'int', default = 0xb8,
            help = "define bootloader slave address", metavar = 'ADDR')
    (options, extra) = parser.parse_args (args = args)
    if extra:
        parser.error ("extra unused arguments")
    if options.tty is None:
        parser.error ("no tty to open")
    # Apply.
    import serial
    try:
        s = serial.Serial (options.tty)
        bl = Bootloader (options.address, s)
        if options.info:
            print bl.info ()
        if options.dump is not None:
            f = open (options.dump, 'w')
            f.write (dump (bl, progress = progress))
            f.close ()
        if options.flash is not None:
            flash (bl, open (options.flash).read (), progress = progress)
        if options.start:
            bl.start ()
    except Exception, e:
        import sys
        print >> sys.stderr, e.message
        sys.exit (1)

if __name__ == '__main__':
    command ()