1/*
2 * Copyright (c) 2010 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) 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: Ali Saidi
41 */
42
43
44/** @file
45 * This is a base class for AMBA devices that have to respond to Device and
46 * Implementer ID calls.
47 */
48
49#ifndef __DEV_ARM_AMBA_DEVICE_HH__
50#define __DEV_ARM_AMBA_DEVICE_HH__
51
52#include "dev/arm/base_gic.hh"
53#include "dev/dma_device.hh"
54#include "dev/io_device.hh"
55#include "mem/packet.hh"
56#include "mem/packet_access.hh"
57#include "params/AmbaPioDevice.hh"
58#include "params/AmbaDmaDevice.hh"
59#include "params/AmbaIntDevice.hh"
60
61
62class AmbaDevice
63{
64 protected:
65 static const int AMBA_PER_ID0 = 0xFE0;
66 static const int AMBA_PER_ID1 = 0xFE4;
67 static const int AMBA_PER_ID2 = 0xFE8;
68 static const int AMBA_PER_ID3 = 0xFEC;
69 static const int AMBA_CEL_ID0 = 0xFF0;
70 static const int AMBA_CEL_ID1 = 0xFF4;
71 static const int AMBA_CEL_ID2 = 0xFF8;
72 static const int AMBA_CEL_ID3 = 0xFFC;
73
74 bool readId(PacketPtr pkt, uint64_t amba_id, Addr pio_addr);
75};
76
77
78class AmbaPioDevice : public BasicPioDevice, public AmbaDevice
79{
80 protected:
81 uint64_t ambaId;
82
83 public:
84 typedef AmbaPioDeviceParams Params;
85 AmbaPioDevice(const Params *p);
86};
87
88class AmbaIntDevice : public AmbaPioDevice
89{
90 protected:
91 int intNum;
92 BaseGic *gic;
93 Tick intDelay;
94
95 public:
96 typedef AmbaIntDeviceParams Params;
97 AmbaIntDevice(const Params *p);
98};
99
100class AmbaDmaDevice : public DmaDevice, public AmbaDevice
101{
102 protected:
103 uint64_t ambaId;
104 Addr pioAddr;
105 Addr pioSize;
106 Tick pioDelay;
107 int intNum;
108 BaseGic *gic;
109
110 public:
111 typedef AmbaDmaDeviceParams Params;
112 AmbaDmaDevice(const Params *p);
113};
114
115
116#endif //__DEV_ARM_AMBA_DEVICE_HH__