2 * Copyright (c) 2010-2012 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/bitmap.hh"
43 #include "base/output.hh"
44 #include "base/trace.hh"
45 #include "debug/PL111.hh"
46 #include "debug/Uart.hh"
47 #include "dev/arm/amba_device.hh"
48 #include "dev/arm/base_gic.hh"
49 #include "dev/arm/pl111.hh"
50 #include "mem/packet.hh"
51 #include "mem/packet_access.hh"
52 #include "sim/system.hh"
54 // clang complains about std::set being overloaded with Packet::set if
55 // we open up the entire namespace std
58 // initialize clcd registers
59 Pl111::Pl111(const Params
*p
)
60 : AmbaDmaDevice(p
), lcdTiming0(0), lcdTiming1(0), lcdTiming2(0),
61 lcdTiming3(0), lcdUpbase(0), lcdLpbase(0), lcdControl(0), lcdImsc(0),
63 clcdCrsrCtrl(0), clcdCrsrConfig(0), clcdCrsrPalette0(0),
64 clcdCrsrPalette1(0), clcdCrsrXY(0), clcdCrsrClip(0), clcdCrsrImsc(0),
65 clcdCrsrIcr(0), clcdCrsrRis(0), clcdCrsrMis(0),
66 pixelClock(p
->pixel_clock
), vnc(p
->vnc
), bmp(NULL
), pic(NULL
),
67 width(LcdMaxWidth
), height(LcdMaxHeight
),
68 bytesPerPixel(4), startTime(0), startAddr(0), maxAddr(0), curAddr(0),
69 waterMark(0), dmaPendingNum(0), readEvent(this), fillFifoEvent(this),
70 dmaDoneEventAll(maxOutstandingDma
, this),
71 dmaDoneEventFree(maxOutstandingDma
),
72 intEvent(this), enableCapture(p
->enable_capture
)
76 dmaBuffer
= new uint8_t[buffer_size
];
78 memset(lcdPalette
, 0, sizeof(lcdPalette
));
79 memset(cursorImage
, 0, sizeof(cursorImage
));
80 memset(dmaBuffer
, 0, buffer_size
);
82 for (int i
= 0; i
< maxOutstandingDma
; ++i
)
83 dmaDoneEventFree
[i
] = &dmaDoneEventAll
[i
];
86 vnc
->setFramebufferAddr(dmaBuffer
);
94 // read registers and frame buffer
96 Pl111::read(PacketPtr pkt
)
98 // use a temporary data since the LCD registers are read/written with
99 // different size operations
103 assert(pkt
->getAddr() >= pioAddr
&&
104 pkt
->getAddr() < pioAddr
+ pioSize
);
106 Addr daddr
= pkt
->getAddr() - pioAddr
;
108 DPRINTF(PL111
, " read register %#x size=%d\n", daddr
, pkt
->getSize());
142 panic("LCD register at offset %#x is Write-Only\n", daddr
);
154 data
= clcdCrsrConfig
;
156 case ClcdCrsrPalette0
:
157 data
= clcdCrsrPalette0
;
159 case ClcdCrsrPalette1
:
160 data
= clcdCrsrPalette1
;
172 panic("CLCD register at offset %#x is Write-Only\n", daddr
);
181 if (readId(pkt
, AMBA_ID
, pioAddr
)) {
182 // Hack for variable size accesses
183 data
= pkt
->get
<uint32_t>();
185 } else if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
188 index
= (daddr
- CrsrImage
) >> 2;
189 data
= cursorImage
[index
];
191 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
194 index
= (daddr
- LcdPalette
) >> 2;
195 data
= lcdPalette
[index
];
198 panic("Tried to read CLCD register at offset %#x that "
199 "doesn't exist\n", daddr
);
204 switch(pkt
->getSize()) {
206 pkt
->set
<uint8_t>(data
);
209 pkt
->set
<uint16_t>(data
);
212 pkt
->set
<uint32_t>(data
);
215 panic("CLCD controller read size too big?\n");
219 pkt
->makeAtomicResponse();
223 // write registers and frame buffer
225 Pl111::write(PacketPtr pkt
)
227 // use a temporary data since the LCD registers are read/written with
228 // different size operations
232 switch(pkt
->getSize()) {
234 data
= pkt
->get
<uint8_t>();
237 data
= pkt
->get
<uint16_t>();
240 data
= pkt
->get
<uint32_t>();
243 panic("PL111 CLCD controller write size too big?\n");
247 assert(pkt
->getAddr() >= pioAddr
&&
248 pkt
->getAddr() < pioAddr
+ pioSize
);
250 Addr daddr
= pkt
->getAddr() - pioAddr
;
252 DPRINTF(PL111
, " write register %#x value %#x size=%d\n", daddr
,
253 pkt
->get
<uint8_t>(), pkt
->getSize());
258 // width = 16 * (PPL+1)
259 width
= (lcdTiming0
.ppl
+ 1) << 4;
264 height
= (lcdTiming1
.lpp
) + 1;
274 DPRINTF(PL111
, "####### Upper panel base set to: %#x #######\n", lcdUpbase
);
277 warn_once("LCD dual screen mode not supported\n");
279 DPRINTF(PL111
, "###### Lower panel base set to: %#x #######\n", lcdLpbase
);
283 old_lcdpwr
= lcdControl
.lcdpwr
;
286 DPRINTF(PL111
, "LCD power is:%d\n", lcdControl
.lcdpwr
);
289 if (lcdControl
.lcdpwr
&& !old_lcdpwr
) {
291 DPRINTF(PL111
, " lcd size: height %d width %d\n", height
, width
);
292 waterMark
= lcdControl
.watermark
? 8 : 4;
299 panic("Interrupting on vcomp not supported\n");
301 lcdMis
= lcdImsc
& lcdRis
;
304 gic
->clearInt(intNum
);
308 panic("LCD register at offset %#x is Read-Only\n", daddr
);
311 panic("LCD register at offset %#x is Read-Only\n", daddr
);
314 lcdRis
= lcdRis
& ~data
;
315 lcdMis
= lcdImsc
& lcdRis
;
318 gic
->clearInt(intNum
);
322 panic("LCD register at offset %#x is Read-Only\n", daddr
);
325 panic("LCD register at offset %#x is Read-Only\n", daddr
);
331 clcdCrsrConfig
= data
;
333 case ClcdCrsrPalette0
:
334 clcdCrsrPalette0
= data
;
336 case ClcdCrsrPalette1
:
337 clcdCrsrPalette1
= data
;
352 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
355 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
358 if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
361 index
= (daddr
- CrsrImage
) >> 2;
362 cursorImage
[index
] = data
;
364 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
367 index
= (daddr
- LcdPalette
) >> 2;
368 lcdPalette
[index
] = data
;
371 panic("Tried to write PL111 register at offset %#x that "
372 "doesn't exist\n", daddr
);
377 pkt
->makeAtomicResponse();
382 Pl111::updateVideoParams()
384 if (lcdControl
.lcdbpp
== bpp24
) {
386 } else if (lcdControl
.lcdbpp
== bpp16m565
) {
391 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
392 vnc
->setFrameBufferParams(VideoConvert::bgr8888
, width
,
394 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
395 vnc
->setFrameBufferParams(VideoConvert::rgb8888
, width
,
397 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
398 vnc
->setFrameBufferParams(VideoConvert::bgr565
, width
,
400 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
401 vnc
->setFrameBufferParams(VideoConvert::rgb565
, width
,
404 panic("Unimplemented video mode\n");
410 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
411 bmp
= new Bitmap(VideoConvert::bgr8888
, width
, height
, dmaBuffer
);
412 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
413 bmp
= new Bitmap(VideoConvert::rgb8888
, width
, height
, dmaBuffer
);
414 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
415 bmp
= new Bitmap(VideoConvert::bgr565
, width
, height
, dmaBuffer
);
416 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
417 bmp
= new Bitmap(VideoConvert::rgb565
, width
, height
, dmaBuffer
);
419 panic("Unimplemented video mode\n");
425 if (dmaPendingNum
!= 0 || readEvent
.scheduled())
431 Pl111::readFramebuffer()
433 // initialization for dma read from frame buffer to dma buffer
434 uint32_t length
= height
* width
;
435 if (startAddr
!= lcdUpbase
)
436 startAddr
= lcdUpbase
;
438 // Updating base address, interrupt if we're supposed to
440 if (!intEvent
.scheduled())
441 schedule(intEvent
, clockEdge());
444 startTime
= curTick();
446 maxAddr
= static_cast<Addr
>(length
* bytesPerPixel
);
448 DPRINTF(PL111
, " lcd frame buffer size of %d bytes \n", maxAddr
);
456 while ((dmaPendingNum
< maxOutstandingDma
) && (maxAddr
>= curAddr
+ dmaSize
)) {
457 // concurrent dma reads need different dma done events
458 // due to assertion in scheduling state
461 assert(!dmaDoneEventFree
.empty());
462 DmaDoneEvent
*event(dmaDoneEventFree
.back());
463 dmaDoneEventFree
.pop_back();
464 assert(!event
->scheduled());
466 // We use a uncachable request here because the requests from the CPU
467 // will be uncacheable as well. If we have uncacheable and cacheable
468 // requests in the memory system for the same address it won't be
470 dmaPort
.dmaAction(MemCmd::ReadReq
, curAddr
+ startAddr
, dmaSize
,
471 event
, curAddr
+ dmaBuffer
,
472 0, Request::UNCACHEABLE
);
480 DPRINTF(PL111
, "DMA Done\n");
482 Tick maxFrameTime
= lcdTiming2
.cpl
* height
* pixelClock
;
486 if (maxAddr
== curAddr
&& !dmaPendingNum
) {
487 if ((curTick() - startTime
) > maxFrameTime
) {
488 warn("CLCD controller buffer underrun, took %d ticks when should"
489 " have taken %d\n", curTick() - startTime
, maxFrameTime
);
490 lcdRis
.underflow
= 1;
491 if (!intEvent
.scheduled())
492 schedule(intEvent
, clockEdge());
495 assert(!readEvent
.scheduled());
500 DPRINTF(PL111
, "-- write out frame buffer into bmp\n");
503 pic
= simout
.create(csprintf("%s.framebuffer.bmp", sys
->name()), true);
511 // schedule the next read based on when the last frame started
512 // and the desired fps (i.e. maxFrameTime), we turn the
513 // argument into a relative number of cycles in the future
514 if (lcdControl
.lcden
)
515 schedule(readEvent
, clockEdge(ticksToCycles(startTime
-
520 if (dmaPendingNum
> (maxOutstandingDma
- waterMark
))
523 if (!fillFifoEvent
.scheduled())
524 schedule(fillFifoEvent
, clockEdge());
528 Pl111::serialize(std::ostream
&os
)
530 DPRINTF(PL111
, "Serializing ARM PL111\n");
532 uint32_t lcdTiming0_serial
= lcdTiming0
;
533 SERIALIZE_SCALAR(lcdTiming0_serial
);
535 uint32_t lcdTiming1_serial
= lcdTiming1
;
536 SERIALIZE_SCALAR(lcdTiming1_serial
);
538 uint32_t lcdTiming2_serial
= lcdTiming2
;
539 SERIALIZE_SCALAR(lcdTiming2_serial
);
541 uint32_t lcdTiming3_serial
= lcdTiming3
;
542 SERIALIZE_SCALAR(lcdTiming3_serial
);
544 SERIALIZE_SCALAR(lcdUpbase
);
545 SERIALIZE_SCALAR(lcdLpbase
);
547 uint32_t lcdControl_serial
= lcdControl
;
548 SERIALIZE_SCALAR(lcdControl_serial
);
550 uint8_t lcdImsc_serial
= lcdImsc
;
551 SERIALIZE_SCALAR(lcdImsc_serial
);
553 uint8_t lcdRis_serial
= lcdRis
;
554 SERIALIZE_SCALAR(lcdRis_serial
);
556 uint8_t lcdMis_serial
= lcdMis
;
557 SERIALIZE_SCALAR(lcdMis_serial
);
559 SERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
560 SERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
562 SERIALIZE_SCALAR(clcdCrsrCtrl
);
563 SERIALIZE_SCALAR(clcdCrsrConfig
);
564 SERIALIZE_SCALAR(clcdCrsrPalette0
);
565 SERIALIZE_SCALAR(clcdCrsrPalette1
);
566 SERIALIZE_SCALAR(clcdCrsrXY
);
567 SERIALIZE_SCALAR(clcdCrsrClip
);
569 uint8_t clcdCrsrImsc_serial
= clcdCrsrImsc
;
570 SERIALIZE_SCALAR(clcdCrsrImsc_serial
);
572 uint8_t clcdCrsrIcr_serial
= clcdCrsrIcr
;
573 SERIALIZE_SCALAR(clcdCrsrIcr_serial
);
575 uint8_t clcdCrsrRis_serial
= clcdCrsrRis
;
576 SERIALIZE_SCALAR(clcdCrsrRis_serial
);
578 uint8_t clcdCrsrMis_serial
= clcdCrsrMis
;
579 SERIALIZE_SCALAR(clcdCrsrMis_serial
);
581 SERIALIZE_SCALAR(height
);
582 SERIALIZE_SCALAR(width
);
583 SERIALIZE_SCALAR(bytesPerPixel
);
585 SERIALIZE_ARRAY(dmaBuffer
, buffer_size
);
586 SERIALIZE_SCALAR(startTime
);
587 SERIALIZE_SCALAR(startAddr
);
588 SERIALIZE_SCALAR(maxAddr
);
589 SERIALIZE_SCALAR(curAddr
);
590 SERIALIZE_SCALAR(waterMark
);
591 SERIALIZE_SCALAR(dmaPendingNum
);
593 Tick int_event_time
= 0;
594 Tick read_event_time
= 0;
595 Tick fill_fifo_event_time
= 0;
597 if (readEvent
.scheduled())
598 read_event_time
= readEvent
.when();
599 if (fillFifoEvent
.scheduled())
600 fill_fifo_event_time
= fillFifoEvent
.when();
601 if (intEvent
.scheduled())
602 int_event_time
= intEvent
.when();
604 SERIALIZE_SCALAR(read_event_time
);
605 SERIALIZE_SCALAR(fill_fifo_event_time
);
606 SERIALIZE_SCALAR(int_event_time
);
608 vector
<Tick
> dma_done_event_tick
;
609 dma_done_event_tick
.resize(maxOutstandingDma
);
610 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
611 dma_done_event_tick
[x
] = dmaDoneEventAll
[x
].scheduled() ?
612 dmaDoneEventAll
[x
].when() : 0;
614 arrayParamOut(os
, "dma_done_event_tick", dma_done_event_tick
);
618 Pl111::unserialize(Checkpoint
*cp
, const std::string
§ion
)
620 DPRINTF(PL111
, "Unserializing ARM PL111\n");
622 uint32_t lcdTiming0_serial
;
623 UNSERIALIZE_SCALAR(lcdTiming0_serial
);
624 lcdTiming0
= lcdTiming0_serial
;
626 uint32_t lcdTiming1_serial
;
627 UNSERIALIZE_SCALAR(lcdTiming1_serial
);
628 lcdTiming1
= lcdTiming1_serial
;
630 uint32_t lcdTiming2_serial
;
631 UNSERIALIZE_SCALAR(lcdTiming2_serial
);
632 lcdTiming2
= lcdTiming2_serial
;
634 uint32_t lcdTiming3_serial
;
635 UNSERIALIZE_SCALAR(lcdTiming3_serial
);
636 lcdTiming3
= lcdTiming3_serial
;
638 UNSERIALIZE_SCALAR(lcdUpbase
);
639 UNSERIALIZE_SCALAR(lcdLpbase
);
641 uint32_t lcdControl_serial
;
642 UNSERIALIZE_SCALAR(lcdControl_serial
);
643 lcdControl
= lcdControl_serial
;
645 uint8_t lcdImsc_serial
;
646 UNSERIALIZE_SCALAR(lcdImsc_serial
);
647 lcdImsc
= lcdImsc_serial
;
649 uint8_t lcdRis_serial
;
650 UNSERIALIZE_SCALAR(lcdRis_serial
);
651 lcdRis
= lcdRis_serial
;
653 uint8_t lcdMis_serial
;
654 UNSERIALIZE_SCALAR(lcdMis_serial
);
655 lcdMis
= lcdMis_serial
;
657 UNSERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
658 UNSERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
660 UNSERIALIZE_SCALAR(clcdCrsrCtrl
);
661 UNSERIALIZE_SCALAR(clcdCrsrConfig
);
662 UNSERIALIZE_SCALAR(clcdCrsrPalette0
);
663 UNSERIALIZE_SCALAR(clcdCrsrPalette1
);
664 UNSERIALIZE_SCALAR(clcdCrsrXY
);
665 UNSERIALIZE_SCALAR(clcdCrsrClip
);
667 uint8_t clcdCrsrImsc_serial
;
668 UNSERIALIZE_SCALAR(clcdCrsrImsc_serial
);
669 clcdCrsrImsc
= clcdCrsrImsc_serial
;
671 uint8_t clcdCrsrIcr_serial
;
672 UNSERIALIZE_SCALAR(clcdCrsrIcr_serial
);
673 clcdCrsrIcr
= clcdCrsrIcr_serial
;
675 uint8_t clcdCrsrRis_serial
;
676 UNSERIALIZE_SCALAR(clcdCrsrRis_serial
);
677 clcdCrsrRis
= clcdCrsrRis_serial
;
679 uint8_t clcdCrsrMis_serial
;
680 UNSERIALIZE_SCALAR(clcdCrsrMis_serial
);
681 clcdCrsrMis
= clcdCrsrMis_serial
;
683 UNSERIALIZE_SCALAR(height
);
684 UNSERIALIZE_SCALAR(width
);
685 UNSERIALIZE_SCALAR(bytesPerPixel
);
687 UNSERIALIZE_ARRAY(dmaBuffer
, buffer_size
);
688 UNSERIALIZE_SCALAR(startTime
);
689 UNSERIALIZE_SCALAR(startAddr
);
690 UNSERIALIZE_SCALAR(maxAddr
);
691 UNSERIALIZE_SCALAR(curAddr
);
692 UNSERIALIZE_SCALAR(waterMark
);
693 UNSERIALIZE_SCALAR(dmaPendingNum
);
695 Tick int_event_time
= 0;
696 Tick read_event_time
= 0;
697 Tick fill_fifo_event_time
= 0;
699 UNSERIALIZE_SCALAR(read_event_time
);
700 UNSERIALIZE_SCALAR(fill_fifo_event_time
);
701 UNSERIALIZE_SCALAR(int_event_time
);
704 schedule(intEvent
, int_event_time
);
706 schedule(readEvent
, read_event_time
);
707 if (fill_fifo_event_time
)
708 schedule(fillFifoEvent
, fill_fifo_event_time
);
710 vector
<Tick
> dma_done_event_tick
;
711 dma_done_event_tick
.resize(maxOutstandingDma
);
712 arrayParamIn(cp
, section
, "dma_done_event_tick", dma_done_event_tick
);
713 dmaDoneEventFree
.clear();
714 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
715 if (dma_done_event_tick
[x
])
716 schedule(dmaDoneEventAll
[x
], dma_done_event_tick
[x
]);
718 dmaDoneEventFree
.push_back(&dmaDoneEventAll
[x
]);
720 assert(maxOutstandingDma
- dmaDoneEventFree
.size() == dmaPendingNum
);
722 if (lcdControl
.lcdpwr
) {
730 Pl111::generateInterrupt()
732 DPRINTF(PL111
, "Generate Interrupt: lcdImsc=0x%x lcdRis=0x%x lcdMis=0x%x\n",
733 (uint32_t)lcdImsc
, (uint32_t)lcdRis
, (uint32_t)lcdMis
);
734 lcdMis
= lcdImsc
& lcdRis
;
736 if (lcdMis
.underflow
|| lcdMis
.baseaddr
|| lcdMis
.vcomp
|| lcdMis
.ahbmaster
) {
737 gic
->sendInt(intNum
);
738 DPRINTF(PL111
, " -- Generated\n");
743 Pl111::getAddrRanges() const
745 AddrRangeList ranges
;
746 ranges
.push_back(RangeSize(pioAddr
, pioSize
));
751 Pl111Params::create()
753 return new Pl111(this);