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/vncserver.hh"
42 #include "base/bitmap.hh"
43 #include "base/output.hh"
44 #include "base/trace.hh"
45 #include "dev/arm/amba_device.hh"
46 #include "dev/arm/gic.hh"
47 #include "dev/arm/pl111.hh"
48 #include "mem/packet.hh"
49 #include "mem/packet_access.hh"
51 using namespace AmbaDev
;
53 // initialize clcd registers
54 Pl111::Pl111(const Params
*p
)
55 : AmbaDmaDevice(p
), lcdTiming0(0), lcdTiming1(0), lcdTiming2(0),
56 lcdTiming3(0), lcdUpbase(0), lcdLpbase(0), lcdControl(0), lcdImsc(0),
58 clcdCrsrCtrl(0), clcdCrsrConfig(0), clcdCrsrPalette0(0),
59 clcdCrsrPalette1(0), clcdCrsrXY(0), clcdCrsrClip(0), clcdCrsrImsc(0),
60 clcdCrsrIcr(0), clcdCrsrRis(0), clcdCrsrMis(0), clock(p
->clock
),
61 vncserver(p
->vnc
), bmp(NULL
), width(LcdMaxWidth
), height(LcdMaxHeight
),
62 bytesPerPixel(4), startTime(0), startAddr(0), maxAddr(0), curAddr(0),
63 waterMark(0), dmaPendingNum(0), readEvent(this), fillFifoEvent(this),
64 dmaDoneEvent(maxOutstandingDma
, this), intEvent(this)
68 pic
= simout
.create("framebuffer.bmp", true);
70 dmaBuffer
= new uint8_t[LcdMaxWidth
* LcdMaxHeight
* sizeof(uint32_t)];
72 memset(lcdPalette
, 0, sizeof(lcdPalette
));
73 memset(cursorImage
, 0, sizeof(cursorImage
));
74 memset(dmaBuffer
, 0, sizeof(dmaBuffer
));
77 vncserver
->setFramebufferAddr(dmaBuffer
);
80 // read registers and frame buffer
82 Pl111::read(PacketPtr pkt
)
84 // use a temporary data since the LCD registers are read/written with
85 // different size operations
89 assert(pkt
->getAddr() >= pioAddr
&&
90 pkt
->getAddr() < pioAddr
+ pioSize
);
92 Addr daddr
= pkt
->getAddr() - pioAddr
;
95 DPRINTF(PL111
, " read register %#x size=%d\n", daddr
, pkt
->getSize());
129 panic("LCD register at offset %#x is Write-Only\n", daddr
);
141 data
= clcdCrsrConfig
;
143 case ClcdCrsrPalette0
:
144 data
= clcdCrsrPalette0
;
146 case ClcdCrsrPalette1
:
147 data
= clcdCrsrPalette1
;
159 panic("CLCD register at offset %#x is Write-Only\n", daddr
);
168 if (AmbaDev::readId(pkt
, AMBA_ID
, pioAddr
)) {
169 // Hack for variable size accesses
170 data
= pkt
->get
<uint32_t>();
172 } else if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
175 index
= (daddr
- CrsrImage
) >> 2;
176 data
= cursorImage
[index
];
178 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
181 index
= (daddr
- LcdPalette
) >> 2;
182 data
= lcdPalette
[index
];
185 panic("Tried to read CLCD register at offset %#x that \
186 doesn't exist\n", daddr
);
191 switch(pkt
->getSize()) {
193 pkt
->set
<uint8_t>(data
);
196 pkt
->set
<uint16_t>(data
);
199 pkt
->set
<uint32_t>(data
);
202 panic("CLCD controller read size too big?\n");
206 pkt
->makeAtomicResponse();
210 // write registers and frame buffer
212 Pl111::write(PacketPtr pkt
)
214 // use a temporary data since the LCD registers are read/written with
215 // different size operations
219 switch(pkt
->getSize()) {
221 data
= pkt
->get
<uint8_t>();
224 data
= pkt
->get
<uint16_t>();
227 data
= pkt
->get
<uint32_t>();
230 panic("PL111 CLCD controller write size too big?\n");
234 assert(pkt
->getAddr() >= pioAddr
&&
235 pkt
->getAddr() < pioAddr
+ pioSize
);
237 Addr daddr
= pkt
->getAddr() - pioAddr
;
239 DPRINTF(PL111
, " write register %#x value %#x size=%d\n", daddr
,
240 pkt
->get
<uint8_t>(), pkt
->getSize());
245 // width = 16 * (PPL+1)
246 width
= (lcdTiming0
.ppl
+ 1) << 4;
251 height
= (lcdTiming1
.lpp
) + 1;
261 DPRINTF(PL111
, "####### Upper panel base set to: %#x #######\n", lcdUpbase
);
264 warn("LCD dual screen mode not supported\n");
266 DPRINTF(PL111
, "###### Lower panel base set to: %#x #######\n", lcdLpbase
);
270 old_lcdpwr
= lcdControl
.lcdpwr
;
273 DPRINTF(PL111
, "LCD power is:%d\n", lcdControl
.lcdpwr
);
276 if (lcdControl
.lcdpwr
&& !old_lcdpwr
) {
278 DPRINTF(PL111
, " lcd size: height %d width %d\n", height
, width
);
279 waterMark
= lcdControl
.watermark
? 8 : 4;
286 panic("Interrupting on vcomp not supported\n");
288 lcdMis
= lcdImsc
& lcdRis
;
291 gic
->clearInt(intNum
);
295 panic("LCD register at offset %#x is Read-Only\n", daddr
);
298 panic("LCD register at offset %#x is Read-Only\n", daddr
);
301 lcdRis
= lcdRis
& ~data
;
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
);
318 clcdCrsrConfig
= data
;
320 case ClcdCrsrPalette0
:
321 clcdCrsrPalette0
= data
;
323 case ClcdCrsrPalette1
:
324 clcdCrsrPalette1
= data
;
339 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
342 panic("CLCD register at offset %#x is Read-Only\n", daddr
);
345 if (daddr
>= CrsrImage
&& daddr
<= 0xBFC) {
348 index
= (daddr
- CrsrImage
) >> 2;
349 cursorImage
[index
] = data
;
351 } else if (daddr
>= LcdPalette
&& daddr
<= 0x3FC) {
354 index
= (daddr
- LcdPalette
) >> 2;
355 lcdPalette
[index
] = data
;
358 panic("Tried to write PL111 register at offset %#x that \
359 doesn't exist\n", daddr
);
364 pkt
->makeAtomicResponse();
369 Pl111::updateVideoParams()
371 if (lcdControl
.lcdbpp
== bpp24
) {
373 } else if (lcdControl
.lcdbpp
== bpp16m565
) {
378 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
379 vncserver
->setFrameBufferParams(VideoConvert::bgr8888
, width
,
381 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
382 vncserver
->setFrameBufferParams(VideoConvert::rgb8888
, width
,
384 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
385 vncserver
->setFrameBufferParams(VideoConvert::bgr565
, width
,
387 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
388 vncserver
->setFrameBufferParams(VideoConvert::rgb565
, width
,
391 panic("Unimplemented video mode\n");
397 if (lcdControl
.lcdbpp
== bpp24
&& lcdControl
.bgr
)
398 bmp
= new Bitmap(VideoConvert::bgr8888
, width
, height
, dmaBuffer
);
399 else if (lcdControl
.lcdbpp
== bpp24
&& !lcdControl
.bgr
)
400 bmp
= new Bitmap(VideoConvert::rgb8888
, width
, height
, dmaBuffer
);
401 else if (lcdControl
.lcdbpp
== bpp16m565
&& lcdControl
.bgr
)
402 bmp
= new Bitmap(VideoConvert::bgr565
, width
, height
, dmaBuffer
);
403 else if (lcdControl
.lcdbpp
== bpp16m565
&& !lcdControl
.bgr
)
404 bmp
= new Bitmap(VideoConvert::rgb565
, width
, height
, dmaBuffer
);
406 panic("Unimplemented video mode\n");
412 if (dmaPendingNum
!= 0 || readEvent
.scheduled())
418 Pl111::readFramebuffer()
420 // initialization for dma read from frame buffer to dma buffer
421 uint32_t length
= height
* width
;
422 if (startAddr
!= lcdUpbase
)
423 startAddr
= lcdUpbase
;
425 // Updating base address, interrupt if we're supposed to
427 if (!intEvent
.scheduled())
428 schedule(intEvent
, nextCycle());
431 startTime
= curTick();
433 maxAddr
= static_cast<Addr
>(length
* bytesPerPixel
);
435 DPRINTF(PL111
, " lcd frame buffer size of %d bytes \n", maxAddr
);
445 while ((dmaPendingNum
< maxOutstandingDma
) && (maxAddr
>= curAddr
+ dmaSize
)) {
446 // concurrent dma reads need different dma done events
447 // due to assertion in scheduling state
450 assert(!dmaDoneEvent
[dmaPendingNum
-1].scheduled());
452 // We use a uncachable request here because the requests from the CPU
453 // will be uncacheable as well. If we have uncacheable and cacheable
454 // requests in the memory system for the same address it won't be
456 dmaPort
->dmaAction(MemCmd::ReadReq
, curAddr
+ startAddr
, dmaSize
,
457 &dmaDoneEvent
[dmaPendingNum
-1], curAddr
+ dmaBuffer
, 0,
458 Request::UNCACHEABLE
);
466 Tick maxFrameTime
= lcdTiming2
.cpl
* height
* clock
;
470 if (maxAddr
== curAddr
&& !dmaPendingNum
) {
471 if ((curTick() - startTime
) > maxFrameTime
) {
472 warn("CLCD controller buffer underrun, took %d cycles when should"
473 " have taken %d\n", curTick() - startTime
, maxFrameTime
);
474 lcdRis
.underflow
= 1;
475 if (!intEvent
.scheduled())
476 schedule(intEvent
, nextCycle());
479 assert(!readEvent
.scheduled());
481 vncserver
->setDirty();
483 DPRINTF(PL111
, "-- write out frame buffer into bmp\n");
489 DPRINTF(PL111
, "-- schedule next dma read event at %d tick \n",
490 maxFrameTime
+ curTick());
492 if (lcdControl
.lcden
)
493 schedule(readEvent
, nextCycle(startTime
+ maxFrameTime
));
496 if (dmaPendingNum
> (maxOutstandingDma
- waterMark
))
499 if (!fillFifoEvent
.scheduled())
500 schedule(fillFifoEvent
, nextCycle());
507 Tick nextTick
= curTick() + clock
- 1;
508 nextTick
-= nextTick
%clock
;
513 Pl111::nextCycle(Tick beginTick
)
515 Tick nextTick
= beginTick
;
516 if (nextTick
%clock
!=0)
517 nextTick
= nextTick
- (nextTick
%clock
) + clock
;
519 assert(nextTick
>= curTick());
524 Pl111::serialize(std::ostream
&os
)
526 DPRINTF(PL111
, "Serializing ARM PL111\n");
528 uint32_t lcdTiming0_serial
= lcdTiming0
;
529 SERIALIZE_SCALAR(lcdTiming0_serial
);
531 uint32_t lcdTiming1_serial
= lcdTiming1
;
532 SERIALIZE_SCALAR(lcdTiming1_serial
);
534 uint32_t lcdTiming2_serial
= lcdTiming2
;
535 SERIALIZE_SCALAR(lcdTiming2_serial
);
537 uint32_t lcdTiming3_serial
= lcdTiming3
;
538 SERIALIZE_SCALAR(lcdTiming3_serial
);
540 SERIALIZE_SCALAR(lcdUpbase
);
541 SERIALIZE_SCALAR(lcdLpbase
);
543 uint32_t lcdControl_serial
= lcdControl
;
544 SERIALIZE_SCALAR(lcdControl_serial
);
546 uint8_t lcdImsc_serial
= lcdImsc
;
547 SERIALIZE_SCALAR(lcdImsc_serial
);
549 uint8_t lcdRis_serial
= lcdRis
;
550 SERIALIZE_SCALAR(lcdRis_serial
);
552 uint8_t lcdMis_serial
= lcdMis
;
553 SERIALIZE_SCALAR(lcdMis_serial
);
555 SERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
556 SERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
558 SERIALIZE_SCALAR(clcdCrsrCtrl
);
559 SERIALIZE_SCALAR(clcdCrsrConfig
);
560 SERIALIZE_SCALAR(clcdCrsrPalette0
);
561 SERIALIZE_SCALAR(clcdCrsrPalette1
);
562 SERIALIZE_SCALAR(clcdCrsrXY
);
563 SERIALIZE_SCALAR(clcdCrsrClip
);
565 uint8_t clcdCrsrImsc_serial
= clcdCrsrImsc
;
566 SERIALIZE_SCALAR(clcdCrsrImsc_serial
);
568 uint8_t clcdCrsrIcr_serial
= clcdCrsrIcr
;
569 SERIALIZE_SCALAR(clcdCrsrIcr_serial
);
571 uint8_t clcdCrsrRis_serial
= clcdCrsrRis
;
572 SERIALIZE_SCALAR(clcdCrsrRis_serial
);
574 uint8_t clcdCrsrMis_serial
= clcdCrsrMis
;
575 SERIALIZE_SCALAR(clcdCrsrMis_serial
);
577 SERIALIZE_SCALAR(clock
);
578 SERIALIZE_SCALAR(height
);
579 SERIALIZE_SCALAR(width
);
580 SERIALIZE_SCALAR(bytesPerPixel
);
582 SERIALIZE_ARRAY(dmaBuffer
, height
* width
);
583 SERIALIZE_SCALAR(startTime
);
584 SERIALIZE_SCALAR(startAddr
);
585 SERIALIZE_SCALAR(maxAddr
);
586 SERIALIZE_SCALAR(curAddr
);
587 SERIALIZE_SCALAR(waterMark
);
588 SERIALIZE_SCALAR(dmaPendingNum
);
590 Tick int_event_time
= 0;
591 Tick read_event_time
= 0;
592 Tick fill_fifo_event_time
= 0;
594 if (readEvent
.scheduled())
595 read_event_time
= readEvent
.when();
596 if (fillFifoEvent
.scheduled())
597 fill_fifo_event_time
= fillFifoEvent
.when();
598 if (intEvent
.scheduled())
599 int_event_time
= intEvent
.when();
601 SERIALIZE_SCALAR(read_event_time
);
602 SERIALIZE_SCALAR(fill_fifo_event_time
);
603 SERIALIZE_SCALAR(int_event_time
);
605 vector
<Tick
> dma_done_event_tick
;
606 dma_done_event_tick
.resize(maxOutstandingDma
);
607 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
608 dma_done_event_tick
[x
] = dmaDoneEvent
[x
].scheduled() ?
609 dmaDoneEvent
[x
].when() : 0;
611 arrayParamOut(os
, "dma_done_event_tick", dma_done_event_tick
);
615 Pl111::unserialize(Checkpoint
*cp
, const std::string
§ion
)
617 DPRINTF(PL111
, "Unserializing ARM PL111\n");
619 uint32_t lcdTiming0_serial
;
620 UNSERIALIZE_SCALAR(lcdTiming0_serial
);
621 lcdTiming0
= lcdTiming0_serial
;
623 uint32_t lcdTiming1_serial
;
624 UNSERIALIZE_SCALAR(lcdTiming1_serial
);
625 lcdTiming1
= lcdTiming1_serial
;
627 uint32_t lcdTiming2_serial
;
628 UNSERIALIZE_SCALAR(lcdTiming2_serial
);
629 lcdTiming2
= lcdTiming2_serial
;
631 uint32_t lcdTiming3_serial
;
632 UNSERIALIZE_SCALAR(lcdTiming3_serial
);
633 lcdTiming3
= lcdTiming3_serial
;
635 UNSERIALIZE_SCALAR(lcdUpbase
);
636 UNSERIALIZE_SCALAR(lcdLpbase
);
638 uint32_t lcdControl_serial
;
639 UNSERIALIZE_SCALAR(lcdControl_serial
);
640 lcdControl
= lcdControl_serial
;
642 uint8_t lcdImsc_serial
;
643 UNSERIALIZE_SCALAR(lcdImsc_serial
);
644 lcdImsc
= lcdImsc_serial
;
646 uint8_t lcdRis_serial
;
647 UNSERIALIZE_SCALAR(lcdRis_serial
);
648 lcdRis
= lcdRis_serial
;
650 uint8_t lcdMis_serial
;
651 UNSERIALIZE_SCALAR(lcdMis_serial
);
652 lcdMis
= lcdMis_serial
;
654 UNSERIALIZE_ARRAY(lcdPalette
, LcdPaletteSize
);
655 UNSERIALIZE_ARRAY(cursorImage
, CrsrImageSize
);
657 UNSERIALIZE_SCALAR(clcdCrsrCtrl
);
658 UNSERIALIZE_SCALAR(clcdCrsrConfig
);
659 UNSERIALIZE_SCALAR(clcdCrsrPalette0
);
660 UNSERIALIZE_SCALAR(clcdCrsrPalette1
);
661 UNSERIALIZE_SCALAR(clcdCrsrXY
);
662 UNSERIALIZE_SCALAR(clcdCrsrClip
);
664 uint8_t clcdCrsrImsc_serial
;
665 UNSERIALIZE_SCALAR(clcdCrsrImsc_serial
);
666 clcdCrsrImsc
= clcdCrsrImsc_serial
;
668 uint8_t clcdCrsrIcr_serial
;
669 UNSERIALIZE_SCALAR(clcdCrsrIcr_serial
);
670 clcdCrsrIcr
= clcdCrsrIcr_serial
;
672 uint8_t clcdCrsrRis_serial
;
673 UNSERIALIZE_SCALAR(clcdCrsrRis_serial
);
674 clcdCrsrRis
= clcdCrsrRis_serial
;
676 uint8_t clcdCrsrMis_serial
;
677 UNSERIALIZE_SCALAR(clcdCrsrMis_serial
);
678 clcdCrsrMis
= clcdCrsrMis_serial
;
680 UNSERIALIZE_SCALAR(clock
);
681 UNSERIALIZE_SCALAR(height
);
682 UNSERIALIZE_SCALAR(width
);
683 UNSERIALIZE_SCALAR(bytesPerPixel
);
685 UNSERIALIZE_ARRAY(dmaBuffer
, height
* width
);
686 UNSERIALIZE_SCALAR(startTime
);
687 UNSERIALIZE_SCALAR(startAddr
);
688 UNSERIALIZE_SCALAR(maxAddr
);
689 UNSERIALIZE_SCALAR(curAddr
);
690 UNSERIALIZE_SCALAR(waterMark
);
691 UNSERIALIZE_SCALAR(dmaPendingNum
);
693 Tick int_event_time
= 0;
694 Tick read_event_time
= 0;
695 Tick fill_fifo_event_time
= 0;
697 UNSERIALIZE_SCALAR(read_event_time
);
698 UNSERIALIZE_SCALAR(fill_fifo_event_time
);
699 UNSERIALIZE_SCALAR(int_event_time
);
702 schedule(intEvent
, int_event_time
);
704 schedule(readEvent
, read_event_time
);
705 if (fill_fifo_event_time
)
706 schedule(fillFifoEvent
, fill_fifo_event_time
);
708 vector
<Tick
> dma_done_event_tick
;
709 dma_done_event_tick
.resize(maxOutstandingDma
);
710 arrayParamIn(cp
, section
, "dma_done_event_tick", dma_done_event_tick
);
711 for (int x
= 0; x
< maxOutstandingDma
; x
++) {
712 if (dma_done_event_tick
[x
])
713 schedule(dmaDoneEvent
[x
], dma_done_event_tick
[x
]);
716 if (lcdControl
.lcdpwr
) {
719 vncserver
->setDirty();
724 Pl111::generateInterrupt()
726 DPRINTF(PL111
, "Generate Interrupt: lcdImsc=0x%x lcdRis=0x%x lcdMis=0x%x\n",
727 (uint32_t)lcdImsc
, (uint32_t)lcdRis
, (uint32_t)lcdMis
);
728 lcdMis
= lcdImsc
& lcdRis
;
730 if (lcdMis
.underflow
|| lcdMis
.baseaddr
|| lcdMis
.vcomp
|| lcdMis
.ahbmaster
) {
731 gic
->sendInt(intNum
);
732 DPRINTF(PL111
, " -- Generated\n");
737 Pl111::addressRanges(AddrRangeList
& range_list
)
740 range_list
.push_back(RangeSize(pioAddr
, pioSize
));
744 Pl111Params::create()
746 return new Pl111(this);