make-pins.py 16.1 KB
Newer Older
Dave Hylands's avatar
Dave Hylands committed
1
2
3
4
5
6
7
8
9
10
11
12
13
#!/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'],
14
    'I2S'   : ['CK', 'MCK', 'SD', 'WS', 'EXTSD'],
Dave Hylands's avatar
Dave Hylands committed
15
16
    'USART' : ['RX', 'TX', 'CTS', 'RTS', 'CK'],
    'UART'  : ['RX', 'TX', 'CTS', 'RTS'],
17
18
    'SPI'   : ['NSS', 'SCK', 'MISO', 'MOSI'],
    'SDMMC' : ['CK', 'CMD', 'D0', 'D1', 'D2', 'D3'],
Dave Hylands's avatar
Dave Hylands committed
19
20
}

21
22
23
CONDITIONAL_VAR = {
    'I2C'   : 'MICROPY_HW_I2C{num}_SCL',
    'I2S'   : 'MICROPY_HW_ENABLE_I2S{num}',
24
    'SPI'   : 'MICROPY_HW_SPI{num}_SCK',
25
26
    'UART'  : 'MICROPY_HW_UART{num}_TX',
    'USART' : 'MICROPY_HW_UART{num}_TX',
27
    'SDMMC' : 'MICROPY_HW_SDMMC{num}_CK',
28
29
}

Dave Hylands's avatar
Dave Hylands committed
30
31
32
33
34
35
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")
36
37
    if name_str[1] < 'A' or name_str[1] > 'K':
        raise ValueError("Expecting pin port to be between A and K")
Dave Hylands's avatar
Dave Hylands committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
    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

55
56
57
58
def conditional_var(name_num):
    # Try the specific instance first. For example, if name_num is UART4_RX
    # then try UART4 first, and then try UART second.
    name, num = split_name_num(name_num)
59
60
61
    var = []
    if name in CONDITIONAL_VAR:
        var.append(CONDITIONAL_VAR[name].format(num=num))
62
    if name_num in CONDITIONAL_VAR:
63
64
        var.append(CONDITIONAL_VAR[name_num])
    return var
65
66
67

def print_conditional_if(cond_var, file=None):
    if cond_var:
68
69
70
71
72
73
74
        cond_str = []
        for var in cond_var:
            if var.find('ENABLE') >= 0:
                cond_str.append('(defined({0}) && {0})'.format(var))
            else:
                cond_str.append('defined({0})'.format(var))
        print('#if ' + ' || '.join(cond_str), file=file)
75
76
77
78
79

def print_conditional_endif(cond_var, file=None):
    if cond_var:
        print('#endif', file=file)

Dave Hylands's avatar
Dave Hylands committed
80
81
82
83
84
85

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

    def __init__(self, idx, af_str):
        self.idx = idx
86
87
88
89
        # Special case. We change I2S2ext_SD into I2S2_EXTSD so that it parses
        # the same way the other peripherals do.
        af_str = af_str.replace('ext_', '_EXT')

Dave Hylands's avatar
Dave Hylands committed
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
        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)

115
116
117
    def mux_name(self):
        return 'AF{:d}_{:s}'.format(self.idx, self.ptr())

Dave Hylands's avatar
Dave Hylands committed
118
119
    def print(self):
        """Prints the C representation of this AF."""
120
        cond_var = None
Dave Hylands's avatar
Dave Hylands committed
121
        if self.supported:
122
123
            cond_var = conditional_var('{}{}'.format(self.func, self.fn_num))
            print_conditional_if(cond_var)
Dave Hylands's avatar
Dave Hylands committed
124
125
126
127
128
129
130
131
            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))
132
        print_conditional_endif(cond_var)
Dave Hylands's avatar
Dave Hylands committed
133

134
135
136
    def qstr_list(self):
        return [self.mux_name()]

Dave Hylands's avatar
Dave Hylands committed
137
138
139
140
141
142
143
144
145

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
146
147
        self.adc_num = 0
        self.adc_channel = 0
