1/*
2 * Copyright (c) 2011-2012,2015,2017 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ron Dreslinski
41 *          Andreas Hansson
42 *          William Wang
43 */
44
45#ifndef __MEM_GEM5_PROTOCOL_FUNCTIONAL_HH__
46#define __MEM_GEM5_PROTOCOL_FUNCTIONAL_HH__
47
48#include "mem/packet.hh"
49
50class FunctionalResponseProtocol;
51
52class FunctionalRequestProtocol
53{
54    friend class FunctionalResponseProtocol;
55
56  protected:
57    /**
58     * Send a functional request packet, where the data is instantly
59     * updated everywhere in the memory system, without affecting the
60     * current state of any block or moving the block.
61     *
62     * @param pkt Packet to send.
63     */
64    void send(FunctionalResponseProtocol *peer, PacketPtr pkt) const;
65
66    /**
67     * Receive a functional snoop request packet from the peer.
68     */
69    virtual void recvFunctionalSnoop(PacketPtr pkt) = 0;
70};
71
72class FunctionalResponseProtocol
73{
74    friend class FunctionalRequestProtocol;
75
76  protected:
77    /**
78     * Send a functional snoop request packet, where the data is
79     * instantly updated everywhere in the memory system, without
80     * affecting the current state of any block or moving the block.
81     *
82     * @param pkt Snoop packet to send.
83     */
84    void sendSnoop(FunctionalRequestProtocol *peer, PacketPtr pkt) const;
85
86    /**
87     * Receive a functional request packet from the peer.
88     */
89    virtual void recvFunctional(PacketPtr pkt) = 0;
90};
91
92#endif //__MEM_GEM5_PROTOCOL_FUNCTIONAL_HH__
93