Source code for spinnman.messages.scp.impl.read_link

# Copyright (c) 2014 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.

from spinn_utilities.overrides import overrides
from spinn_utilities.typing.coords import XYP
from spinnman.messages.scp import SCPRequestHeader
from spinnman.messages.scp.abstract_messages import AbstractSCPRequest
from spinnman.messages.scp.enums import SCPCommand
from spinnman.messages.sdp import SDPFlag, SDPHeader
from .read_memory import Response


class ReadLink(AbstractSCPRequest[Response]):
    """
    An SCP request to read a region of memory via a link on a chip.
    """
    __slots__ = ()

    def __init__(
            self, coordinates: XYP, link: int, base_address: int, size: int):
        """
        :param tuple(int,int,int) coordinates:
            The coordinates of the core of the chip whose neighbour will be
            read from; X and Y between 0 and 255,
            CPU core normally 0 (or if a BMP then the board slot number)
        :param int link: The ID of the link down which to send the query
        :param int base_address:
            The positive base address to start the read from
        :param int size: The number of bytes to read, between 1 and 256
        """
        # pylint: disable=too-many-arguments
        x, y, cpu = coordinates
        super().__init__(
            SDPHeader(
                flags=SDPFlag.REPLY_EXPECTED, destination_port=0,
                destination_cpu=cpu, destination_chip_x=x,
                destination_chip_y=y),
            SCPRequestHeader(command=SCPCommand.CMD_LINK_READ),
            argument_1=base_address, argument_2=size, argument_3=link)



    @overrides(AbstractSCPRequest.get_scp_response)
    def get_scp_response(self) -> Response:
        return Response("read neighbour memory", "CMD_LINK_READ")