make-pins.py 13.6 KB
Newer Older
Dave Hylands's avatar
Dave Hylands committed
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
#!/usr/bin/env python
"""Creates the pin file for the STM32F4xx."""

from __future__ import print_function

import argparse
import sys
import csv

SUPPORTED_FN = {
    'TIM'   : ['CH1',  'CH2',  'CH3',  'CH4',
               'CH1N', 'CH2N', 'CH3N', 'CH1_ETR', 'ETR', 'BKIN'],
    'I2C'   : ['SDA', 'SCL'],
    'USART' : ['RX', 'TX', 'CTS', 'RTS', 'CK'],
    'UART'  : ['RX', 'TX', 'CTS', 'RTS'],
    'SPI'   : ['NSS', 'SCK', 'MISO', 'MOSI']
}

def parse_port_pin(name_str):
    """Parses a string and returns a (port-num, pin-num) tuple."""
    if len(name_str) < 3:
        raise ValueError("Expecting pin name to be at least 3 charcters.")
    if name_str[0] != 'P':
        raise ValueError("Expecting pin name to start with P")
    if name_str[1] < 'A' or name_str[1] > 'J':
        raise ValueError("Expecting pin port to be between A and J")
    port = ord(name_str[1]) - ord('A')
    pin_str = name_str[2:]
    if not pin_str.isdigit():
        raise ValueError("Expecting numeric pin number.")
    return (port, int(pin_str))

def split_name_num(name_num):
    num = None
    for num_idx in range(len(name_num) - 1, -1, -1):
        if not name_num[num_idx].isdigit():
            name = name_num[0:num_idx + 1]
            num_str = name_num[num_idx + 1:]
            if len(num_str) > 0:
                num = int(num_str)
            break
    return name, num


class AlternateFunction(object):
    """Holds the information associated with a pins alternate function."""

    def __init__(self, idx, af_str):
        self.idx = idx
        self.af_str = af_str

        self.func = ''
        self.fn_num = None
        self.pin_type = ''
        self.supported = False

        af_words = af_str.split('_', 1)
        self.func, self.fn_num = split_name_num(af_words[0])
        if len(af_words) > 1:
            self.pin_type = af_words[1]
        if self.func in SUPPORTED_FN:
            pin_types = SUPPORTED_FN[self.func]
            if self.pin_type in pin_types:
                self.supported = True

    def is_supported(self):
        return self.supported

    def ptr(self):
        """Returns the numbered function (i.e. USART6) for this AF."""
        if self.fn_num is None:
            return self.func
        return '{:s}{:d}'.format(self.func, self.fn_num)

75
76
77
    def mux_name(self):
        return 'AF{:d}_{:s}'.format(self.idx, self.ptr())

Dave Hylands's avatar
Dave Hylands committed
78
79
80
81
82
83
84
85
86
87
88
89
    def print(self):
        """Prints the C representation of this AF."""
        if self.supported:
            print('  AF',  end='')
        else:
            print('  //', end='')
        fn_num = self.fn_num
        if fn_num is None:
            fn_num = 0
        print('({:2d}, {:8s}, {:2d}, {:10s}, {:8s}), // {:s}'.format(self.idx,
              self.func, fn_num, self.pin_type, self.ptr(), self.af_str))

90
91
92
    def qstr_list(self):
        return [self.mux_name()]

Dave Hylands's avatar
Dave Hylands committed
93
94
95
96
97
98
99
100
101

class Pin(object):
    """Holds the information associated with a pin."""

    def __init__(self, port, pin):
        self.port = port
        self.pin = pin
        self.alt_fn = []
        self.alt_fn_count = 0
Dave Hylands's avatar
Dave Hylands committed
102
103
        self.adc_num = 0
        self.adc_channel = 0
104
        self.board_pin = False
Dave Hylands's avatar
Dave Hylands committed
105
106
107
108

    def port_letter(self):
        return chr(self.port + ord('A'))

109
    def cpu_pin_name(self):
Dave Hylands's avatar
Dave Hylands committed
110
111
        return '{:s}{:d}'.format(self.port_letter(), self.pin)

112
113
114
115
116
117
    def is_board_pin(self):
        return self.board_pin

    def set_is_board_pin(self):
        self.board_pin = True

