packet.proto revision 11807:63325e5b0a9d 
1// Copyright (c) 2012-2013,2017 ARM Limited
2// All rights reserved
3//
4// The license below extends only to copyright in the software and shall
5// not be construed as granting a license to any other intellectual
6// property including but not limited to intellectual property relating
7// to a hardware implementation of the functionality of the software
8// licensed hereunder.  You may use the software subject to the license
9// terms below provided that you ensure that this notice is replicated
10// unmodified and in its entirety in all distributions of the software,
11// modified or unmodified, in source code or in binary form.
12//
13// Redistribution and use in source and binary forms, with or without
14// modification, are permitted provided that the following conditions are
15// met: redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer;
17// redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution;
20// neither the name of the copyright holders nor the names of its
21// contributors may be used to endorse or promote products derived from
22// this software without specific prior written permission.
23//
24// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35//
36// Authors: Andreas Hansson
37
38syntax = "proto2";
39
40// Put all the generated messages in a namespace
41package ProtoMessage;
42
43// Packet header with the identifier describing what object captured
44// the trace, the version of this file format, and the tick frequency
45// for all the packet time stamps.
46message PacketHeader {
47  required string obj_id = 1;
48  optional uint32 ver = 2 [default = 0];
49  required uint64 tick_freq = 3;
50}
51
52// Each packet in the trace contains a tick (which can be translated
53// to absolute time using the frequency in the header), the command,
54// the address, and the size in bytes. The optional flags are used to
55// capture the request flags that convey information about
56// cacheability, if the packet is an instruction fetch or prefetch or
57// not, etc. An optional id field is added for generic use to identify
58// the packet or the "owner" of the packet. An example of the latter
59// is the sequential id of an instruction, or the master id etc.
60// An optional field for PC of the instruction for which this request is made
61// is provided.
62message Packet {
63  required uint64 tick = 1;
64  required uint32 cmd = 2;
65  required uint64 addr = 3;
66  required uint32 size = 4;
67  optional uint32 flags = 5;
68  optional uint64 pkt_id = 6;
69  optional uint64 pc = 7;
70}
71