148
        self.board_pin = False
Dave Hylands's avatar
Dave Hylands committed
149
150
151
152

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

153
    def cpu_pin_name(self):
Dave Hylands's avatar
Dave Hylands committed
154
155
        return '{:s}{:d}'.format(self.port_letter(), self.pin)

156
157
158
159
160
161
    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
162
163
164
165
166
167
168
169
170
    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
171
172
173
174
175
176
177
178
179
180
181
182
    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
183
184
185
    def alt_fn_name(self, null_if_0=False):
        if null_if_0 and self.alt_fn_count == 0:
            return 'NULL'
186
        return 'pin_{:s}_af'.format(self.cpu_pin_name())
Dave Hylands's avatar
Dave Hylands committed
187
188
189
190
191
192
193
194
195
196
197
198

    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
199
200
201
202
203
204
205
206
207
208
209

    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('')
210
        print('const pin_obj_t pin_{:s} = PIN({:s}, {:d}, {:s}, {:s}, {:d});'.format(
211
            self.cpu_pin_name(), self.port_letter(), self.pin,
212
            self.alt_fn_name(null_if_0=True),
Dave Hylands's avatar
Dave Hylands committed
213
            self.adc_num_str(), self.adc_channel))
Dave Hylands's avatar
Dave Hylands committed
214
215
216
217
        print('')

    def print_header(self, hdr_file):
        hdr_file.write('extern const pin_obj_t pin_{:s};\n'.
218
                       format(self.cpu_pin_name()))
Dave Hylands's avatar
Dave Hylands committed
219
220
        if self.alt_fn_count > 0:
            hdr_file.write('extern const pin_af_obj_t pin_{:s}_af[];\n'.
221
222
                           format(self.cpu_pin_name()))

223
224
225
226
227
228
229
230
    def qstr_list(self):
        result = []
        for alt_fn in self.alt_fn:
            if alt_fn.is_supported():
                result += alt_fn.qstr_list()
        return result


231
232
233
234
235
236
237
238
239
240
241
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
242
243
244
245
246


class Pins(object):

    def __init__(self):
247
248
        self.cpu_pins = []   # list of NamedPin objects
        self.board_pins = [] # list of NamedPin objects
Dave Hylands's avatar
Dave Hylands committed
249
250

    def find_pin(self, port_num, pin_num):
251
252
        for named_pin in self.cpu_pins:
            pin = named_pin.pin()
Dave Hylands's avatar
Dave Hylands committed
253
254
255
256
257
258
259
260
261
262
263
264
265
            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
266
267
268
269
                    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])
270
                self.cpu_pins.append(NamedPin(pin.cpu_pin_name(), pin))
Dave Hylands's avatar
Dave Hylands committed
271
272
273
274
275
276
277
278
279
280
281

    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:
282
283
                    pin.set_is_board_pin()
                    self.board_pins.append(NamedPin(row[0], pin))
Dave Hylands's avatar
Dave Hylands committed
284

285
    def print_named(self, label, named_pins):
286
        print('STATIC const mp_rom_map_elem_t pin_{:s}_pins_locals_dict_table[] = {{'.format(label))
287
288
289
        for named_pin in named_pins:
            pin = named_pin.pin()
            if pin.is_board_pin():
290
                print('  {{ MP_ROM_QSTR(MP_QSTR_{:s}), MP_ROM_PTR(&pin_{:s}) }},'.format(named_pin.name(),  pin.cpu_pin_name()))
Dave Hylands's avatar
Dave Hylands committed
291
        print('};')
292
        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
293
294

    def print(self):
295
296
297
        for named_pin in self.cpu_pins:
            pin = named_pin.pin()
            if pin.is_board_pin():
Dave Hylands's avatar
Dave Hylands committed
298
                pin.print()
299
        self.print_named('cpu', self.cpu_pins)
Dave Hylands's avatar
Dave Hylands committed
300
301
302
        print('')
        self.print_named('board', self.board_pins)

