2 * Copyright (c) 2010 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/gic.hh"
49 #include "dev/arm/pl111.hh"
50 #include "mem/packet.hh"
51 #include "mem/packet_access.hh"
53 // clang complains about std::set being overloaded with Packet::set if
54 // we open up the entire namespace std
57 using namespace AmbaDev
;
59 // initialize clcd registers
60 Pl111::Pl111(const Params
*p
)
61 : AmbaDmaDevice(p
), lcdTiming0(0), lcdTiming1(0), lcdTiming2(0),
62 lcdTiming3(0), lcdUpbase(0), lcdLpbase(0), lcdControl(0), lcdImsc(0),
64 clcdCrsrCtrl(0), clcdCrsrConfig(0), clcdCrsrPalette0(0),
65 clcdCrsrPalette1(0), clcdCrsrXY(0), clcdCrsrClip(0), clcdCrsrImsc(0),
66 clcdCrsrIcr(0), clcdCrsrRis(0), clcdCrsrMis(0),
67 vnc(p
->vnc
), bmp(NULL
), 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 dmaDoneEvent(maxOutstandingDma
, this), intEvent(this)
74 pic
= simout
.create(csprintf("%s.framebuffer.bmp", sys
->name()), true);
76 const int buffer_size
= LcdMaxWidth
* LcdMaxHeight
* sizeof(uint32_t);
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
);
84 vnc
->setFramebufferAddr(dmaBuffer
);
92 // read registers and frame buffer
94 Pl111::read(PacketPtr pkt
)
96 // use a temporary data since the LCD registers are read/written with
97 // different size operations
101 assert(pkt
->getAddr() >= pioAddr
&&
102 pkt
->getAddr() < pioAddr
+ pioSize
);
104 Addr daddr
= pkt
->getAddr() - pioAddr
;
107 DPRINTF(PL111
, " read register %#x size=%d\n", daddr
, pkt
->getSize());
141 panic("LCD register at offset %#x is Write-Only\n", daddr
);
153 data
= clcdCrsrConfig
;
155 case ClcdCrsrPalette0
:
156 data
= clcdCrsrPalette0
;
158 case ClcdCrsrPalette1
:
159 data
= clcdCrsrPalette1
;
171 panic("CLCD register at offset %#x is Write-Only\n", daddr
);
180 if (AmbaDev::readId(pkt
, AMBA_ID
, pioAddr
)) {
181 // Hack for variable size accesses
182 data
= pkt
->get
<uint32_t>();
184 } else if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
187 index
= (daddr
- CrsrImage
) >> 2;
188 data
= cursorImage
[index
];
190 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
193 index
= (daddr
- LcdPalette
) >> 2;
194 data
= lcdPalette
[index
];
197 panic("Tried to read CLCD register at offset %#x that \
198 doesn't exist\n", daddr
);
203 switch(pkt
->getSize()) {
205 pkt
->set
<uint8_t>(data
);
208 pkt
->set
<uint16_t>(data
);
211 pkt
->set
<uint32_t>(data
);
214 panic("CLCD controller read size too big?\n");
218 pkt
->makeAtomicResponse();
222 // write registers and frame buffer
224 Pl111::write(PacketPtr pkt
)
226 // use a temporary data since the LCD registers are read/written with
227 // different size operations
231 switch(pkt
->getSize()) {
233 data
= pkt
->get
<uint8_t>();
236 data
= pkt
->get
<uint16_t>();
239 data
= pkt
->get
<uint32_t>();
242 panic("PL111 CLCD controller write size too big?\n");
246 assert(pkt
->getAddr() >= pioAddr
&&
247 pkt
->getAddr() < pioAddr
+ pioSize
);
249 Addr daddr
= pkt
->getAddr() - pioAddr
;
251 DPRINTF(PL111
, " write register %#x value %#x size=%d\n", daddr
,
252 pkt
->get
<uint8_t>(), pkt
->getSize());
257 // width = 16 * (PPL+1)
258 width
= (lcdTiming0
.ppl
+ 1) << 4;
263 height
= (lcdTiming1
.lpp
) + 1;
273 DPRINTF(PL111
, "####### Upper panel base set to: %#x #######\n", lcdUpbase
);
276 warn_once("LCD dual screen mode not supported\n");
278 DPRINTF(PL111
, "###### Lower panel base set to: %#x #######\n", lcdLpbase
);
282 old_lcdpwr
= lcdControl
.lcdpwr
;
285 DPRINTF(PL111
, "LCD power is:%d\n", lcdControl
.lcdpwr
);
288 if (lcdControl
.lcdpwr
&& !old_lcdpwr
) {
290 DPRINTF(PL111
, " lcd size: height %d width %d\n", height
, width
);
291 waterMark
= lcdControl
.watermark
? 8 : 4;
298 panic("Interrupting on vcomp not supported\n");
300 lcdMis
= lcdImsc
& lcdRis
;
303 gic
->clearInt(intNum
);
307 panic("LCD register at offset %#x is Read-Only\n", daddr
);
310 panic("LCD register at offset %#x is Read-Only\n", daddr
);
313 lcdRis
= lcdRis
& ~data
;
314 lcdMis
= lcdImsc
& lcdRis
;
317 gic
->clearInt(intNum
);
321 panic("LCD register at offset %#x is Read-Only\n", daddr
);
324 panic("LCD register at offset %#x is Read-Only\n", daddr
);
330 clcdCrsrConfig
= data
;
332 case ClcdCrsrPalette0
:
333 clcdCrsrPalette0
= data
;
335 case ClcdCrsrPalette1
:
336 clcdCrsrPalette1
= data
;
351 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
354 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
357 if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
360 index
= (daddr
- CrsrImage
) >> 2;
361 cursorImage
[index
] = data
;
363 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
366 index
= (daddr
- LcdPalette
) >> 2;
367 lcdPalette
[index
] = data
;
370 panic("Tried to write PL111 register at offset %#x that \
371 doesn't exist\n", daddr
);
376 pkt
->makeAtomicResponse();
381 Pl111::updateVideoParams()
383 if (lcdControl
.lcdbpp
== bpp24
) {
385 } else if (lcdControl
.lcdbpp
== bpp16m565
) {
390 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
391 vnc
->setFrameBufferParams(VideoConvert::bgr8888
, width
,
393 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
394 vnc
->setFrameBufferParams(VideoConvert::rgb8888
, width
,
396 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
397 vnc
->setFrameBufferParams(VideoConvert::bgr565
, width
,
399 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
400 vnc
->setFrameBufferParams(VideoConvert::rgb565
, width
,
403 panic("Unimplemented video mode\n");
409 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
410 bmp
= new Bitmap(VideoConvert::bgr8888
, width
, height
, dmaBuffer
);
411 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
412 bmp
= new Bitmap(VideoConvert::rgb8888
, width
, height
, dmaBuffer
);
413 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
414 bmp
= new Bitmap(VideoConvert::bgr565
, width
, height
, dmaBuffer
);
415 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
416 bmp
= new Bitmap(VideoConvert::rgb565
, width
, height
, dmaBuffer
);
418 panic("Unimplemented video mode\n");
424 if (dmaPendingNum
!= 0 || readEvent
.scheduled())
430 Pl111::readFramebuffer()
432 // initialization for dma read from frame buffer to dma buffer
433 uint32_t length
= height
* width
;
434 if (startAddr
!= lcdUpbase
)
435 startAddr
= lcdUpbase
;
437 // Updating base address, interrupt if we're supposed to
439 if (!intEvent
.scheduled())
440 schedule(intEvent
, nextCycle());
443 startTime
= curCycle();
445 maxAddr
= static_cast<Addr
>(length
* bytesPerPixel
);
447 DPRINTF(PL111
, " lcd frame buffer size of %d bytes \n", maxAddr
);
457 while ((dmaPendingNum
< maxOutstandingDma
) && (maxAddr
>= curAddr
+ dmaSize
)) {
458 // concurrent dma reads need different dma done events
459 // due to assertion in scheduling state
462 assert(!dmaDoneEvent
[dmaPendingNum
-1].scheduled());
464 // We use a uncachable request here because the requests from the CPU
465 // will be uncacheable as well. If we have uncacheable and cacheable
466 // requests in the memory system for the same address it won't be
468 dmaPort
.dmaAction(MemCmd::ReadReq
, curAddr
+ startAddr
, dmaSize
,
469 &dmaDoneEvent
[dmaPendingNum
-1], curAddr
+ dmaBuffer
,
470 0, Request::UNCACHEABLE
);
478 Cycles
maxFrameTime(lcdTiming2
.cpl
* height
);
482 if (maxAddr
== curAddr
&& !dmaPendingNum
) {
483 if ((curCycle() - startTime
) > maxFrameTime
) {
484 warn("CLCD controller buffer underrun, took %d cycles when should"
485 " have taken %d\n", curTick() - startTime
, maxFrameTime
);
486 lcdRis
.underflow
= 1;
487 if (!intEvent
.scheduled())
488 schedule(intEvent
, nextCycle());
491 assert(!readEvent
.scheduled());
495 DPRINTF(PL111
, "-- write out frame buffer into bmp\n");
501 // schedule the next read based on when the last frame started
502 // and the desired fps (i.e. maxFrameTime), we turn the
503 // argument into a relative number of cycles in the future by
504 // subtracting curCycle()
505 if (lcdControl
.lcden
)
506 // @todo: This is a terrible way of doing the time
507 // keeping, make it all relative
509 clockEdge(Cycles(startTime
- curCycle() +
513 if (dmaPendingNum
> (maxOutstandingDma
- waterMark
))
516 if (!fillFifoEvent
.scheduled())
517 schedule(fillFifoEvent
, nextCycle());
521 Pl111::serialize(std::ostream
&os
)
523 DPRINTF(PL111
, "Serializing ARM PL111\n");
525 uint32_t lcdTiming0_serial
= lcdTiming0
;
526 SERIALIZE_SCALAR(lcdTiming0_serial
);
528 uint32_t lcdTiming1_serial
= lcdTiming1
;
529 SERIALIZE_SCALAR(lcdTiming1_serial
);
531 uint32_t lcdTiming2_serial
= lcdTiming2
;
532 SERIALIZE_SCALAR(lcdTiming2_serial
);
534 uint32_t lcdTiming3_serial
= lcdTiming3
;
535 SERIALIZE_SCALAR(lcdTiming3_serial
);
537 SERIALIZE_SCALAR(lcdUpbase
);
538 SERIALIZE_SCALAR(lcdLpbase
);
540 uint32_t lcdControl_serial
= lcdControl
;
541 SERIALIZE_SCALAR(lcdControl_serial
);
543 uint8_t lcdImsc_serial
= lcdImsc
;
544 SERIALIZE_SCALAR(lcdImsc_serial
);
546 uint8_t lcdRis_serial
= lcdRis
;
547 SERIALIZE_SCALAR(lcdRis_serial
);
549 uint8_t lcdMis_serial
= lcdMis
;
550 SERIALIZE_SCALAR(lcdMis_serial
);
552 SERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
553 SERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
555 SERIALIZE_SCALAR(clcdCrsrCtrl
);
556 SERIALIZE_SCALAR(clcdCrsrConfig
);
557 SERIALIZE_SCALAR(clcdCrsrPalette0
);
558 SERIALIZE_SCALAR(clcdCrsrPalette1
);
559 SERIALIZE_SCALAR(clcdCrsrXY
);
560 SERIALIZE_SCALAR(clcdCrsrClip
);
562 uint8_t clcdCrsrImsc_serial
= clcdCrsrImsc
;
563 SERIALIZE_SCALAR(clcdCrsrImsc_serial
);
565 uint8_t clcdCrsrIcr_serial
= clcdCrsrIcr
;
566 SERIALIZE_SCALAR(clcdCrsrIcr_serial
);
568 uint8_t clcdCrsrRis_serial
= clcdCrsrRis
;
569 SERIALIZE_SCALAR(clcdCrsrRis_serial
);
571 uint8_t clcdCrsrMis_serial
= clcdCrsrMis
;
572 SERIALIZE_SCALAR(clcdCrsrMis_serial
);
574 SERIALIZE_SCALAR(height
);
575 SERIALIZE_SCALAR(width
);
576 SERIALIZE_SCALAR(bytesPerPixel
);
578 SERIALIZE_ARRAY(dmaBuffer
, height
* width
);
579 SERIALIZE_SCALAR(startTime
);
580 SERIALIZE_SCALAR(startAddr
);
581 SERIALIZE_SCALAR(maxAddr
);
582 SERIALIZE_SCALAR(curAddr
);
583 SERIALIZE_SCALAR(waterMark
);
584 SERIALIZE_SCALAR(dmaPendingNum
);
586 Tick int_event_time
= 0;
587 Tick read_event_time
= 0;
588 Tick fill_fifo_event_time
= 0;
590 if (readEvent
.scheduled())
591 read_event_time
= readEvent
.when();
592 if (fillFifoEvent
.scheduled())
593 fill_fifo_event_time
= fillFifoEvent
.when();
594 if (intEvent
.scheduled())
595 int_event_time
= intEvent
.when();
597 SERIALIZE_SCALAR(read_event_time
);
598 SERIALIZE_SCALAR(fill_fifo_event_time
);
599 SERIALIZE_SCALAR(int_event_time
);
601 vector
<Tick
> dma_done_event_tick
;
602 dma_done_event_tick
.resize(maxOutstandingDma
);
603 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
604 dma_done_event_tick
[x
] = dmaDoneEvent
[x
].scheduled() ?
605 dmaDoneEvent
[x
].when() : 0;
607 arrayParamOut(os
, "dma_done_event_tick", dma_done_event_tick
);
611 Pl111::unserialize(Checkpoint
*cp
, const std::string
§ion
)
613 DPRINTF(PL111
, "Unserializing ARM PL111\n");
615 uint32_t lcdTiming0_serial
;
616 UNSERIALIZE_SCALAR(lcdTiming0_serial
);
617 lcdTiming0
= lcdTiming0_serial
;
619 uint32_t lcdTiming1_serial
;
620 UNSERIALIZE_SCALAR(lcdTiming1_serial
);
621 lcdTiming1
= lcdTiming1_serial
;
623 uint32_t lcdTiming2_serial
;
624 UNSERIALIZE_SCALAR(lcdTiming2_serial
);
625 lcdTiming2
= lcdTiming2_serial
;
627 uint32_t lcdTiming3_serial
;
628 UNSERIALIZE_SCALAR(lcdTiming3_serial
);
629 lcdTiming3
= lcdTiming3_serial
;
631 UNSERIALIZE_SCALAR(lcdUpbase
);
632 UNSERIALIZE_SCALAR(lcdLpbase
);
634 uint32_t lcdControl_serial
;
635 UNSERIALIZE_SCALAR(lcdControl_serial
);
636 lcdControl
= lcdControl_serial
;
638 uint8_t lcdImsc_serial
;
639 UNSERIALIZE_SCALAR(lcdImsc_serial
);
640 lcdImsc
= lcdImsc_serial
;
642 uint8_t lcdRis_serial
;
643 UNSERIALIZE_SCALAR(lcdRis_serial
);
644 lcdRis
= lcdRis_serial
;
646 uint8_t lcdMis_serial
;
647 UNSERIALIZE_SCALAR(lcdMis_serial
);
648 lcdMis
= lcdMis_serial
;
650 UNSERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
651 UNSERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
653 UNSERIALIZE_SCALAR(clcdCrsrCtrl
);
654 UNSERIALIZE_SCALAR(clcdCrsrConfig
);
655 UNSERIALIZE_SCALAR(clcdCrsrPalette0
);
656 UNSERIALIZE_SCALAR(clcdCrsrPalette1
);
657 UNSERIALIZE_SCALAR(clcdCrsrXY
);
658 UNSERIALIZE_SCALAR(clcdCrsrClip
);
660 uint8_t clcdCrsrImsc_serial
;
661 UNSERIALIZE_SCALAR(clcdCrsrImsc_serial
);
662 clcdCrsrImsc
= clcdCrsrImsc_serial
;
664 uint8_t clcdCrsrIcr_serial
;
665 UNSERIALIZE_SCALAR(clcdCrsrIcr_serial
);
666 clcdCrsrIcr
= clcdCrsrIcr_serial
;
668 uint8_t clcdCrsrRis_serial
;
669 UNSERIALIZE_SCALAR(clcdCrsrRis_serial
);
670 clcdCrsrRis
= clcdCrsrRis_serial
;
672 uint8_t clcdCrsrMis_serial
;
673 UNSERIALIZE_SCALAR(clcdCrsrMis_serial
);
674 clcdCrsrMis
= clcdCrsrMis_serial
;
676 UNSERIALIZE_SCALAR(height
);
677 UNSERIALIZE_SCALAR(width
);
678 UNSERIALIZE_SCALAR(bytesPerPixel
);
680 UNSERIALIZE_ARRAY(dmaBuffer
, height
* width
);
681 UNSERIALIZE_SCALAR(startTime
);
682 UNSERIALIZE_SCALAR(startAddr
);
683 UNSERIALIZE_SCALAR(maxAddr
);
684 UNSERIALIZE_SCALAR(curAddr
);
685 UNSERIALIZE_SCALAR(waterMark
);
686 UNSERIALIZE_SCALAR(dmaPendingNum
);
688 Tick int_event_time
= 0;
689 Tick read_event_time
= 0;
690 Tick fill_fifo_event_time
= 0;
692 UNSERIALIZE_SCALAR(read_event_time
);
693 UNSERIALIZE_SCALAR(fill_fifo_event_time
);
694 UNSERIALIZE_SCALAR(int_event_time
);
697 schedule(intEvent
, int_event_time
);
699 schedule(readEvent
, read_event_time
);
700 if (fill_fifo_event_time
)
701 schedule(fillFifoEvent
, fill_fifo_event_time
);
703 vector
<Tick
> dma_done_event_tick
;
704 dma_done_event_tick
.resize(maxOutstandingDma
);
705 arrayParamIn(cp
, section
, "dma_done_event_tick", dma_done_event_tick
);
706 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
707 if (dma_done_event_tick
[x
])
708 schedule(dmaDoneEvent
[x
], dma_done_event_tick
[x
]);
711 if (lcdControl
.lcdpwr
) {
719 Pl111::generateInterrupt()
721 DPRINTF(PL111
, "Generate Interrupt: lcdImsc=0x%x lcdRis=0x%x lcdMis=0x%x\n",
722 (uint32_t)lcdImsc
, (uint32_t)lcdRis
, (uint32_t)lcdMis
);
723 lcdMis
= lcdImsc
& lcdRis
;
725 if (lcdMis
.underflow
|| lcdMis
.baseaddr
|| lcdMis
.vcomp
|| lcdMis
.ahbmaster
) {
726 gic
->sendInt(intNum
);
727 DPRINTF(PL111
, " -- Generated\n");
732 Pl111::getAddrRanges() const
734 AddrRangeList ranges
;
735 ranges
.push_back(RangeSize(pioAddr
, pioSize
));
740 Pl111Params::create()
742 return new Pl111(this);