2 * Copyright (c) 2010-2012, 2015 ARM Limited
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.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * Authors: William Wang
41 #include "base/vnc/vncinput.hh"
42 #include "base/output.hh"
43 #include "base/trace.hh"
44 #include "debug/PL111.hh"
45 #include "debug/Uart.hh"
46 #include "dev/arm/amba_device.hh"
47 #include "dev/arm/base_gic.hh"
48 #include "dev/arm/pl111.hh"
49 #include "mem/packet.hh"
50 #include "mem/packet_access.hh"
51 #include "sim/system.hh"
53 // clang complains about std::set being overloaded with Packet::set if
54 // we open up the entire namespace std
57 // initialize clcd registers
58 Pl111::Pl111(const Params
*p
)
59 : AmbaDmaDevice(p
), lcdTiming0(0), lcdTiming1(0), lcdTiming2(0),
60 lcdTiming3(0), lcdUpbase(0), lcdLpbase(0), lcdControl(0), lcdImsc(0),
62 clcdCrsrCtrl(0), clcdCrsrConfig(0), clcdCrsrPalette0(0),
63 clcdCrsrPalette1(0), clcdCrsrXY(0), clcdCrsrClip(0), clcdCrsrImsc(0),
64 clcdCrsrIcr(0), clcdCrsrRis(0), clcdCrsrMis(0),
65 pixelClock(p
->pixel_clock
),
66 converter(PixelConverter::rgba8888_le
), fb(LcdMaxWidth
, LcdMaxHeight
),
67 vnc(p
->vnc
), bmp(&fb
), pic(NULL
),
68 width(LcdMaxWidth
), height(LcdMaxHeight
),
69 bytesPerPixel(4), startTime(0), startAddr(0), maxAddr(0), curAddr(0),
70 waterMark(0), dmaPendingNum(0), readEvent(this), fillFifoEvent(this),
71 dmaDoneEventAll(maxOutstandingDma
, this),
72 dmaDoneEventFree(maxOutstandingDma
),
73 intEvent(this), enableCapture(p
->enable_capture
)
77 dmaBuffer
= new uint8_t[buffer_size
];
79 memset(lcdPalette
, 0, sizeof(lcdPalette
));
80 memset(cursorImage
, 0, sizeof(cursorImage
));
81 memset(dmaBuffer
, 0, buffer_size
);
83 for (int i
= 0; i
< maxOutstandingDma
; ++i
)
84 dmaDoneEventFree
[i
] = &dmaDoneEventAll
[i
];
87 vnc
->setFrameBuffer(&fb
);
95 // read registers and frame buffer
97 Pl111::read(PacketPtr pkt
)
99 // use a temporary data since the LCD registers are read/written with
100 // different size operations
104 assert(pkt
->getAddr() >= pioAddr
&&
105 pkt
->getAddr() < pioAddr
+ pioSize
);
107 Addr daddr
= pkt
->getAddr() - pioAddr
;
109 DPRINTF(PL111
, " read register %#x size=%d\n", daddr
, pkt
->getSize());
143 panic("LCD register at offset %#x is Write-Only\n", daddr
);
155 data
= clcdCrsrConfig
;
157 case ClcdCrsrPalette0
:
158 data
= clcdCrsrPalette0
;
160 case ClcdCrsrPalette1
:
161 data
= clcdCrsrPalette1
;
173 panic("CLCD register at offset %#x is Write-Only\n", daddr
);
182 if (readId(pkt
, AMBA_ID
, pioAddr
)) {
183 // Hack for variable size accesses
184 data
= pkt
->get
<uint32_t>();
186 } else if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
189 index
= (daddr
- CrsrImage
) >> 2;
190 data
= cursorImage
[index
];
192 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
195 index
= (daddr
- LcdPalette
) >> 2;
196 data
= lcdPalette
[index
];
199 panic("Tried to read CLCD register at offset %#x that "
200 "doesn't exist\n", daddr
);
205 switch(pkt
->getSize()) {
207 pkt
->set
<uint8_t>(data
);
210 pkt
->set
<uint16_t>(data
);
213 pkt
->set
<uint32_t>(data
);
216 panic("CLCD controller read size too big?\n");
220 pkt
->makeAtomicResponse();
224 // write registers and frame buffer
226 Pl111::write(PacketPtr pkt
)
228 // use a temporary data since the LCD registers are read/written with
229 // different size operations
233 switch(pkt
->getSize()) {
235 data
= pkt
->get
<uint8_t>();
238 data
= pkt
->get
<uint16_t>();
241 data
= pkt
->get
<uint32_t>();
244 panic("PL111 CLCD controller write size too big?\n");
248 assert(pkt
->getAddr() >= pioAddr
&&
249 pkt
->getAddr() < pioAddr
+ pioSize
);
251 Addr daddr
= pkt
->getAddr() - pioAddr
;
253 DPRINTF(PL111
, " write register %#x value %#x size=%d\n", daddr
,
254 pkt
->get
<uint8_t>(), pkt
->getSize());
259 // width = 16 * (PPL+1)
260 width
= (lcdTiming0
.ppl
+ 1) << 4;
265 height
= (lcdTiming1
.lpp
) + 1;
275 DPRINTF(PL111
, "####### Upper panel base set to: %#x #######\n", lcdUpbase
);
278 warn_once("LCD dual screen mode not supported\n");
280 DPRINTF(PL111
, "###### Lower panel base set to: %#x #######\n", lcdLpbase
);
284 old_lcdpwr
= lcdControl
.lcdpwr
;
287 DPRINTF(PL111
, "LCD power is:%d\n", lcdControl
.lcdpwr
);
290 if (lcdControl
.lcdpwr
&& !old_lcdpwr
) {
292 DPRINTF(PL111
, " lcd size: height %d width %d\n", height
, width
);
293 waterMark
= lcdControl
.watermark
? 8 : 4;
300 panic("Interrupting on vcomp not supported\n");
302 lcdMis
= lcdImsc
& lcdRis
;
305 gic
->clearInt(intNum
);
309 panic("LCD register at offset %#x is Read-Only\n", daddr
);
312 panic("LCD register at offset %#x is Read-Only\n", daddr
);
315 lcdRis
= lcdRis
& ~data
;
316 lcdMis
= lcdImsc
& lcdRis
;
319 gic
->clearInt(intNum
);
323 panic("LCD register at offset %#x is Read-Only\n", daddr
);
326 panic("LCD register at offset %#x is Read-Only\n", daddr
);
332 clcdCrsrConfig
= data
;
334 case ClcdCrsrPalette0
:
335 clcdCrsrPalette0
= data
;
337 case ClcdCrsrPalette1
:
338 clcdCrsrPalette1
= data
;
353 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
356 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
359 if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
362 index
= (daddr
- CrsrImage
) >> 2;
363 cursorImage
[index
] = data
;
365 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
368 index
= (daddr
- LcdPalette
) >> 2;
369 lcdPalette
[index
] = data
;
372 panic("Tried to write PL111 register at offset %#x that "
373 "doesn't exist\n", daddr
);
378 pkt
->makeAtomicResponse();
383 Pl111::pixelConverter() const
388 switch (lcdControl
.lcdbpp
) {
406 panic("Unimplemented video mode\n");
409 if (lcdControl
.bgr
) {
410 return PixelConverter(
412 offsets
[2], offsets
[1], offsets
[0],
414 LittleEndianByteOrder
);
416 return PixelConverter(
418 offsets
[0], offsets
[1], offsets
[2],
420 LittleEndianByteOrder
);
425 Pl111::updateVideoParams()
427 if (lcdControl
.lcdbpp
== bpp24
) {
429 } else if (lcdControl
.lcdbpp
== bpp16m565
) {
433 fb
.resize(width
, height
);
434 converter
= pixelConverter();
436 // Workaround configuration bugs where multiple display
437 // controllers are attached to the same VNC server by reattaching
438 // enabled devices. This isn't ideal, but works as long as only
439 // one display controller is active at a time.
440 if (lcdControl
.lcdpwr
&& vnc
)
441 vnc
->setFrameBuffer(&fb
);
447 if (dmaPendingNum
!= 0 || readEvent
.scheduled())
453 Pl111::readFramebuffer()
455 // initialization for dma read from frame buffer to dma buffer
456 uint32_t length
= height
* width
;
457 if (startAddr
!= lcdUpbase
)
458 startAddr
= lcdUpbase
;
460 // Updating base address, interrupt if we're supposed to
462 if (!intEvent
.scheduled())
463 schedule(intEvent
, clockEdge());
466 startTime
= curTick();
468 maxAddr
= static_cast<Addr
>(length
* bytesPerPixel
);
470 DPRINTF(PL111
, " lcd frame buffer size of %d bytes \n", maxAddr
);
478 while ((dmaPendingNum
< maxOutstandingDma
) && (maxAddr
>= curAddr
+ dmaSize
)) {
479 // concurrent dma reads need different dma done events
480 // due to assertion in scheduling state
483 assert(!dmaDoneEventFree
.empty());
484 DmaDoneEvent
*event(dmaDoneEventFree
.back());
485 dmaDoneEventFree
.pop_back();
486 assert(!event
->scheduled());
488 // We use a uncachable request here because the requests from the CPU
489 // will be uncacheable as well. If we have uncacheable and cacheable
490 // requests in the memory system for the same address it won't be
492 dmaPort
.dmaAction(MemCmd::ReadReq
, curAddr
+ startAddr
, dmaSize
,
493 event
, curAddr
+ dmaBuffer
,
494 0, Request::UNCACHEABLE
);
502 DPRINTF(PL111
, "DMA Done\n");
504 Tick maxFrameTime
= lcdTiming2
.cpl
* height
* pixelClock
;
508 if (maxAddr
== curAddr
&& !dmaPendingNum
) {
509 if ((curTick() - startTime
) > maxFrameTime
) {
510 warn("CLCD controller buffer underrun, took %d ticks when should"
511 " have taken %d\n", curTick() - startTime
, maxFrameTime
);
512 lcdRis
.underflow
= 1;
513 if (!intEvent
.scheduled())
514 schedule(intEvent
, clockEdge());
517 assert(!readEvent
.scheduled());
518 fb
.copyIn(dmaBuffer
, converter
);
523 DPRINTF(PL111
, "-- write out frame buffer into bmp\n");
526 pic
= simout
.create(csprintf("%s.framebuffer.bmp", sys
->name()), true);
533 // schedule the next read based on when the last frame started
534 // and the desired fps (i.e. maxFrameTime), we turn the
535 // argument into a relative number of cycles in the future
536 if (lcdControl
.lcden
)
537 schedule(readEvent
, clockEdge(ticksToCycles(startTime
-
542 if (dmaPendingNum
> (maxOutstandingDma
- waterMark
))
545 if (!fillFifoEvent
.scheduled())
546 schedule(fillFifoEvent
, clockEdge());
550 Pl111::serialize(CheckpointOut
&cp
) const
552 DPRINTF(PL111
, "Serializing ARM PL111\n");
554 uint32_t lcdTiming0_serial
= lcdTiming0
;
555 SERIALIZE_SCALAR(lcdTiming0_serial
);
557 uint32_t lcdTiming1_serial
= lcdTiming1
;
558 SERIALIZE_SCALAR(lcdTiming1_serial
);
560 uint32_t lcdTiming2_serial
= lcdTiming2
;
561 SERIALIZE_SCALAR(lcdTiming2_serial
);
563 uint32_t lcdTiming3_serial
= lcdTiming3
;
564 SERIALIZE_SCALAR(lcdTiming3_serial
);
566 SERIALIZE_SCALAR(lcdUpbase
);
567 SERIALIZE_SCALAR(lcdLpbase
);
569 uint32_t lcdControl_serial
= lcdControl
;
570 SERIALIZE_SCALAR(lcdControl_serial
);
572 uint8_t lcdImsc_serial
= lcdImsc
;
573 SERIALIZE_SCALAR(lcdImsc_serial
);
575 uint8_t lcdRis_serial
= lcdRis
;
576 SERIALIZE_SCALAR(lcdRis_serial
);
578 uint8_t lcdMis_serial
= lcdMis
;
579 SERIALIZE_SCALAR(lcdMis_serial
);
581 SERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
582 SERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
584 SERIALIZE_SCALAR(clcdCrsrCtrl
);
585 SERIALIZE_SCALAR(clcdCrsrConfig
);
586 SERIALIZE_SCALAR(clcdCrsrPalette0
);
587 SERIALIZE_SCALAR(clcdCrsrPalette1
);
588 SERIALIZE_SCALAR(clcdCrsrXY
);
589 SERIALIZE_SCALAR(clcdCrsrClip
);
591 uint8_t clcdCrsrImsc_serial
= clcdCrsrImsc
;
592 SERIALIZE_SCALAR(clcdCrsrImsc_serial
);
594 uint8_t clcdCrsrIcr_serial
= clcdCrsrIcr
;
595 SERIALIZE_SCALAR(clcdCrsrIcr_serial
);
597 uint8_t clcdCrsrRis_serial
= clcdCrsrRis
;
598 SERIALIZE_SCALAR(clcdCrsrRis_serial
);
600 uint8_t clcdCrsrMis_serial
= clcdCrsrMis
;
601 SERIALIZE_SCALAR(clcdCrsrMis_serial
);
603 SERIALIZE_SCALAR(height
);
604 SERIALIZE_SCALAR(width
);
605 SERIALIZE_SCALAR(bytesPerPixel
);
607 SERIALIZE_ARRAY(dmaBuffer
, buffer_size
);
608 SERIALIZE_SCALAR(startTime
);
609 SERIALIZE_SCALAR(startAddr
);
610 SERIALIZE_SCALAR(maxAddr
);
611 SERIALIZE_SCALAR(curAddr
);
612 SERIALIZE_SCALAR(waterMark
);
613 SERIALIZE_SCALAR(dmaPendingNum
);
615 Tick int_event_time
= 0;
616 Tick read_event_time
= 0;
617 Tick fill_fifo_event_time
= 0;
619 if (readEvent
.scheduled())
620 read_event_time
= readEvent
.when();
621 if (fillFifoEvent
.scheduled())
622 fill_fifo_event_time
= fillFifoEvent
.when();
623 if (intEvent
.scheduled())
624 int_event_time
= intEvent
.when();
626 SERIALIZE_SCALAR(read_event_time
);
627 SERIALIZE_SCALAR(fill_fifo_event_time
);
628 SERIALIZE_SCALAR(int_event_time
);
630 vector
<Tick
> dma_done_event_tick
;
631 dma_done_event_tick
.resize(maxOutstandingDma
);
632 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
633 dma_done_event_tick
[x
] = dmaDoneEventAll
[x
].scheduled() ?
634 dmaDoneEventAll
[x
].when() : 0;
636 SERIALIZE_CONTAINER(dma_done_event_tick
);
640 Pl111::unserialize(CheckpointIn
&cp
)
642 DPRINTF(PL111
, "Unserializing ARM PL111\n");
644 uint32_t lcdTiming0_serial
;
645 UNSERIALIZE_SCALAR(lcdTiming0_serial
);
646 lcdTiming0
= lcdTiming0_serial
;
648 uint32_t lcdTiming1_serial
;
649 UNSERIALIZE_SCALAR(lcdTiming1_serial
);
650 lcdTiming1
= lcdTiming1_serial
;
652 uint32_t lcdTiming2_serial
;
653 UNSERIALIZE_SCALAR(lcdTiming2_serial
);
654 lcdTiming2
= lcdTiming2_serial
;
656 uint32_t lcdTiming3_serial
;
657 UNSERIALIZE_SCALAR(lcdTiming3_serial
);
658 lcdTiming3
= lcdTiming3_serial
;
660 UNSERIALIZE_SCALAR(lcdUpbase
);
661 UNSERIALIZE_SCALAR(lcdLpbase
);
663 uint32_t lcdControl_serial
;
664 UNSERIALIZE_SCALAR(lcdControl_serial
);
665 lcdControl
= lcdControl_serial
;
667 uint8_t lcdImsc_serial
;
668 UNSERIALIZE_SCALAR(lcdImsc_serial
);
669 lcdImsc
= lcdImsc_serial
;
671 uint8_t lcdRis_serial
;
672 UNSERIALIZE_SCALAR(lcdRis_serial
);
673 lcdRis
= lcdRis_serial
;
675 uint8_t lcdMis_serial
;
676 UNSERIALIZE_SCALAR(lcdMis_serial
);
677 lcdMis
= lcdMis_serial
;
679 UNSERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
680 UNSERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
682 UNSERIALIZE_SCALAR(clcdCrsrCtrl
);
683 UNSERIALIZE_SCALAR(clcdCrsrConfig
);
684 UNSERIALIZE_SCALAR(clcdCrsrPalette0
);
685 UNSERIALIZE_SCALAR(clcdCrsrPalette1
);
686 UNSERIALIZE_SCALAR(clcdCrsrXY
);
687 UNSERIALIZE_SCALAR(clcdCrsrClip
);
689 uint8_t clcdCrsrImsc_serial
;
690 UNSERIALIZE_SCALAR(clcdCrsrImsc_serial
);
691 clcdCrsrImsc
= clcdCrsrImsc_serial
;
693 uint8_t clcdCrsrIcr_serial
;
694 UNSERIALIZE_SCALAR(clcdCrsrIcr_serial
);
695 clcdCrsrIcr
= clcdCrsrIcr_serial
;
697 uint8_t clcdCrsrRis_serial
;
698 UNSERIALIZE_SCALAR(clcdCrsrRis_serial
);
699 clcdCrsrRis
= clcdCrsrRis_serial
;
701 uint8_t clcdCrsrMis_serial
;
702 UNSERIALIZE_SCALAR(clcdCrsrMis_serial
);
703 clcdCrsrMis
= clcdCrsrMis_serial
;
705 UNSERIALIZE_SCALAR(height
);
706 UNSERIALIZE_SCALAR(width
);
707 UNSERIALIZE_SCALAR(bytesPerPixel
);
709 UNSERIALIZE_ARRAY(dmaBuffer
, buffer_size
);
710 UNSERIALIZE_SCALAR(startTime
);
711 UNSERIALIZE_SCALAR(startAddr
);
712 UNSERIALIZE_SCALAR(maxAddr
);
713 UNSERIALIZE_SCALAR(curAddr
);
714 UNSERIALIZE_SCALAR(waterMark
);
715 UNSERIALIZE_SCALAR(dmaPendingNum
);
717 Tick int_event_time
= 0;
718 Tick read_event_time
= 0;
719 Tick fill_fifo_event_time
= 0;
721 UNSERIALIZE_SCALAR(read_event_time
);
722 UNSERIALIZE_SCALAR(fill_fifo_event_time
);
723 UNSERIALIZE_SCALAR(int_event_time
);
726 schedule(intEvent
, int_event_time
);
728 schedule(readEvent
, read_event_time
);
729 if (fill_fifo_event_time
)
730 schedule(fillFifoEvent
, fill_fifo_event_time
);
732 vector
<Tick
> dma_done_event_tick
;
733 dma_done_event_tick
.resize(maxOutstandingDma
);
734 UNSERIALIZE_CONTAINER(dma_done_event_tick
);
735 dmaDoneEventFree
.clear();
736 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
737 if (dma_done_event_tick
[x
])
738 schedule(dmaDoneEventAll
[x
], dma_done_event_tick
[x
]);
740 dmaDoneEventFree
.push_back(&dmaDoneEventAll
[x
]);
742 assert(maxOutstandingDma
- dmaDoneEventFree
.size() == dmaPendingNum
);
744 if (lcdControl
.lcdpwr
) {
746 fb
.copyIn(dmaBuffer
, converter
);
753 Pl111::generateInterrupt()
755 DPRINTF(PL111
, "Generate Interrupt: lcdImsc=0x%x lcdRis=0x%x lcdMis=0x%x\n",
756 (uint32_t)lcdImsc
, (uint32_t)lcdRis
, (uint32_t)lcdMis
);
757 lcdMis
= lcdImsc
& lcdRis
;
759 if (lcdMis
.underflow
|| lcdMis
.baseaddr
|| lcdMis
.vcomp
|| lcdMis
.ahbmaster
) {
760 gic
->sendInt(intNum
);
761 DPRINTF(PL111
, " -- Generated\n");
766 Pl111::getAddrRanges() const
768 AddrRangeList ranges
;
769 ranges
.push_back(RangeSize(pioAddr
, pioSize
));
774 Pl111Params::create()
776 return new Pl111(this);