pl111.hh revision 8711
17753SWilliam.Wang@arm.com/* 27753SWilliam.Wang@arm.com * Copyright (c) 2010 ARM Limited 37753SWilliam.Wang@arm.com * All rights reserved 47753SWilliam.Wang@arm.com * 57753SWilliam.Wang@arm.com * The license below extends only to copyright in the software and shall 67753SWilliam.Wang@arm.com * not be construed as granting a license to any other intellectual 77753SWilliam.Wang@arm.com * property including but not limited to intellectual property relating 87753SWilliam.Wang@arm.com * to a hardware implementation of the functionality of the software 97753SWilliam.Wang@arm.com * licensed hereunder. You may use the software subject to the license 107753SWilliam.Wang@arm.com * terms below provided that you ensure that this notice is replicated 117753SWilliam.Wang@arm.com * unmodified and in its entirety in all distributions of the software, 127753SWilliam.Wang@arm.com * modified or unmodified, in source code or in binary form. 137753SWilliam.Wang@arm.com * 147753SWilliam.Wang@arm.com * Redistribution and use in source and binary forms, with or without 157753SWilliam.Wang@arm.com * modification, are permitted provided that the following conditions are 167753SWilliam.Wang@arm.com * met: redistributions of source code must retain the above copyright 177753SWilliam.Wang@arm.com * notice, this list of conditions and the following disclaimer; 187753SWilliam.Wang@arm.com * redistributions in binary form must reproduce the above copyright 197753SWilliam.Wang@arm.com * notice, this list of conditions and the following disclaimer in the 207753SWilliam.Wang@arm.com * documentation and/or other materials provided with the distribution; 217753SWilliam.Wang@arm.com * neither the name of the copyright holders nor the names of its 227753SWilliam.Wang@arm.com * contributors may be used to endorse or promote products derived from 237753SWilliam.Wang@arm.com * this software without specific prior written permission. 247753SWilliam.Wang@arm.com * 257753SWilliam.Wang@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 267753SWilliam.Wang@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 277753SWilliam.Wang@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 287753SWilliam.Wang@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 297753SWilliam.Wang@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 307753SWilliam.Wang@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 317753SWilliam.Wang@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 327753SWilliam.Wang@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 337753SWilliam.Wang@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 347753SWilliam.Wang@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 357753SWilliam.Wang@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 367753SWilliam.Wang@arm.com * 377753SWilliam.Wang@arm.com * Authors: William Wang 387950SAli.Saidi@ARM.com * Ali Saidi 397753SWilliam.Wang@arm.com */ 407753SWilliam.Wang@arm.com 417753SWilliam.Wang@arm.com 427753SWilliam.Wang@arm.com/** @file 437753SWilliam.Wang@arm.com * Implementiation of a PL111 CLCD controller 447753SWilliam.Wang@arm.com */ 457753SWilliam.Wang@arm.com 467753SWilliam.Wang@arm.com#ifndef __DEV_ARM_PL111_HH__ 477753SWilliam.Wang@arm.com#define __DEV_ARM_PL111_HH__ 487753SWilliam.Wang@arm.com 497753SWilliam.Wang@arm.com#include <fstream> 507753SWilliam.Wang@arm.com 517753SWilliam.Wang@arm.com#include "base/range.hh" 527753SWilliam.Wang@arm.com#include "dev/arm/amba_device.hh" 537753SWilliam.Wang@arm.com#include "params/Pl111.hh" 547753SWilliam.Wang@arm.com#include "sim/serialize.hh" 557753SWilliam.Wang@arm.com 567753SWilliam.Wang@arm.comusing namespace std; 577753SWilliam.Wang@arm.com 587753SWilliam.Wang@arm.comclass Gic; 597950SAli.Saidi@ARM.comclass VncServer; 607950SAli.Saidi@ARM.comclass Bitmap; 617753SWilliam.Wang@arm.com 627753SWilliam.Wang@arm.comclass Pl111: public AmbaDmaDevice 637753SWilliam.Wang@arm.com{ 647753SWilliam.Wang@arm.com protected: 657753SWilliam.Wang@arm.com static const uint64_t AMBA_ID = ULL(0xb105f00d00141111); 667753SWilliam.Wang@arm.com /** ARM PL111 register map*/ 677753SWilliam.Wang@arm.com static const int LcdTiming0 = 0x000; 687753SWilliam.Wang@arm.com static const int LcdTiming1 = 0x004; 697753SWilliam.Wang@arm.com static const int LcdTiming2 = 0x008; 707753SWilliam.Wang@arm.com static const int LcdTiming3 = 0x00C; 717753SWilliam.Wang@arm.com static const int LcdUpBase = 0x010; 727753SWilliam.Wang@arm.com static const int LcdLpBase = 0x014; 737753SWilliam.Wang@arm.com static const int LcdControl = 0x018; 747753SWilliam.Wang@arm.com static const int LcdImsc = 0x01C; 757753SWilliam.Wang@arm.com static const int LcdRis = 0x020; 767753SWilliam.Wang@arm.com static const int LcdMis = 0x024; 777753SWilliam.Wang@arm.com static const int LcdIcr = 0x028; 787753SWilliam.Wang@arm.com static const int LcdUpCurr = 0x02C; 797753SWilliam.Wang@arm.com static const int LcdLpCurr = 0x030; 807753SWilliam.Wang@arm.com static const int LcdPalette = 0x200; 817753SWilliam.Wang@arm.com static const int CrsrImage = 0x800; 827753SWilliam.Wang@arm.com static const int ClcdCrsrCtrl = 0xC00; 837753SWilliam.Wang@arm.com static const int ClcdCrsrConfig = 0xC04; 847753SWilliam.Wang@arm.com static const int ClcdCrsrPalette0 = 0xC08; 857753SWilliam.Wang@arm.com static const int ClcdCrsrPalette1 = 0xC0C; 867753SWilliam.Wang@arm.com static const int ClcdCrsrXY = 0xC10; 877753SWilliam.Wang@arm.com static const int ClcdCrsrClip = 0xC14; 887753SWilliam.Wang@arm.com static const int ClcdCrsrImsc = 0xC20; 897753SWilliam.Wang@arm.com static const int ClcdCrsrIcr = 0xC24; 907753SWilliam.Wang@arm.com static const int ClcdCrsrRis = 0xC28; 917753SWilliam.Wang@arm.com static const int ClcdCrsrMis = 0xC2C; 927753SWilliam.Wang@arm.com 937753SWilliam.Wang@arm.com static const int LcdPaletteSize = 128; 947753SWilliam.Wang@arm.com static const int CrsrImageSize = 256; 957753SWilliam.Wang@arm.com 967753SWilliam.Wang@arm.com static const int LcdMaxWidth = 1024; // pixels per line 977753SWilliam.Wang@arm.com static const int LcdMaxHeight = 768; // lines per panel 987753SWilliam.Wang@arm.com 997753SWilliam.Wang@arm.com static const int dmaSize = 8; // 64 bits 1007753SWilliam.Wang@arm.com static const int maxOutstandingDma = 16; // 16 deep FIFO of 64 bits 1017753SWilliam.Wang@arm.com 1027950SAli.Saidi@ARM.com enum LcdMode { 1037950SAli.Saidi@ARM.com bpp1 = 0, 1047950SAli.Saidi@ARM.com bpp2, 1057950SAli.Saidi@ARM.com bpp4, 1067950SAli.Saidi@ARM.com bpp8, 1077950SAli.Saidi@ARM.com bpp16, 1087950SAli.Saidi@ARM.com bpp24, 1097950SAli.Saidi@ARM.com bpp16m565, 1107950SAli.Saidi@ARM.com bpp12 1117950SAli.Saidi@ARM.com }; 1127950SAli.Saidi@ARM.com 1137753SWilliam.Wang@arm.com BitUnion8(InterruptReg) 1147950SAli.Saidi@ARM.com Bitfield<1> underflow; 1157950SAli.Saidi@ARM.com Bitfield<2> baseaddr; 1167950SAli.Saidi@ARM.com Bitfield<3> vcomp; 1177950SAli.Saidi@ARM.com Bitfield<4> ahbmaster; 1187753SWilliam.Wang@arm.com EndBitUnion(InterruptReg) 1197753SWilliam.Wang@arm.com 1207753SWilliam.Wang@arm.com BitUnion32(TimingReg0) 1217950SAli.Saidi@ARM.com Bitfield<7,2> ppl; 1227950SAli.Saidi@ARM.com Bitfield<15,8> hsw; 1237950SAli.Saidi@ARM.com Bitfield<23,16> hfp; 1247950SAli.Saidi@ARM.com Bitfield<31,24> hbp; 1257753SWilliam.Wang@arm.com EndBitUnion(TimingReg0) 1267753SWilliam.Wang@arm.com 1277753SWilliam.Wang@arm.com BitUnion32(TimingReg1) 1287950SAli.Saidi@ARM.com Bitfield<9,0> lpp; 1297950SAli.Saidi@ARM.com Bitfield<15,10> vsw; 1307950SAli.Saidi@ARM.com Bitfield<23,16> vfp; 1317950SAli.Saidi@ARM.com Bitfield<31,24> vbp; 1327753SWilliam.Wang@arm.com EndBitUnion(TimingReg1) 1337753SWilliam.Wang@arm.com 1347753SWilliam.Wang@arm.com BitUnion32(TimingReg2) 1357950SAli.Saidi@ARM.com Bitfield<4,0> pcdlo; 1367950SAli.Saidi@ARM.com Bitfield<5> clksel; 1377950SAli.Saidi@ARM.com Bitfield<10,6> acb; 1387950SAli.Saidi@ARM.com Bitfield<11> avs; 1397950SAli.Saidi@ARM.com Bitfield<12> ihs; 1407950SAli.Saidi@ARM.com Bitfield<13> ipc; 1417950SAli.Saidi@ARM.com Bitfield<14> ioe; 1427950SAli.Saidi@ARM.com Bitfield<25,16> cpl; 1437950SAli.Saidi@ARM.com Bitfield<26> bcd; 1447950SAli.Saidi@ARM.com Bitfield<31,27> pcdhi; 1457753SWilliam.Wang@arm.com EndBitUnion(TimingReg2) 1467753SWilliam.Wang@arm.com 1477753SWilliam.Wang@arm.com BitUnion32(TimingReg3) 1487950SAli.Saidi@ARM.com Bitfield<6,0> led; 1497950SAli.Saidi@ARM.com Bitfield<16> lee; 1507753SWilliam.Wang@arm.com EndBitUnion(TimingReg3) 1517753SWilliam.Wang@arm.com 1527753SWilliam.Wang@arm.com BitUnion32(ControlReg) 1537950SAli.Saidi@ARM.com Bitfield<0> lcden; 1547950SAli.Saidi@ARM.com Bitfield<3,1> lcdbpp; 1557950SAli.Saidi@ARM.com Bitfield<4> lcdbw; 1567950SAli.Saidi@ARM.com Bitfield<5> lcdtft; 1577950SAli.Saidi@ARM.com Bitfield<6> lcdmono8; 1587950SAli.Saidi@ARM.com Bitfield<7> lcddual; 1597950SAli.Saidi@ARM.com Bitfield<8> bgr; 1607950SAli.Saidi@ARM.com Bitfield<9> bebo; 1617950SAli.Saidi@ARM.com Bitfield<10> bepo; 1627950SAli.Saidi@ARM.com Bitfield<11> lcdpwr; 1637950SAli.Saidi@ARM.com Bitfield<13,12> lcdvcomp; 1647950SAli.Saidi@ARM.com Bitfield<16> watermark; 1657753SWilliam.Wang@arm.com EndBitUnion(ControlReg) 1667753SWilliam.Wang@arm.com 1677753SWilliam.Wang@arm.com /** Horizontal axis panel control register */ 1687753SWilliam.Wang@arm.com TimingReg0 lcdTiming0; 1697753SWilliam.Wang@arm.com 1707753SWilliam.Wang@arm.com /** Vertical axis panel control register */ 1717753SWilliam.Wang@arm.com TimingReg1 lcdTiming1; 1727753SWilliam.Wang@arm.com 1737753SWilliam.Wang@arm.com /** Clock and signal polarity control register */ 1747753SWilliam.Wang@arm.com TimingReg2 lcdTiming2; 1757753SWilliam.Wang@arm.com 1767753SWilliam.Wang@arm.com /** Line end control register */ 1777753SWilliam.Wang@arm.com TimingReg3 lcdTiming3; 1787753SWilliam.Wang@arm.com 1797753SWilliam.Wang@arm.com /** Upper panel frame base address register */ 1807753SWilliam.Wang@arm.com int lcdUpbase; 1817753SWilliam.Wang@arm.com 1827753SWilliam.Wang@arm.com /** Lower panel frame base address register */ 1837753SWilliam.Wang@arm.com int lcdLpbase; 1847753SWilliam.Wang@arm.com 1857753SWilliam.Wang@arm.com /** Control register */ 1867753SWilliam.Wang@arm.com ControlReg lcdControl; 1877753SWilliam.Wang@arm.com 1887753SWilliam.Wang@arm.com /** Interrupt mask set/clear register */ 1897753SWilliam.Wang@arm.com InterruptReg lcdImsc; 1907753SWilliam.Wang@arm.com 1917753SWilliam.Wang@arm.com /** Raw interrupt status register - const */ 1927753SWilliam.Wang@arm.com InterruptReg lcdRis; 1937753SWilliam.Wang@arm.com 1947753SWilliam.Wang@arm.com /** Masked interrupt status register */ 1957753SWilliam.Wang@arm.com InterruptReg lcdMis; 1967753SWilliam.Wang@arm.com 1977753SWilliam.Wang@arm.com /** 256x16-bit color palette registers 1987753SWilliam.Wang@arm.com * 256 palette entries organized as 128 locations of two entries per word */ 1997753SWilliam.Wang@arm.com int lcdPalette[LcdPaletteSize]; 2007753SWilliam.Wang@arm.com 2017753SWilliam.Wang@arm.com /** Cursor image RAM register 2027753SWilliam.Wang@arm.com * 256-word wide values defining images overlaid by the hw cursor mechanism */ 2037753SWilliam.Wang@arm.com int cursorImage[CrsrImageSize]; 2047753SWilliam.Wang@arm.com 2057753SWilliam.Wang@arm.com /** Cursor control register */ 2067753SWilliam.Wang@arm.com int clcdCrsrCtrl; 2077753SWilliam.Wang@arm.com 2087753SWilliam.Wang@arm.com /** Cursor configuration register */ 2097753SWilliam.Wang@arm.com int clcdCrsrConfig; 2107753SWilliam.Wang@arm.com 2117753SWilliam.Wang@arm.com /** Cursor palette registers */ 2127753SWilliam.Wang@arm.com int clcdCrsrPalette0; 2137753SWilliam.Wang@arm.com int clcdCrsrPalette1; 2147753SWilliam.Wang@arm.com 2157753SWilliam.Wang@arm.com /** Cursor XY position register */ 2167753SWilliam.Wang@arm.com int clcdCrsrXY; 2177753SWilliam.Wang@arm.com 2187753SWilliam.Wang@arm.com /** Cursor clip position register */ 2197753SWilliam.Wang@arm.com int clcdCrsrClip; 2207753SWilliam.Wang@arm.com 2217753SWilliam.Wang@arm.com /** Cursor interrupt mask set/clear register */ 2227753SWilliam.Wang@arm.com InterruptReg clcdCrsrImsc; 2237753SWilliam.Wang@arm.com 2247753SWilliam.Wang@arm.com /** Cursor interrupt clear register */ 2257753SWilliam.Wang@arm.com InterruptReg clcdCrsrIcr; 2267753SWilliam.Wang@arm.com 2277753SWilliam.Wang@arm.com /** Cursor raw interrupt status register - const */ 2287753SWilliam.Wang@arm.com InterruptReg clcdCrsrRis; 2297753SWilliam.Wang@arm.com 2307753SWilliam.Wang@arm.com /** Cursor masked interrupt status register - const */ 2317753SWilliam.Wang@arm.com InterruptReg clcdCrsrMis; 2327753SWilliam.Wang@arm.com 2337753SWilliam.Wang@arm.com /** Clock speed */ 2347753SWilliam.Wang@arm.com Tick clock; 2357753SWilliam.Wang@arm.com 2367950SAli.Saidi@ARM.com /** VNC server */ 2377950SAli.Saidi@ARM.com VncServer *vncserver; 2387950SAli.Saidi@ARM.com 2397950SAli.Saidi@ARM.com /** Helper to write out bitmaps */ 2407950SAli.Saidi@ARM.com Bitmap *bmp; 2417950SAli.Saidi@ARM.com 2427950SAli.Saidi@ARM.com /** Picture of what the current frame buffer looks like */ 2437950SAli.Saidi@ARM.com std::ostream *pic; 2447753SWilliam.Wang@arm.com 2457753SWilliam.Wang@arm.com /** Frame buffer width - pixels per line */ 2467753SWilliam.Wang@arm.com uint16_t width; 2477753SWilliam.Wang@arm.com 2487950SAli.Saidi@ARM.com /** Frame buffer height - lines per panel */ 2497950SAli.Saidi@ARM.com uint16_t height; 2507950SAli.Saidi@ARM.com 2517950SAli.Saidi@ARM.com /** Bytes per pixel */ 2527950SAli.Saidi@ARM.com uint8_t bytesPerPixel; 2537950SAli.Saidi@ARM.com 2547753SWilliam.Wang@arm.com /** CLCDC supports up to 1024x768 */ 2557950SAli.Saidi@ARM.com uint8_t *dmaBuffer; 2567753SWilliam.Wang@arm.com 2577753SWilliam.Wang@arm.com /** Start time for frame buffer dma read */ 2587753SWilliam.Wang@arm.com Tick startTime; 2597753SWilliam.Wang@arm.com 2607753SWilliam.Wang@arm.com /** Frame buffer base address */ 2617753SWilliam.Wang@arm.com Addr startAddr; 2627753SWilliam.Wang@arm.com 2637753SWilliam.Wang@arm.com /** Frame buffer max address */ 2647753SWilliam.Wang@arm.com Addr maxAddr; 2657753SWilliam.Wang@arm.com 2667753SWilliam.Wang@arm.com /** Frame buffer current address */ 2677753SWilliam.Wang@arm.com Addr curAddr; 2687753SWilliam.Wang@arm.com 2697753SWilliam.Wang@arm.com /** DMA FIFO watermark */ 2707753SWilliam.Wang@arm.com int waterMark; 2717753SWilliam.Wang@arm.com 2727753SWilliam.Wang@arm.com /** Number of pending dma reads */ 2737753SWilliam.Wang@arm.com int dmaPendingNum; 2747753SWilliam.Wang@arm.com 2757950SAli.Saidi@ARM.com /** Send updated parameters to the vnc server */ 2767950SAli.Saidi@ARM.com void updateVideoParams(); 2777950SAli.Saidi@ARM.com 2787753SWilliam.Wang@arm.com /** DMA framebuffer read */ 2797753SWilliam.Wang@arm.com void readFramebuffer(); 2807753SWilliam.Wang@arm.com 2817753SWilliam.Wang@arm.com /** Generate dma framebuffer read event */ 2827753SWilliam.Wang@arm.com void generateReadEvent(); 2837753SWilliam.Wang@arm.com 2847753SWilliam.Wang@arm.com /** Function to generate interrupt */ 2857753SWilliam.Wang@arm.com void generateInterrupt(); 2867753SWilliam.Wang@arm.com 2877753SWilliam.Wang@arm.com /** fillFIFO event */ 2887753SWilliam.Wang@arm.com void fillFifo(); 2897753SWilliam.Wang@arm.com 2907950SAli.Saidi@ARM.com /** start the dmas off after power is enabled */ 2917950SAli.Saidi@ARM.com void startDma(); 2927950SAli.Saidi@ARM.com 2937753SWilliam.Wang@arm.com /** DMA done event */ 2947753SWilliam.Wang@arm.com void dmaDone(); 2957753SWilliam.Wang@arm.com 2967753SWilliam.Wang@arm.com /** Next cycle event */ 2977753SWilliam.Wang@arm.com Tick nextCycle(); 2987753SWilliam.Wang@arm.com Tick nextCycle(Tick beginTick); 2997753SWilliam.Wang@arm.com 3007753SWilliam.Wang@arm.com /** DMA framebuffer read event */ 3017753SWilliam.Wang@arm.com EventWrapper<Pl111, &Pl111::readFramebuffer> readEvent; 3027753SWilliam.Wang@arm.com 3037753SWilliam.Wang@arm.com /** Fill fifo */ 3047753SWilliam.Wang@arm.com EventWrapper<Pl111, &Pl111::fillFifo> fillFifoEvent; 3057753SWilliam.Wang@arm.com 3067753SWilliam.Wang@arm.com /** DMA done event */ 3077753SWilliam.Wang@arm.com vector<EventWrapper<Pl111, &Pl111::dmaDone> > dmaDoneEvent; 3087753SWilliam.Wang@arm.com 3097950SAli.Saidi@ARM.com /** Wrapper to create an event out of the interrupt */ 3107753SWilliam.Wang@arm.com EventWrapper<Pl111, &Pl111::generateInterrupt> intEvent; 3117753SWilliam.Wang@arm.com 3127753SWilliam.Wang@arm.com public: 3137753SWilliam.Wang@arm.com typedef Pl111Params Params; 3147753SWilliam.Wang@arm.com 3157753SWilliam.Wang@arm.com const Params * 3167753SWilliam.Wang@arm.com params() const 3177753SWilliam.Wang@arm.com { 3187753SWilliam.Wang@arm.com return dynamic_cast<const Params *>(_params); 3197753SWilliam.Wang@arm.com } 3207753SWilliam.Wang@arm.com Pl111(const Params *p); 3217753SWilliam.Wang@arm.com 3227753SWilliam.Wang@arm.com virtual Tick read(PacketPtr pkt); 3237753SWilliam.Wang@arm.com virtual Tick write(PacketPtr pkt); 3247753SWilliam.Wang@arm.com 3257753SWilliam.Wang@arm.com virtual void serialize(std::ostream &os); 3267753SWilliam.Wang@arm.com virtual void unserialize(Checkpoint *cp, const std::string §ion); 3277753SWilliam.Wang@arm.com 3288711Sandreas.hansson@arm.com /** 3298711Sandreas.hansson@arm.com * Determine the address ranges that this device responds to. 3308711Sandreas.hansson@arm.com * 3318711Sandreas.hansson@arm.com * @return a list of non-overlapping address ranges 3327753SWilliam.Wang@arm.com */ 3338711Sandreas.hansson@arm.com AddrRangeList getAddrRanges(); 3347753SWilliam.Wang@arm.com}; 3357753SWilliam.Wang@arm.com 3367753SWilliam.Wang@arm.com#endif 337