Dave Hylands's avatar
Dave Hylands committed
118
119
120
121
122
123
124
125
126
    def parse_adc(self, adc_str):
        if (adc_str[:3] != 'ADC'):
            return
        (adc,channel) = adc_str.split('_')
        for idx in range(3, len(adc)):
            adc_num = int(adc[idx]) # 1, 2, or 3
            self.adc_num |= (1 << (adc_num - 1))
        self.adc_channel = int(channel[2:])

Dave Hylands's avatar
Dave Hylands committed
127
128
129
130
131
132
133
134
135
136
137
138
    def parse_af(self, af_idx, af_strs_in):
        if len(af_strs_in) == 0:
            return
        # If there is a slash, then the slash separates 2 aliases for the
        # same alternate function.
        af_strs = af_strs_in.split('/')
        for af_str in af_strs:
            alt_fn = AlternateFunction(af_idx, af_str)
            self.alt_fn.append(alt_fn)
            if alt_fn.is_supported():
                self.alt_fn_count += 1

Dave Hylands's avatar
Dave Hylands committed
139
140
141
    def alt_fn_name(self, null_if_0=False):
        if null_if_0 and self.alt_fn_count == 0:
            return 'NULL'
142
        return 'pin_{:s}_af'.format(self.cpu_pin_name())
Dave Hylands's avatar
Dave Hylands committed
143
144
145
146
147
148
149
150
151
152
153
154

    def adc_num_str(self):
        str = ''
        for adc_num in range(1,4):
            if self.adc_num & (1 << (adc_num - 1)):
                if len(str) > 0:
                    str += ' | '
                str += 'PIN_ADC'
                str += chr(ord('0') + adc_num)
        if len(str) == 0:
            str = '0'
        return str
Dave Hylands's avatar
Dave Hylands committed
155
156
157
158
159
160
161
162
163
164
165

    def print(self):
        if self.alt_fn_count == 0:
            print("// ",  end='')
        print('const pin_af_obj_t {:s}[] = {{'.format(self.alt_fn_name()))
        for alt_fn in self.alt_fn:
            alt_fn.print()
        if self.alt_fn_count == 0:
            print("// ",  end='')
        print('};')
        print('')
Dave Hylands's avatar
Dave Hylands committed
166
        print('const pin_obj_t pin_{:s} = PIN({:s}, {:d}, {:d}, {:s}, {:s}, {:d});'.format(
167
            self.cpu_pin_name(), self.port_letter(), self.pin,
Dave Hylands's avatar
Dave Hylands committed
168
169
            self.alt_fn_count, self.alt_fn_name(null_if_0=True),
            self.adc_num_str(), self.adc_channel))
Dave Hylands's avatar
Dave Hylands committed
170
171
172
173
        print('')

    def print_header(self, hdr_file):
        hdr_file.write('extern const pin_obj_t pin_{:s};\n'.
174
                       format(self.cpu_pin_name()))
Dave Hylands's avatar
Dave Hylands committed
175
176
        if self.alt_fn_count > 0:
            hdr_file.write('extern const pin_af_obj_t pin_{:s}_af[];\n'.
177
178
                           format(self.cpu_pin_name()))

179
180
181
182
183
184
185
186
    def qstr_list(self):
        result = []
        for alt_fn in self.alt_fn:
            if alt_fn.is_supported():
                result += alt_fn.qstr_list()
        return result


187
188
189
190
191
192
193
194
195
196
197
class NamedPin(object):

    def __init__(self, name, pin):
        self._name = name
        self._pin = pin

    def pin(self):
        return self._pin

    def name(self):
        return self._name
Dave Hylands's avatar
Dave Hylands committed
198
199
200
201
202


class Pins(object):

    def __init__(self):
203
204
        self.cpu_pins = []   # list of NamedPin objects
        self.board_pins = [] # list of NamedPin objects
Dave Hylands's avatar
Dave Hylands committed
205
206

    def find_pin(self, port_num, pin_num):
207
208
        for named_pin in self.cpu_pins:
            pin = named_pin.pin()
Dave Hylands's avatar
Dave Hylands committed
209
210
211
212
213
214
215
216
217
218
219
220
221
            if pin.port == port_num and pin.pin == pin_num:
                return pin

    def parse_af_file(self, filename, pinname_col, af_col):
        with open(filename, 'r') as csvfile:
            rows = csv.reader(csvfile)
            for row in rows:
                try:
                    (port_num, pin_num) = parse_port_pin(row[pinname_col])
                except:
                    continue
                pin = Pin(port_num, pin_num)
                for af_idx in range(af_col, len(row)):
