kmi.hh revision 7754
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: William Wang 41 */ 42 43 44/** @file 45 * Implementiation of a PL050 KMI 46 */ 47 48#ifndef __DEV_ARM_PL050_HH__ 49#define __DEV_ARM_PL050_HH__ 50 51#include "base/range.hh" 52#include "dev/io_device.hh" 53#include "params/Pl050.hh" 54 55class Gic; 56 57class Pl050 : public AmbaDevice 58{ 59 protected: 60 static const int kmiCr = 0x000; 61 static const int kmiStat = 0x004; 62 static const int kmiData = 0x008; 63 static const int kmiClkDiv = 0x00C; 64 static const int kmiISR = 0x010; 65 66 // control register 67 uint8_t control; 68 69 // status register 70 uint8_t status; 71 72 // received data (read) or data to be transmitted (write) 73 uint8_t kmidata; 74 75 // clock divisor register 76 uint8_t clkdiv; 77 78 BitUnion8(IntReg) 79 Bitfield<0> txintr; 80 Bitfield<1> rxintr; 81 EndBitUnion(IntReg) 82 83 /** interrupt mask register. */ 84 IntReg intreg; 85 86 /** Interrupt number to generate */ 87 int intNum; 88 89 /** Gic to use for interrupting */ 90 Gic *gic; 91 92 /** Delay before interrupting */ 93 Tick intDelay; 94 95 /** Function to generate interrupt */ 96 void generateInterrupt(); 97 98 /** Wrapper to create an event out of the thing */ 99 EventWrapper<Pl050, &Pl050::generateInterrupt> intEvent; 100 101 public: 102 typedef Pl050Params Params; 103 const Params * 104 params() const 105 { 106 return dynamic_cast<const Params *>(_params); 107 } 108 109 Pl050(const Params *p); 110 111 virtual Tick read(PacketPtr pkt); 112 virtual Tick write(PacketPtr pkt); 113 114 /** 115 * Return if we have an interrupt pending 116 * @return interrupt status 117 * @todo fix me when implementation improves 118 */ 119 virtual bool intStatus() { return false; } 120}; 121 122#endif 123