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/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 pixelClock(p
->pixel_clock
),
68 vnc(p
->vnc
), bmp(NULL
), 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
),
77 pic
= simout
.create(csprintf("%s.framebuffer.bmp", sys
->name()), true);
79 const int buffer_size
= LcdMaxWidth
* LcdMaxHeight
* sizeof(uint32_t);
80 dmaBuffer
= new uint8_t[buffer_size
];
82 memset(lcdPalette
, 0, sizeof(lcdPalette
));
83 memset(cursorImage
, 0, sizeof(cursorImage
));
84 memset(dmaBuffer
, 0, buffer_size
);
86 for (int i
= 0; i
< maxOutstandingDma
; ++i
)
87 dmaDoneEventFree
[i
] = &dmaDoneEventAll
[i
];
90 vnc
->setFramebufferAddr(dmaBuffer
);
98 // read registers and frame buffer
100 Pl111::read(PacketPtr pkt
)
102 // use a temporary data since the LCD registers are read/written with
103 // different size operations
107 assert(pkt
->getAddr() >= pioAddr
&&
108 pkt
->getAddr() < pioAddr
+ pioSize
);
110 Addr daddr
= pkt
->getAddr() - pioAddr
;
113 DPRINTF(PL111
, " read register %#x size=%d\n", daddr
, pkt
->getSize());
147 panic("LCD register at offset %#x is Write-Only\n", daddr
);
159 data
= clcdCrsrConfig
;
161 case ClcdCrsrPalette0
:
162 data
= clcdCrsrPalette0
;
164 case ClcdCrsrPalette1
:
165 data
= clcdCrsrPalette1
;
177 panic("CLCD register at offset %#x is Write-Only\n", daddr
);
186 if (AmbaDev::readId(pkt
, AMBA_ID
, pioAddr
)) {
187 // Hack for variable size accesses
188 data
= pkt
->get
<uint32_t>();
190 } else if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
193 index
= (daddr
- CrsrImage
) >> 2;
194 data
= cursorImage
[index
];
196 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
199 index
= (daddr
- LcdPalette
) >> 2;
200 data
= lcdPalette
[index
];
203 panic("Tried to read CLCD register at offset %#x that \
204 doesn't exist\n", daddr
);
209 switch(pkt
->getSize()) {
211 pkt
->set
<uint8_t>(data
);
214 pkt
->set
<uint16_t>(data
);
217 pkt
->set
<uint32_t>(data
);
220 panic("CLCD controller read size too big?\n");
224 pkt
->makeAtomicResponse();
228 // write registers and frame buffer
230 Pl111::write(PacketPtr pkt
)
232 // use a temporary data since the LCD registers are read/written with
233 // different size operations
237 switch(pkt
->getSize()) {
239 data
= pkt
->get
<uint8_t>();
242 data
= pkt
->get
<uint16_t>();
245 data
= pkt
->get
<uint32_t>();
248 panic("PL111 CLCD controller write size too big?\n");
252 assert(pkt
->getAddr() >= pioAddr
&&
253 pkt
->getAddr() < pioAddr
+ pioSize
);
255 Addr daddr
= pkt
->getAddr() - pioAddr
;
257 DPRINTF(PL111
, " write register %#x value %#x size=%d\n", daddr
,
258 pkt
->get
<uint8_t>(), pkt
->getSize());
263 // width = 16 * (PPL+1)
264 width
= (lcdTiming0
.ppl
+ 1) << 4;
269 height
= (lcdTiming1
.lpp
) + 1;
279 DPRINTF(PL111
, "####### Upper panel base set to: %#x #######\n", lcdUpbase
);
282 warn_once("LCD dual screen mode not supported\n");
284 DPRINTF(PL111
, "###### Lower panel base set to: %#x #######\n", lcdLpbase
);
288 old_lcdpwr
= lcdControl
.lcdpwr
;
291 DPRINTF(PL111
, "LCD power is:%d\n", lcdControl
.lcdpwr
);
294 if (lcdControl
.lcdpwr
&& !old_lcdpwr
) {
296 DPRINTF(PL111
, " lcd size: height %d width %d\n", height
, width
);
297 waterMark
= lcdControl
.watermark
? 8 : 4;
304 panic("Interrupting on vcomp not supported\n");
306 lcdMis
= lcdImsc
& lcdRis
;
309 gic
->clearInt(intNum
);
313 panic("LCD register at offset %#x is Read-Only\n", daddr
);
316 panic("LCD register at offset %#x is Read-Only\n", daddr
);
319 lcdRis
= lcdRis
& ~data
;
320 lcdMis
= lcdImsc
& lcdRis
;
323 gic
->clearInt(intNum
);
327 panic("LCD register at offset %#x is Read-Only\n", daddr
);
330 panic("LCD register at offset %#x is Read-Only\n", daddr
);
336 clcdCrsrConfig
= data
;
338 case ClcdCrsrPalette0
:
339 clcdCrsrPalette0
= data
;
341 case ClcdCrsrPalette1
:
342 clcdCrsrPalette1
= data
;
357 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
360 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
363 if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
366 index
= (daddr
- CrsrImage
) >> 2;
367 cursorImage
[index
] = data
;
369 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
372 index
= (daddr
- LcdPalette
) >> 2;
373 lcdPalette
[index
] = data
;
376 panic("Tried to write PL111 register at offset %#x that \
377 doesn't exist\n", daddr
);
382 pkt
->makeAtomicResponse();
387 Pl111::updateVideoParams()
389 if (lcdControl
.lcdbpp
== bpp24
) {
391 } else if (lcdControl
.lcdbpp
== bpp16m565
) {
396 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
397 vnc
->setFrameBufferParams(VideoConvert::bgr8888
, width
,
399 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
400 vnc
->setFrameBufferParams(VideoConvert::rgb8888
, width
,
402 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
403 vnc
->setFrameBufferParams(VideoConvert::bgr565
, width
,
405 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
406 vnc
->setFrameBufferParams(VideoConvert::rgb565
, width
,
409 panic("Unimplemented video mode\n");
415 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
416 bmp
= new Bitmap(VideoConvert::bgr8888
, width
, height
, dmaBuffer
);
417 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
418 bmp
= new Bitmap(VideoConvert::rgb8888
, width
, height
, dmaBuffer
);
419 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
420 bmp
= new Bitmap(VideoConvert::bgr565
, width
, height
, dmaBuffer
);
421 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
422 bmp
= new Bitmap(VideoConvert::rgb565
, width
, height
, dmaBuffer
);
424 panic("Unimplemented video mode\n");
430 if (dmaPendingNum
!= 0 || readEvent
.scheduled())
436 Pl111::readFramebuffer()
438 // initialization for dma read from frame buffer to dma buffer
439 uint32_t length
= height
* width
;
440 if (startAddr
!= lcdUpbase
)
441 startAddr
= lcdUpbase
;
443 // Updating base address, interrupt if we're supposed to
445 if (!intEvent
.scheduled())
446 schedule(intEvent
, nextCycle());
449 startTime
= curTick();
451 maxAddr
= static_cast<Addr
>(length
* bytesPerPixel
);
453 DPRINTF(PL111
, " lcd frame buffer size of %d bytes \n", maxAddr
);
461 while ((dmaPendingNum
< maxOutstandingDma
) && (maxAddr
>= curAddr
+ dmaSize
)) {
462 // concurrent dma reads need different dma done events
463 // due to assertion in scheduling state
466 assert(!dmaDoneEventFree
.empty());
467 DmaDoneEvent
*event(dmaDoneEventFree
.back());
468 dmaDoneEventFree
.pop_back();
469 assert(!event
->scheduled());
471 // We use a uncachable request here because the requests from the CPU
472 // will be uncacheable as well. If we have uncacheable and cacheable
473 // requests in the memory system for the same address it won't be
475 dmaPort
.dmaAction(MemCmd::ReadReq
, curAddr
+ startAddr
, dmaSize
,
476 event
, curAddr
+ dmaBuffer
,
477 0, Request::UNCACHEABLE
);
485 DPRINTF(PL111
, "DMA Done\n");
487 Tick maxFrameTime
= lcdTiming2
.cpl
* height
* pixelClock
;
491 if (maxAddr
== curAddr
&& !dmaPendingNum
) {
492 if ((curTick() - startTime
) > maxFrameTime
) {
493 warn("CLCD controller buffer underrun, took %d ticks when should"
494 " have taken %d\n", curTick() - startTime
, maxFrameTime
);
495 lcdRis
.underflow
= 1;
496 if (!intEvent
.scheduled())
497 schedule(intEvent
, nextCycle());
500 assert(!readEvent
.scheduled());
504 DPRINTF(PL111
, "-- write out frame buffer into bmp\n");
510 // schedule the next read based on when the last frame started
511 // and the desired fps (i.e. maxFrameTime), we turn the
512 // argument into a relative number of cycles in the future
513 if (lcdControl
.lcden
)
514 schedule(readEvent
, clockEdge(ticksToCycles(startTime
-
519 if (dmaPendingNum
> (maxOutstandingDma
- waterMark
))
522 if (!fillFifoEvent
.scheduled())
523 schedule(fillFifoEvent
, nextCycle());
527 Pl111::serialize(std::ostream
&os
)
529 DPRINTF(PL111
, "Serializing ARM PL111\n");
531 uint32_t lcdTiming0_serial
= lcdTiming0
;
532 SERIALIZE_SCALAR(lcdTiming0_serial
);
534 uint32_t lcdTiming1_serial
= lcdTiming1
;
535 SERIALIZE_SCALAR(lcdTiming1_serial
);
537 uint32_t lcdTiming2_serial
= lcdTiming2
;
538 SERIALIZE_SCALAR(lcdTiming2_serial
);
540 uint32_t lcdTiming3_serial
= lcdTiming3
;
541 SERIALIZE_SCALAR(lcdTiming3_serial
);
543 SERIALIZE_SCALAR(lcdUpbase
);
544 SERIALIZE_SCALAR(lcdLpbase
);
546 uint32_t lcdControl_serial
= lcdControl
;
547 SERIALIZE_SCALAR(lcdControl_serial
);
549 uint8_t lcdImsc_serial
= lcdImsc
;
550 SERIALIZE_SCALAR(lcdImsc_serial
);
552 uint8_t lcdRis_serial
= lcdRis
;
553 SERIALIZE_SCALAR(lcdRis_serial
);
555 uint8_t lcdMis_serial
= lcdMis
;
556 SERIALIZE_SCALAR(lcdMis_serial
);
558 SERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
559 SERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
561 SERIALIZE_SCALAR(clcdCrsrCtrl
);
562 SERIALIZE_SCALAR(clcdCrsrConfig
);
563 SERIALIZE_SCALAR(clcdCrsrPalette0
);
564 SERIALIZE_SCALAR(clcdCrsrPalette1
);
565 SERIALIZE_SCALAR(clcdCrsrXY
);
566 SERIALIZE_SCALAR(clcdCrsrClip
);
568 uint8_t clcdCrsrImsc_serial
= clcdCrsrImsc
;
569 SERIALIZE_SCALAR(clcdCrsrImsc_serial
);
571 uint8_t clcdCrsrIcr_serial
= clcdCrsrIcr
;
572 SERIALIZE_SCALAR(clcdCrsrIcr_serial
);
574 uint8_t clcdCrsrRis_serial
= clcdCrsrRis
;
575 SERIALIZE_SCALAR(clcdCrsrRis_serial
);
577 uint8_t clcdCrsrMis_serial
= clcdCrsrMis
;
578 SERIALIZE_SCALAR(clcdCrsrMis_serial
);
580 SERIALIZE_SCALAR(height
);
581 SERIALIZE_SCALAR(width
);
582 SERIALIZE_SCALAR(bytesPerPixel
);
584 SERIALIZE_ARRAY(dmaBuffer
, height
* width
);
585 SERIALIZE_SCALAR(startTime
);
586 SERIALIZE_SCALAR(startAddr
);
587 SERIALIZE_SCALAR(maxAddr
);
588 SERIALIZE_SCALAR(curAddr
);
589 SERIALIZE_SCALAR(waterMark
);
590 SERIALIZE_SCALAR(dmaPendingNum
);
592 Tick int_event_time
= 0;
593 Tick read_event_time
= 0;
594 Tick fill_fifo_event_time
= 0;
596 if (readEvent
.scheduled())
597 read_event_time
= readEvent
.when();
598 if (fillFifoEvent
.scheduled())
599 fill_fifo_event_time
= fillFifoEvent
.when();
600 if (intEvent
.scheduled())
601 int_event_time
= intEvent
.when();
603 SERIALIZE_SCALAR(read_event_time
);
604 SERIALIZE_SCALAR(fill_fifo_event_time
);
605 SERIALIZE_SCALAR(int_event_time
);
607 vector
<Tick
> dma_done_event_tick
;
608 dma_done_event_tick
.resize(maxOutstandingDma
);
609 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
610 dma_done_event_tick
[x
] = dmaDoneEventAll
[x
].scheduled() ?
611 dmaDoneEventAll
[x
].when() : 0;
613 arrayParamOut(os
, "dma_done_event_tick", dma_done_event_tick
);
617 Pl111::unserialize(Checkpoint
*cp
, const std::string
§ion
)
619 DPRINTF(PL111
, "Unserializing ARM PL111\n");
621 uint32_t lcdTiming0_serial
;
622 UNSERIALIZE_SCALAR(lcdTiming0_serial
);
623 lcdTiming0
= lcdTiming0_serial
;
625 uint32_t lcdTiming1_serial
;
626 UNSERIALIZE_SCALAR(lcdTiming1_serial
);
627 lcdTiming1
= lcdTiming1_serial
;
629 uint32_t lcdTiming2_serial
;
630 UNSERIALIZE_SCALAR(lcdTiming2_serial
);
631 lcdTiming2
= lcdTiming2_serial
;
633 uint32_t lcdTiming3_serial
;
634 UNSERIALIZE_SCALAR(lcdTiming3_serial
);
635 lcdTiming3
= lcdTiming3_serial
;
637 UNSERIALIZE_SCALAR(lcdUpbase
);
638 UNSERIALIZE_SCALAR(lcdLpbase
);
640 uint32_t lcdControl_serial
;
641 UNSERIALIZE_SCALAR(lcdControl_serial
);
642 lcdControl
= lcdControl_serial
;
644 uint8_t lcdImsc_serial
;
645 UNSERIALIZE_SCALAR(lcdImsc_serial
);
646 lcdImsc
= lcdImsc_serial
;
648 uint8_t lcdRis_serial
;
649 UNSERIALIZE_SCALAR(lcdRis_serial
);
650 lcdRis
= lcdRis_serial
;
652 uint8_t lcdMis_serial
;
653 UNSERIALIZE_SCALAR(lcdMis_serial
);
654 lcdMis
= lcdMis_serial
;
656 UNSERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
657 UNSERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
659 UNSERIALIZE_SCALAR(clcdCrsrCtrl
);
660 UNSERIALIZE_SCALAR(clcdCrsrConfig
);
661 UNSERIALIZE_SCALAR(clcdCrsrPalette0
);
662 UNSERIALIZE_SCALAR(clcdCrsrPalette1
);
663 UNSERIALIZE_SCALAR(clcdCrsrXY
);
664 UNSERIALIZE_SCALAR(clcdCrsrClip
);
666 uint8_t clcdCrsrImsc_serial
;
667 UNSERIALIZE_SCALAR(clcdCrsrImsc_serial
);
668 clcdCrsrImsc
= clcdCrsrImsc_serial
;
670 uint8_t clcdCrsrIcr_serial
;
671 UNSERIALIZE_SCALAR(clcdCrsrIcr_serial
);
672 clcdCrsrIcr
= clcdCrsrIcr_serial
;
674 uint8_t clcdCrsrRis_serial
;
675 UNSERIALIZE_SCALAR(clcdCrsrRis_serial
);
676 clcdCrsrRis
= clcdCrsrRis_serial
;
678 uint8_t clcdCrsrMis_serial
;
679 UNSERIALIZE_SCALAR(clcdCrsrMis_serial
);
680 clcdCrsrMis
= clcdCrsrMis_serial
;
682 UNSERIALIZE_SCALAR(height
);
683 UNSERIALIZE_SCALAR(width
);
684 UNSERIALIZE_SCALAR(bytesPerPixel
);
686 UNSERIALIZE_ARRAY(dmaBuffer
, height
* width
);
687 UNSERIALIZE_SCALAR(startTime
);
688 UNSERIALIZE_SCALAR(startAddr
);
689 UNSERIALIZE_SCALAR(maxAddr
);
690 UNSERIALIZE_SCALAR(curAddr
);
691 UNSERIALIZE_SCALAR(waterMark
);
692 UNSERIALIZE_SCALAR(dmaPendingNum
);
694 Tick int_event_time
= 0;
695 Tick read_event_time
= 0;
696 Tick fill_fifo_event_time
= 0;
698 UNSERIALIZE_SCALAR(read_event_time
);
699 UNSERIALIZE_SCALAR(fill_fifo_event_time
);
700 UNSERIALIZE_SCALAR(int_event_time
);
703 schedule(intEvent
, int_event_time
);
705 schedule(readEvent
, read_event_time
);
706 if (fill_fifo_event_time
)
707 schedule(fillFifoEvent
, fill_fifo_event_time
);
709 vector
<Tick
> dma_done_event_tick
;
710 dma_done_event_tick
.resize(maxOutstandingDma
);
711 arrayParamIn(cp
, section
, "dma_done_event_tick", dma_done_event_tick
);
712 dmaDoneEventFree
.clear();
713 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
714 if (dma_done_event_tick
[x
])
715 schedule(dmaDoneEventAll
[x
], dma_done_event_tick
[x
]);
717 dmaDoneEventFree
.push_back(&dmaDoneEventAll
[x
]);
719 assert(maxOutstandingDma
- dmaDoneEventFree
.size() == dmaPendingNum
);
721 if (lcdControl
.lcdpwr
) {
729 Pl111::generateInterrupt()
731 DPRINTF(PL111
, "Generate Interrupt: lcdImsc=0x%x lcdRis=0x%x lcdMis=0x%x\n",
732 (uint32_t)lcdImsc
, (uint32_t)lcdRis
, (uint32_t)lcdMis
);
733 lcdMis
= lcdImsc
& lcdRis
;
735 if (lcdMis
.underflow
|| lcdMis
.baseaddr
|| lcdMis
.vcomp
|| lcdMis
.ahbmaster
) {
736 gic
->sendInt(intNum
);
737 DPRINTF(PL111
, " -- Generated\n");
742 Pl111::getAddrRanges() const
744 AddrRangeList ranges
;
745 ranges
.push_back(RangeSize(pioAddr
, pioSize
));
750 Pl111Params::create()
752 return new Pl111(this);