Dave Hylands's avatar
Dave Hylands committed
222
223
224
225
                    if af_idx < af_col + 16:
                        pin.parse_af(af_idx - af_col, row[af_idx])
                    elif af_idx == af_col + 16:
                        pin.parse_adc(row[af_idx])
226
                self.cpu_pins.append(NamedPin(pin.cpu_pin_name(), pin))
Dave Hylands's avatar
Dave Hylands committed
227
228
229
230
231
232
233
234
235
236
237

    def parse_board_file(self, filename):
        with open(filename, 'r') as csvfile:
            rows = csv.reader(csvfile)
            for row in rows:
                try:
                    (port_num, pin_num) = parse_port_pin(row[1])
                except:
                    continue
                pin = self.find_pin(port_num, pin_num)
                if pin:
238
239
                    pin.set_is_board_pin()
                    self.board_pins.append(NamedPin(row[0], pin))
Dave Hylands's avatar
Dave Hylands committed
240

241
    def print_named(self, label, named_pins):
242
        print('STATIC const mp_map_elem_t pin_{:s}_pins_locals_dict_table[] = {{'.format(label))
243
244
245
        for named_pin in named_pins:
            pin = named_pin.pin()
            if pin.is_board_pin():
246
                print('  {{ MP_OBJ_NEW_QSTR(MP_QSTR_{:s}), (mp_obj_t)&pin_{:s} }},'.format(named_pin.name(),  pin.cpu_pin_name()))
Dave Hylands's avatar
Dave Hylands committed
247
        print('};')
248
        print('MP_DEFINE_CONST_DICT(pin_{:s}_pins_locals_dict, pin_{:s}_pins_locals_dict_table);'.format(label, label));
Dave Hylands's avatar
Dave Hylands committed
249
250

    def print(self):
251
252
253
        for named_pin in self.cpu_pins:
            pin = named_pin.pin()
            if pin.is_board_pin():
Dave Hylands's avatar
Dave Hylands committed
254
                pin.print()
255
        self.print_named('cpu', self.cpu_pins)
Dave Hylands's avatar
Dave Hylands committed
256
257
258
        print('')
        self.print_named('board', self.board_pins)

Dave Hylands's avatar
Dave Hylands committed
259
260
261
262
263
    def print_adc(self, adc_num):
        print('');
        print('const pin_obj_t * const pin_adc{:d}[] = {{'.format(adc_num))
        for channel in range(16):
            adc_found = False
264
265
266
            for named_pin in self.cpu_pins:
                pin = named_pin.pin()
                if (pin.is_board_pin() and
Dave Hylands's avatar
Dave Hylands committed
267
                    (pin.adc_num & (1 << (adc_num - 1))) and (pin.adc_channel == channel)):
268
                    print('  &pin_{:s}, // {:d}'.format(pin.cpu_pin_name(), channel))
Dave Hylands's avatar
Dave Hylands committed
269
270
271
272
273
274
275
                    adc_found = True
                    break
            if not adc_found:
                print('  NULL,    // {:d}'.format(channel))
        print('};')


Dave Hylands's avatar
Dave Hylands committed
276
277
    def print_header(self, hdr_filename):
        with open(hdr_filename, 'wt') as hdr_file:
278
279
280
            for named_pin in self.cpu_pins:
                pin = named_pin.pin()
                if pin.is_board_pin():
Dave Hylands's avatar
Dave Hylands committed
281
                    pin.print_header(hdr_file)
Dave Hylands's avatar
Dave Hylands committed
282
283
284
            hdr_file.write('extern const pin_obj_t * const pin_adc1[];\n')
            hdr_file.write('extern const pin_obj_t * const pin_adc2[];\n')
            hdr_file.write('extern const pin_obj_t * const pin_adc3[];\n')
Dave Hylands's avatar
Dave Hylands committed
285