Dave Hylands's avatar
Dave Hylands committed
303
304
305
    def print_adc(self, adc_num):
        print('');
        print('const pin_obj_t * const pin_adc{:d}[] = {{'.format(adc_num))
306
307
308
        for channel in range(17):
            if channel == 16:
                print('#if defined(MCU_SERIES_L4)')
Dave Hylands's avatar
Dave Hylands committed
309
            adc_found = False
310
311
312
            for named_pin in self.cpu_pins:
                pin = named_pin.pin()
                if (pin.is_board_pin() and
Dave Hylands's avatar
Dave Hylands committed
313
                    (pin.adc_num & (1 << (adc_num - 1))) and (pin.adc_channel == channel)):
314
                    print('  &pin_{:s}, // {:d}'.format(pin.cpu_pin_name(), channel))
Dave Hylands's avatar
Dave Hylands committed
315
316
317
318
                    adc_found = True
                    break
            if not adc_found:
                print('  NULL,    // {:d}'.format(channel))
319
320
            if channel == 16:
                print('#endif')
Dave Hylands's avatar
Dave Hylands committed
321
322
323
        print('};')


Dave Hylands's avatar
Dave Hylands committed
324
325
    def print_header(self, hdr_filename):
        with open(hdr_filename, 'wt') as hdr_file:
326
327
328
            for named_pin in self.cpu_pins:
                pin = named_pin.pin()
                if pin.is_board_pin():
Dave Hylands's avatar
Dave Hylands committed
329
                    pin.print_header(hdr_file)
Dave Hylands's avatar
Dave Hylands committed
330
331
332
            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')
333
334
335
            # provide #define's mapping board to cpu name
            for named_pin in self.board_pins:
                hdr_file.write("#define pyb_pin_{:s} pin_{:s}\n".format(named_pin.name(), named_pin.pin().cpu_pin_name()))
Dave Hylands's avatar
Dave Hylands committed
336

337
338
339
340
341
342
343
344
345
346
347
    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):
348
349
350
351
352
                cond_var = None
                if qstr.startswith('AF'):
                    af_words = qstr.split('_')
                    cond_var = conditional_var(af_words[1])
                    print_conditional_if(cond_var, file=qstr_file)
353
                print('Q({})'.format(qstr), file=qstr_file)
354
                print_conditional_endif(cond_var, file=qstr_file)
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369

    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):
370
371
372
                af_words = mux_name.split('_')  # ex mux_name: AF9_I2C2
                cond_var = conditional_var(af_words[1])
                print_conditional_if(cond_var, file=af_const_file)
373
374
375
376
                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)
377
                print_conditional_endif(cond_var, file=af_const_file)
378

379
380
381
382
383
384
385
386
387
388
389
    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
390
391
392
393
394
395
396
397
398
399
400

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",
401
        default="stm32f4xx_af.csv"
Dave Hylands's avatar
Dave Hylands committed
402
    )
403
404
405
406
    parser.add_argument(
        "--af-const",
        dest="af_const_filename",
        help="Specifies header file for alternate function constants.",
407
        default="build/pins_af_const.h"
408
    )
409
410
411
412
413
414
    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
415
416
417
418
419
420
421
422
423
    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",
424
        default="stm32f4xx_prefix.c"
Dave Hylands's avatar
Dave Hylands committed
425
    )
426
427
428
429
    parser.add_argument(
        "-q", "--qstr",
        dest="qstr_filename",
        help="Specifies name of generated qstr header file",
430
        default="build/pins_qstr.h"
431
    )
Dave Hylands's avatar
Dave Hylands committed
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
    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
458
459
460
    pins.print_adc(1)
    pins.print_adc(2)
    pins.print_adc(3)
Dave Hylands's avatar
Dave Hylands committed
461
    pins.print_header(args.hdr_filename)
462
463
    pins.print_qstr(args.qstr_filename)
    pins.print_af_hdr(args.af_const_filename)
464
    pins.print_af_py(args.af_py_filename)
Dave Hylands's avatar
Dave Hylands committed
465
466
467
468


if __name__ == "__main__":
    main()