# 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.
import struct
from spinn_utilities.overrides import overrides
from spinnman.messages.scp import SCPRequestHeader
from spinnman.messages.scp.abstract_messages import (
AbstractSCPRequest, AbstractSCPResponse)
from spinnman.messages.scp.enums import SCPCommand, SCPResult
from spinnman.messages.sdp import SDPFlag, SDPHeader
from spinnman.exceptions import SpinnmanUnexpectedResponseCodeException
_IPTAG_GET = 2
_IPTAG_FORMAT = struct.Struct("<4s6s3HIH3B")
class IPTagGetResponse(AbstractSCPResponse):
"""
An SCP response to a request for an IP tags.
"""
__slots__ = [
"_count",
"_flags",
"_ip_address",
"_mac_address",
"_port",
"_rx_port",
"_spin_chip_x",
"_spin_chip_y",
"_spin_cpu",
"_spin_port",
"_timeout"]
def __init__(self) -> None:
super().__init__()
self._ip_address = b'\0\0\0\0'
self._mac_address = b'\0\0\0\0\0\0'
self._port = 0
self._timeout = 0
self._flags = 0
self._count = 0
self._rx_port = 0
self._spin_chip_y = 0
self._spin_chip_x = 0
self._spin_cpu = 0
self._spin_port = 0
@overrides(AbstractSCPResponse.read_data_bytestring)
def read_data_bytestring(self, data: bytes, offset: int):
result = self.scp_response_header.result
if result != SCPResult.RC_OK:
raise SpinnmanUnexpectedResponseCodeException(
"Get IP Tag Info", "CMD_IPTAG", result.name)
(ip_address, mac_address, self._port, self._timeout,
self._flags, self._count, self._rx_port, self._spin_chip_y,
self._spin_chip_x, processor_and_port) = _IPTAG_FORMAT.unpack_from(
data, offset)
self._ip_address = bytearray(ip_address)
self._mac_address = bytearray(mac_address)
self._spin_port = (processor_and_port >> 5) & 0x7
self._spin_cpu = processor_and_port & 0x1F
@property
def ip_address(self) -> bytes:
"""
The IP address of the tag, as a bytearray of 4 bytes.
:rtype: bytearray
"""
return self._ip_address
@property
def mac_address(self) -> bytes:
"""
The MAC address of the tag, as a bytearray of 6 bytes.
:rtype: bytearray
"""
return self._mac_address
@property
def port(self) -> int:
"""
The port of the tag.
:rtype: int
"""
return self._port
@property
def timeout(self) -> int:
"""
The timeout of the tag.
:rtype: int
"""
return self._timeout
@property
def flags(self) -> int:
"""
The flags of the tag.
:rtype: int
"""
return self._flags
@property
def in_use(self) -> bool:
"""
Whether the tag is marked as being in use.
:rtype: bool
"""
return (self._flags & 0x8000) > 0
@property
def is_temporary(self) -> bool:
"""
Whether the tag is temporary.
:rtype: bool
"""
return (self._flags & 0x4000) > 0
@property
def is_arp(self) -> bool:
"""
Whether the tag is in the Address Resolution Protocol state
(where the MAC address is being looked up).
.. note::
This is a transient state; it is unlikely to be observed.
:rtype: bool
"""
return (self._flags & 0x2000) > 0
@property
def is_reverse(self) -> bool:
"""
Whether the tag is a reverse tag.
:rtype: bool
"""
return (self._flags & 0x0200) > 0
@property
def strip_sdp(self) -> bool:
"""
Whether the tag is to strip the SDP header.
:rtype: bool
"""
return (self._flags & 0x0100) > 0
@property
def count(self) -> int:
"""
The count of the number of packets that have been sent with the tag.
:rtype: int
"""
return self._count
@property
def rx_port(self) -> int:
"""
The receive port of the tag.
:rtype: int
"""
return self._rx_port
@property
def spin_chip_x(self) -> int:
"""
The X-coordinate of the chip on which the tag is defined.
:rtype: int
"""
return self._spin_chip_x
@property
def spin_chip_y(self) -> int:
"""
The Y-coordinate of the chip on which the tag is defined.
:rtype: int
"""
return self._spin_chip_y
@property
def spin_port(self) -> int:
"""
The spin-port of the IP tag.
:rtype: int
"""
return self._spin_port
@property
def spin_cpu(self) -> int:
"""
The CPU ID of the IP tag.
:rtype: int
"""
return self._spin_cpu
class IPTagGet(AbstractSCPRequest[IPTagGetResponse]):
"""
An SCP Request to get an IP tag.
"""
__slots__ = ()
def __init__(self, x: int, y: int, tag: int):
"""
:param int x: The x-coordinate of a chip, between 0 and 255
:param int y: The y-coordinate of a chip, between 0 and 255
:param int tag: The tag to get details of, between 0 and 7
"""
super().__init__(
SDPHeader(
flags=SDPFlag.REPLY_EXPECTED, destination_port=0,
destination_cpu=0, destination_chip_x=x,
destination_chip_y=y),
SCPRequestHeader(command=SCPCommand.CMD_IPTAG),
argument_1=(_IPTAG_GET << 16) | tag,
argument_2=1)
[docs]
@overrides(AbstractSCPRequest.get_scp_response)
def get_scp_response(self) -> IPTagGetResponse:
return IPTagGetResponse()