286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
    def print_qstr(self, qstr_filename):
        with open(qstr_filename, 'wt') as qstr_file:
            qstr_set = set([])
            for named_pin in self.cpu_pins:
                pin = named_pin.pin()
                if pin.is_board_pin():
                    qstr_set |= set(pin.qstr_list())
                    qstr_set |= set([named_pin.name()])
            for named_pin in self.board_pins:
                qstr_set |= set([named_pin.name()])
            for qstr in sorted(qstr_set):
                print('Q({})'.format(qstr), file=qstr_file)

    def print_af_hdr(self, af_const_filename):
        with open(af_const_filename,  'wt') as af_const_file:
            af_hdr_set = set([])
            mux_name_width = 0
            for named_pin in self.cpu_pins:
                pin = named_pin.pin()
                if pin.is_board_pin():
                    for af in pin.alt_fn:
                        if af.is_supported():
                            mux_name = af.mux_name()
                            af_hdr_set |= set([mux_name])
                            if len(mux_name) > mux_name_width:
                                mux_name_width = len(mux_name)
            for mux_name in sorted(af_hdr_set):
                key = 'MP_OBJ_NEW_QSTR(MP_QSTR_{}),'.format(mux_name)
                val = 'MP_OBJ_NEW_SMALL_INT(GPIO_{})'.format(mux_name)
                print('    { %-*s %s },' % (mux_name_width + 26, key, val),
                      file=af_const_file)

318
319
320
321
322
323
324
325
326
327
328
    def print_af_py(self, af_py_filename):
        with open(af_py_filename,  'wt') as af_py_file:
            print('PINS_AF = (', file=af_py_file);
            for named_pin in self.board_pins:
                print("  ('%s', " % named_pin.name(), end='', file=af_py_file)
                for af in named_pin.pin().alt_fn:
                    if af.is_supported():
                        print("(%d, '%s'), " % (af.idx, af.af_str), end='', file=af_py_file)
                print('),', file=af_py_file)
            print(')',  file=af_py_file)

Dave Hylands's avatar
Dave Hylands committed
329
330
331
332
333
334
335
336
337
338
339

def main():
    parser = argparse.ArgumentParser(
        prog="make-pins.py",
        usage="%(prog)s [options] [command]",
        description="Generate board specific pin file"
    )
    parser.add_argument(
        "-a", "--af",
        dest="af_filename",
        help="Specifies the alternate function file for the chip",
340
        default="stm32f4xx_af.csv"
Dave Hylands's avatar
Dave Hylands committed
341
    )
342
343
344
345
    parser.add_argument(
        "--af-const",
        dest="af_const_filename",
        help="Specifies header file for alternate function constants.",
346
        default="build/pins_af_const.h"
347
    )
348
349
350
351
352
353
    parser.add_argument(
        "--af-py",
        dest="af_py_filename",
        help="Specifies the filename for the python alternate function mappings.",
        default="build/pins_af.py"
    )
Dave Hylands's avatar
Dave Hylands committed
354
355
356
357
358
359
360
361
362
    parser.add_argument(
        "-b", "--board",
        dest="board_filename",
        help="Specifies the board file",
    )
    parser.add_argument(
        "-p", "--prefix",
        dest="prefix_filename",
        help="Specifies beginning portion of generated pins file",
363
        default="stm32f4xx_prefix.c"
Dave Hylands's avatar
Dave Hylands committed
364
    )
365
366
367
368
    parser.add_argument(
        "-q", "--qstr",
        dest="qstr_filename",
        help="Specifies name of generated qstr header file",
369
        default="build/pins_qstr.h"
370
    )
Dave Hylands's avatar
Dave Hylands committed
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
    parser.add_argument(
        "-r", "--hdr",
        dest="hdr_filename",
        help="Specifies name of generated pin header file",
        default="build/pins.h"
    )
    args = parser.parse_args(sys.argv[1:])

    pins = Pins()

    print('// This file was automatically generated by make-pins.py')
    print('//')
    if args.af_filename:
        print('// --af {:s}'.format(args.af_filename))
        pins.parse_af_file(args.af_filename, 1, 2)

    if args.board_filename:
        print('// --board {:s}'.format(args.board_filename))
        pins.parse_board_file(args.board_filename)

    if args.prefix_filename:
        print('// --prefix {:s}'.format(args.prefix_filename))
        print('')
        with open(args.prefix_filename, 'r') as prefix_file:
            print(prefix_file.read())
    pins.print()
Dave Hylands's avatar
Dave Hylands committed
397
398
399
    pins.print_adc(1)
    pins.print_adc(2)
    pins.print_adc(3)
Dave Hylands's avatar
Dave Hylands committed
400
    pins.print_header(args.hdr_filename)
401
402
    pins.print_qstr(args.qstr_filename)
    pins.print_af_hdr(args.af_const_filename)
403
    pins.print_af_py(args.af_py_filename)
Dave Hylands's avatar
Dave Hylands committed
404
405
406
407


if __name__ == "__main__":
    main()