Packet: Updated comments for src and dest fields
This patch updates the comments for the src and dest fields to reflect their actual use. Due to a number of patches (e.g. removing the Broadcast flag), the old comments are no longer indicative of the current usage.
This commit is contained in:
parent
3b367db42c
commit
6a54f7fc5f
|
@ -295,19 +295,26 @@ class Packet : public FastAlloc, public Printable
|
||||||
unsigned size;
|
unsigned size;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Device address (e.g., bus ID) of the source of the
|
* Source port identifier set on a request packet to enable
|
||||||
* transaction. The source is not responsible for setting this
|
* appropriate routing of the responses. The source port
|
||||||
* field; it is set implicitly by the interconnect when the packet
|
* identifier is set by any multiplexing component, e.g. a bus, as
|
||||||
* is first sent.
|
* the timing responses need this information to be routed back to
|
||||||
|
* the appropriate port at a later point in time. The field can be
|
||||||
|
* updated (over-written) as the request packet passes through
|
||||||
|
* additional multiplexing components, and it is their
|
||||||
|
* responsibility to remember the original source port identifier,
|
||||||
|
* for example by using an appropriate sender state. The latter is
|
||||||
|
* done in the cache and bridge.
|
||||||
*/
|
*/
|
||||||
NodeID src;
|
NodeID src;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Device address (e.g., bus ID) of the destination of the
|
* Destination port identifier that is present on all response
|
||||||
* transaction. The special value Broadcast indicates that the
|
* packets that passed through a multiplexing component as a
|
||||||
* packet should be routed based on its address. This field is
|
* request packet. The source port identifier is turned into a
|
||||||
* initialized in the constructor and is thus always valid (unlike
|
* destination port identifier when the packet is turned into a
|
||||||
* addr, size, and src).
|
* response, and the destination is used, e.g. by the bus, to
|
||||||
|
* select the appropriate path through the interconnect.
|
||||||
*/
|
*/
|
||||||
NodeID dest;
|
NodeID dest;
|
||||||
|
|
||||||
|
@ -527,8 +534,7 @@ class Packet : public FastAlloc, public Printable
|
||||||
/**
|
/**
|
||||||
* Constructor. Note that a Request object must be constructed
|
* Constructor. Note that a Request object must be constructed
|
||||||
* first, but the Requests's physical address and size fields need
|
* first, but the Requests's physical address and size fields need
|
||||||
* not be valid. The command and destination addresses must be
|
* not be valid. The command must be supplied.
|
||||||
* supplied.
|
|
||||||
*/
|
*/
|
||||||
Packet(Request *_req, MemCmd _cmd)
|
Packet(Request *_req, MemCmd _cmd)
|
||||||
: cmd(_cmd), req(_req), data(NULL),
|
: cmd(_cmd), req(_req), data(NULL),
|
||||||
|
@ -620,9 +626,10 @@ class Packet : public FastAlloc, public Printable
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Take a request packet and modify it in place to be suitable for
|
* Take a request packet and modify it in place to be suitable for
|
||||||
* returning as a response to that request. The source and
|
* returning as a response to that request. The source field is
|
||||||
* destination fields are *not* modified, as is appropriate for
|
* turned into the destination, and subsequently cleared. Note
|
||||||
* atomic accesses.
|
* that the latter is not necessary for atomic requests, but
|
||||||
|
* causes no harm as neither field is valid.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
makeResponse()
|
makeResponse()
|
||||||
|
|
Loading…
Reference in a new issue