Source code for spinnman.processes.read_router_diagnostics_process

# Copyright (c) 2015 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import struct
from spinnman.messages.scp.impl.read_memory import ReadMemory, Response
from spinnman.model import RouterDiagnostics
from .abstract_multi_connection_process import AbstractMultiConnectionProcess
from .abstract_multi_connection_process_connection_selector import (
    ConnectionSelector)

_N_REGISTERS = 16
_ONE_WORD = struct.Struct("<I")


class ReadRouterDiagnosticsProcess(
        AbstractMultiConnectionProcess[Response]):
    """
    A process for reading the diagnostic data block from a SpiNNaker router.
    """
    __slots__ = (
        "_control_register",
        "_error_status",
        "_register_values")

    def __init__(self, connection_selector: ConnectionSelector):
        """
        :param ConnectionSelector connection_selector:
        """
        super().__init__(connection_selector)
        self._control_register = 0
        self._error_status = 0
        self._register_values = [0] * _N_REGISTERS

    def __handle_control_register_response(self, response: Response):
        self._control_register = _ONE_WORD.unpack_from(
            response.data, response.offset)[0]

    def __handle_error_status_response(self, response: Response):
        self._error_status = _ONE_WORD.unpack_from(
            response.data, response.offset)[0]

    def __handle_register_response(self, response: Response):
        for register in range(_N_REGISTERS):
            self._register_values[register] = _ONE_WORD.unpack_from(
                response.data, response.offset + (register * 4))[0]



    def get_router_diagnostics(self, x: int, y: int) -> RouterDiagnostics:
        """
        :param int x:
        :param int y:
        :rtype: RouterDiagnostics
        """
        with self._collect_responses():
            coords = x, y, 0
            self._send_request(ReadMemory(coords, 0xe1000000, 4),
                               self.__handle_control_register_response)
            self._send_request(ReadMemory(coords, 0xe1000014, 4),
                               self.__handle_error_status_response)
            self._send_request(ReadMemory(coords, 0xe1000300, 16 * 4),
                               self.__handle_register_response)

        return RouterDiagnostics(self._control_register, self._error_status,
                                 self._register_values)