contrib/variant/kconfig.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2020 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Add a new variant to the Kconfig and Kconfig.name for the baseboard

To start a new variant of an existing baseboard, we need to add
the variant into the Kconfig and Kconfig.name files for the
baseboard. In Kconfig, we have two sections that need additional
entries, MAINBOARD_PART_NUMBER and VARIANT_DIR.

The MAINBOARD_PART_NUMBER and VARIANT_DIR just use various
capitalizations of the variant name to create the strings.

Kconfig.name adds an entire section for the new variant, and all
of these use various capitalizations of the variant name. The strings
in this section are SOC-specific, so we'll need versions for each
SOC that we support.
"""

from __future__ import print_function
import argparse
import sys


def main(argv):
    """Add strings to coreboot Kconfig and Kconfig.name for a new variant

    Args:
        argv: Command-line arguments
    """
    parser = argparse.ArgumentParser(description=__doc__)
    parser.add_argument('--board', type=str, required=True,
                        choices=('hatch', 'volteer', 'trembyle', 'dalboz',
                                 'waddledee', 'waddledoo', 'puff'),
                        help='Name of the baseboard')
    parser.add_argument('--variant', type=str, required=True,
                        help='Name of the board variant')
    opts = parser.parse_args(argv)

    add_to_kconfig(opts.variant)
    add_to_kconfig_name(opts.board, opts.variant)
    return True


def add_to_kconfig(variant_name):
    """Add options for the variant to the Kconfig

    Open the Kconfig file and read it line-by-line. When we detect that we're
    in one of the sections of interest, wait until we get a blank line
    (signalling the end of that section), and then add our new line before
    the blank line. The updated lines are written out to Kconfig.new in the
    same directory as Kconfig.

    Args:
        variant_name: The name of the board variant, e.g. 'kohaku'
    """
    # These are the part of the strings that we'll add to the sections.
    BOARD = 'BOARD_GOOGLE_' + variant_name.upper()
    lowercase = variant_name.lower()
    capitalized = lowercase.capitalize()

    # These flags track if we're in a section where we need to add an option.
    in_mainboard_part_number = False
    in_variant_dir = False

    inputname = 'Kconfig'
    outputname = 'Kconfig.new'
    with open(outputname, 'w', encoding='utf-8') as outfile, \
        open(inputname, 'r', encoding='utf-8') as infile:
        for rawline in infile:
            line = rawline.rstrip()

            # Are we in one of the sections of interest?
            if line == 'config MAINBOARD_PART_NUMBER':
                in_mainboard_part_number = True
            if line == 'config VARIANT_DIR':
                in_variant_dir = True

            # Are we at the end of a section, and if so, is it one of the
            # sections of interest?
            if not line:
                if in_mainboard_part_number:
                    print(f'\tdefault "{capitalized}" if {BOARD}',
                        file=outfile)
                    in_mainboard_part_number = False
                if in_variant_dir:
                    print(f'\tdefault "{lowercase}" if {BOARD}',
                        file=outfile)
                    in_variant_dir = False

            print(line, file=outfile)


def add_to_kconfig_name(baseboard_name, variant_name):
    """Add a config section for the variant to the Kconfig.name

    Kconfig.name is easier to modify than Kconfig; it only has a block at
    the end with the new variant's details.

    Args:
        baseboard_name: The name of the baseboard, e.g. 'hatch'
            We expect the caller to have checked that it is one
            that we support
        variant_name: The name of the board variant, e.g. 'kohaku'
    """
    # Board name for the config section.
    uppercase = variant_name.upper()
    capitalized = variant_name.lower().capitalize()

    inputname = 'Kconfig.name'
    outputname = 'Kconfig.name.new'
    with open(outputname, 'w', encoding='utf-8') as outfile, \
        open(inputname, 'r', encoding='utf-8') as infile:
        # Copy all input lines to output.
        for rawline in infile:
            line = rawline.rstrip()
            print(line, file=outfile)

        # Now add the new section.
        if baseboard_name == 'hatch':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_HATCH', file=outfile)
            print('\tselect BOARD_ROMSIZE_KB_16384', file=outfile)
        elif baseboard_name == 'volteer':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_VOLTEER', file=outfile)
        elif baseboard_name == 'trembyle':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_TREMBYLE', file=outfile)
        elif baseboard_name == 'dalboz':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_DALBOZ', file=outfile)
        elif baseboard_name == 'waddledee':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_DEDEDE', file=outfile)
            print('\tselect BASEBOARD_DEDEDE_LAPTOP', file=outfile)
        elif baseboard_name == 'waddledoo':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_DEDEDE', file=outfile)
            print('\tselect BASEBOARD_DEDEDE_LAPTOP', file=outfile)
            print('\tselect DRIVERS_GENERIC_MAX98357A', file=outfile)
            print('\tselect DRIVERS_I2C_DA7219', file=outfile)
        elif baseboard_name == 'puff':
            print('\nconfig ' + 'BOARD_GOOGLE_' + uppercase, file=outfile)
            print('\tbool "-> ' + capitalized + '"', file=outfile)
            print('\tselect BOARD_GOOGLE_BASEBOARD_PUFF', file=outfile)
        else:
            raise ValueError(f'Unsupported board {baseboard_name}')


if __name__ == '__main__':
    sys.exit(not int(main(sys.argv[1:])))