util/reggen/alert.py

# Copyright lowRISC contributors.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

from typing import Dict, List

from .bits import Bits
from .signal import Signal
from .lib import check_keys, check_name, check_str, check_list


class Alert(Signal):
    def __init__(self, name: str, desc: str, bit: int, fatal: bool):
        super().__init__(name, desc, Bits(bit, bit))
        self.bit = bit
        self.fatal = fatal

    @staticmethod
    def from_raw(what: str,
                 lsb: int,
                 raw: object) -> 'Alert':
        rd = check_keys(raw, what, ['name', 'desc'], [])

        name = check_name(rd['name'], 'name field of ' + what)
        desc = check_str(rd['desc'], 'desc field of ' + what)

        # Make sense of the alert name, which should be prefixed with recov_ or
        # fatal_.
        pfx = name.split('_')[0]
        if pfx == 'recov':
            fatal = False
        elif pfx == 'fatal':
            fatal = True
        else:
            raise ValueError('Invalid name field of {}: alert names must be '
                             'prefixed with "recov_" or "fatal_". Saw {!r}.'
                             .format(what, name))

        return Alert(name, desc, lsb, fatal)

    @staticmethod
    def from_raw_list(what: str, raw: object) -> List['Alert']:
        ret = []
        for idx, entry in enumerate(check_list(raw, what)):
            entry_what = 'entry {} of {}'.format(idx, what)
            alert = Alert.from_raw(entry_what, idx, entry)
            ret.append(alert)
        return ret

    def _asdict(self) -> Dict[str, object]:
        return {
            'name': self.name,
            'desc': self.desc,
        }