xref: /xnu-11417.140.69/tools/lldbmacros/usertaskdebugging/rsprotocol.py (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1*43a90889SApple OSS Distributionsimport logging
2*43a90889SApple OSS Distributions
3*43a90889SApple OSS Distributions
4*43a90889SApple OSS Distributionsclass Message(object):
5*43a90889SApple OSS Distributions    """represents a message of Remote serial protocol"""
6*43a90889SApple OSS Distributions    def __init__(self, data):
7*43a90889SApple OSS Distributions        super().__init__()
8*43a90889SApple OSS Distributions        self.data = data
9*43a90889SApple OSS Distributions
10*43a90889SApple OSS Distributions    def __str__(self):
11*43a90889SApple OSS Distributions        return "Message: %s" % (self.data)
12*43a90889SApple OSS Distributions
13*43a90889SApple OSS Distributions    def getData(self):
14*43a90889SApple OSS Distributions        #TODO need to parse data and unescape
15*43a90889SApple OSS Distributions        return self.data
16*43a90889SApple OSS Distributions
17*43a90889SApple OSS Distributions    def getRSPByteData(self):
18*43a90889SApple OSS Distributions        retval = ''.join(['$',self.data,'#'])
19*43a90889SApple OSS Distributions        checksum = 0
20*43a90889SApple OSS Distributions        for i in self.data:
21*43a90889SApple OSS Distributions            checksum += ord(i)
22*43a90889SApple OSS Distributions        checksum = checksum % 0x100
23*43a90889SApple OSS Distributions        checksum_str = "{:02x}".format(checksum)
24*43a90889SApple OSS Distributions        retval += checksum_str
25*43a90889SApple OSS Distributions        return retval
26*43a90889SApple OSS Distributions
27*43a90889SApple OSS Distributions    @classmethod
28*43a90889SApple OSS Distributions    def fromRSPByteData(cls, bytedata):
29*43a90889SApple OSS Distributions        data_begin = 0
30*43a90889SApple OSS Distributions        data_end = 0
31*43a90889SApple OSS Distributions        try:
32*43a90889SApple OSS Distributions            data_begin = bytedata.index('$')
33*43a90889SApple OSS Distributions            data_end = bytedata.index('#')
34*43a90889SApple OSS Distributions        except ValueError as e:
35*43a90889SApple OSS Distributions            logging.error('Invalid bytedata considered as message %s' % bytedata)
36*43a90889SApple OSS Distributions            return None
37*43a90889SApple OSS Distributions
38*43a90889SApple OSS Distributions        #validate the data
39*43a90889SApple OSS Distributions        if data_begin + 1 >= data_end:
40*43a90889SApple OSS Distributions            logging.debug("empty message %s"%bytedata)
41*43a90889SApple OSS Distributions            data_begin -= 1
42*43a90889SApple OSS Distributions
43*43a90889SApple OSS Distributions        data_begin += 1
44*43a90889SApple OSS Distributions        logging.debug("Creating message from data %s" % bytedata[data_begin:data_end])
45*43a90889SApple OSS Distributions        ret_obj = cls(bytedata[data_begin:data_end])
46*43a90889SApple OSS Distributions        return ret_obj
47*43a90889SApple OSS Distributions
48*43a90889SApple OSS Distributionsclass ProtocolAcknowledgement(Message):
49*43a90889SApple OSS Distributions    """Ack Messages"""
50*43a90889SApple OSS Distributions    def __init__(self, ack_str):
51*43a90889SApple OSS Distributions        super().__init__(ack_str)
52*43a90889SApple OSS Distributions        self.data = ack_str
53*43a90889SApple OSS Distributions
54*43a90889SApple OSS Distributions    def getRSPByteData(self):
55*43a90889SApple OSS Distributions        return self.data
56*43a90889SApple OSS Distributions
57*43a90889SApple OSS Distributions
58*43a90889SApple OSS DistributionsOKMessage = Message('OK')
59*43a90889SApple OSS Distributions
60*43a90889SApple OSS DistributionsAckMessage = ProtocolAcknowledgement('+')
61*43a90889SApple OSS DistributionsNAckMessage = ProtocolAcknowledgement('-')
62*43a90889SApple OSS DistributionsUnSupportedMessage = Message('')
63