2 * Copyright (c) 2010-2013, 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: Chris Emmons
41 #include "dev/arm/hdlcd.hh"
43 #include "base/vnc/vncinput.hh"
44 #include "base/output.hh"
45 #include "base/trace.hh"
46 #include "debug/Checkpoint.hh"
47 #include "debug/HDLcd.hh"
48 #include "dev/arm/amba_device.hh"
49 #include "dev/arm/base_gic.hh"
50 #include "mem/packet.hh"
51 #include "mem/packet_access.hh"
52 #include "params/HDLcd.hh"
53 #include "sim/system.hh"
58 // initialize hdlcd registers
59 HDLcd::HDLcd(const HDLcdParams
*p
)
60 : AmbaDmaDevice(p
, 0xFFFF),
63 workaroundSwapRB(p
->workaround_swap_rb
),
64 workaroundDmaLineCount(p
->workaround_dma_line_count
),
65 addrRanges
{RangeSize(pioAddr
, pioSize
)},
66 enableCapture(p
->enable_capture
),
67 pixelBufferSize(p
->pixel_buffer_size
),
70 version(VERSION_RESETV
),
71 int_rawstat(0), int_mask(0),
73 fb_base(0), fb_line_length(0), fb_line_count(0), fb_line_pitch(0),
74 bus_options(BUS_OPTIONS_RESETV
),
76 v_sync(0), v_back_porch(0), v_data(0), v_front_porch(0),
77 h_sync(0), h_back_porch(0), h_data(0), h_front_porch(0),
83 red_select(0), green_select(0), blue_select(0),
86 bmp(&pixelPump
.fb
), pic(NULL
), conv(PixelConverter::rgba8888_le
),
87 pixelPump(*this, *p
->pxl_clk
, p
->pixel_chunk
)
90 vnc
->setFrameBuffer(&pixelPump
.fb
);
100 using namespace Stats
;
103 .name(name() + ".underruns")
104 .desc("number of buffer underruns")
110 HDLcd::serialize(CheckpointOut
&cp
) const
112 DPRINTF(Checkpoint
, "Serializing ARM HDLCD\n");
114 SERIALIZE_SCALAR(int_rawstat
);
115 SERIALIZE_SCALAR(int_mask
);
117 SERIALIZE_SCALAR(fb_base
);
118 SERIALIZE_SCALAR(fb_line_length
);
119 SERIALIZE_SCALAR(fb_line_count
);
120 SERIALIZE_SCALAR(fb_line_pitch
);
121 SERIALIZE_SCALAR(bus_options
);
123 SERIALIZE_SCALAR(v_sync
);
124 SERIALIZE_SCALAR(v_back_porch
);
125 SERIALIZE_SCALAR(v_data
);
126 SERIALIZE_SCALAR(v_front_porch
);
128 SERIALIZE_SCALAR(h_sync
);
129 SERIALIZE_SCALAR(h_back_porch
);
130 SERIALIZE_SCALAR(h_data
);
131 SERIALIZE_SCALAR(h_front_porch
);
133 SERIALIZE_SCALAR(polarities
);
135 SERIALIZE_SCALAR(command
);
136 SERIALIZE_SCALAR(pixel_format
);
137 SERIALIZE_SCALAR(red_select
);
138 SERIALIZE_SCALAR(green_select
);
139 SERIALIZE_SCALAR(blue_select
);
141 SERIALIZE_OBJ(pixelPump
);
143 dmaEngine
->serializeSection(cp
, "dmaEngine");
147 HDLcd::unserialize(CheckpointIn
&cp
)
149 DPRINTF(Checkpoint
, "Unserializing ARM HDLCD\n");
151 UNSERIALIZE_SCALAR(int_rawstat
);
152 UNSERIALIZE_SCALAR(int_mask
);
154 UNSERIALIZE_SCALAR(fb_base
);
155 UNSERIALIZE_SCALAR(fb_line_length
);
156 UNSERIALIZE_SCALAR(fb_line_count
);
157 UNSERIALIZE_SCALAR(fb_line_pitch
);
158 UNSERIALIZE_SCALAR(bus_options
);
160 UNSERIALIZE_SCALAR(v_sync
);
161 UNSERIALIZE_SCALAR(v_back_porch
);
162 UNSERIALIZE_SCALAR(v_data
);
163 UNSERIALIZE_SCALAR(v_front_porch
);
165 UNSERIALIZE_SCALAR(h_sync
);
166 UNSERIALIZE_SCALAR(h_back_porch
);
167 UNSERIALIZE_SCALAR(h_data
);
168 UNSERIALIZE_SCALAR(h_front_porch
);
170 UNSERIALIZE_SCALAR(polarities
);
172 UNSERIALIZE_SCALAR(command
);
173 UNSERIALIZE_SCALAR(pixel_format
);
174 UNSERIALIZE_SCALAR(red_select
);
175 UNSERIALIZE_SCALAR(green_select
);
176 UNSERIALIZE_SCALAR(blue_select
);
179 // Try to unserialize the pixel pump. It might not exist if
180 // we're unserializing an old checkpoint.
181 ScopedCheckpointSection
sec(cp
, "pixelPump");
182 if (cp
.sectionExists(Serializable::currentSection()))
183 pixelPump
.unserialize(cp
);
187 // Create the DMA engine and read its state from the
188 // checkpoint. We don't need to worry about the pixel pump as
189 // it is a proper SimObject.
191 dmaEngine
->unserializeSection(cp
, "dmaEngine");
193 conv
= pixelConverter();
200 AmbaDmaDevice::drainResume();
202 // We restored from an old checkpoint without a pixel pump, start
203 // an new refresh. This typically happens when restoring from old
205 if (enabled() && !pixelPump
.active())
206 pixelPump
.start(displayTimings());
208 // We restored from a checkpoint and need to update the VNC server
209 if (pixelPump
.active() && vnc
)
213 // read registers and frame buffer
215 HDLcd::read(PacketPtr pkt
)
217 assert(pkt
->getAddr() >= pioAddr
&&
218 pkt
->getAddr() < pioAddr
+ pioSize
);
220 const Addr
daddr(pkt
->getAddr() - pioAddr
);
221 panic_if(pkt
->getSize() != 4,
222 "Unhandled read size (address: 0x.4x, size: %u)",
223 daddr
, pkt
->getSize());
225 const uint32_t data(readReg(daddr
));
226 DPRINTF(HDLcd
, "read register 0x%04x: 0x%x\n", daddr
, data
);
228 pkt
->set
<uint32_t>(data
);
229 pkt
->makeAtomicResponse();
233 // write registers and frame buffer
235 HDLcd::write(PacketPtr pkt
)
237 assert(pkt
->getAddr() >= pioAddr
&&
238 pkt
->getAddr() < pioAddr
+ pioSize
);
240 const Addr
daddr(pkt
->getAddr() - pioAddr
);
241 panic_if(pkt
->getSize() != 4,
242 "Unhandled read size (address: 0x.4x, size: %u)",
243 daddr
, pkt
->getSize());
244 const uint32_t data(pkt
->get
<uint32_t>());
245 DPRINTF(HDLcd
, "write register 0x%04x: 0x%x\n", daddr
, data
);
247 writeReg(daddr
, data
);
249 pkt
->makeAtomicResponse();
254 HDLcd::readReg(Addr offset
)
257 case Version
: return version
;
259 case Int_RawStat
: return int_rawstat
;
261 panic("HDLCD INT_CLEAR register is Write-Only\n");
262 case Int_Mask
: return int_mask
;
263 case Int_Status
: return intStatus();
265 case Fb_Base
: return fb_base
;
266 case Fb_Line_Length
: return fb_line_length
;
267 case Fb_Line_Count
: return fb_line_count
;
268 case Fb_Line_Pitch
: return fb_line_pitch
;
269 case Bus_Options
: return bus_options
;
271 case V_Sync
: return v_sync
;
272 case V_Back_Porch
: return v_back_porch
;
273 case V_Data
: return v_data
;
274 case V_Front_Porch
: return v_front_porch
;
275 case H_Sync
: return h_sync
;
276 case H_Back_Porch
: return h_back_porch
;
277 case H_Data
: return h_data
;
278 case H_Front_Porch
: return h_front_porch
;
279 case Polarities
: return polarities
;
281 case Command
: return command
;
282 case Pixel_Format
: return pixel_format
;
283 case Red_Select
: return red_select
;
284 case Green_Select
: return green_select
;
285 case Blue_Select
: return blue_select
;
288 panic("Tried to read HDLCD register that doesn't exist\n", offset
);
293 HDLcd::writeReg(Addr offset
, uint32_t value
)
297 panic("HDLCD VERSION register is read-Only\n");
309 panic("HDLCD INT_STATUS register is read-Only\n");
317 fb_line_length
= value
;
321 fb_line_count
= value
;
325 fb_line_pitch
= value
;
329 const BusOptsReg
old_bus_options(bus_options
);
332 if (bus_options
.max_outstanding
!= old_bus_options
.max_outstanding
) {
334 "Changing HDLcd outstanding DMA transactions: %d -> %d\n",
335 old_bus_options
.max_outstanding
,
336 bus_options
.max_outstanding
);
340 if (bus_options
.burst_len
!= old_bus_options
.burst_len
) {
342 "Changing HDLcd DMA burst flags: 0x%x -> 0x%x\n",
343 old_bus_options
.burst_len
, bus_options
.burst_len
);
351 v_back_porch
= value
;
357 v_front_porch
= value
;
364 h_back_porch
= value
;
370 h_front_porch
= value
;
378 const CommandReg
new_command(value
);
380 if (new_command
.enable
!= command
.enable
) {
381 DPRINTF(HDLcd
, "HDLCD switched %s\n",
382 new_command
.enable
? "on" : "off");
384 if (new_command
.enable
) {
390 command
= new_command
;
394 pixel_format
= value
;
401 green_select
= value
;
408 panic("Tried to write HDLCD register that doesn't exist\n", offset
);
414 HDLcd::pixelConverter() const
416 ByteOrder
byte_order(
417 pixel_format
.big_endian
? BigEndianByteOrder
: LittleEndianByteOrder
);
419 /* Some Linux kernels have a broken driver that swaps the red and
420 * blue color select registers. */
421 if (!workaroundSwapRB
) {
422 return PixelConverter(
423 pixel_format
.bytes_per_pixel
+ 1,
424 red_select
.offset
, green_select
.offset
, blue_select
.offset
,
425 red_select
.size
, green_select
.size
, blue_select
.size
,
428 return PixelConverter(
429 pixel_format
.bytes_per_pixel
+ 1,
430 blue_select
.offset
, green_select
.offset
, red_select
.offset
,
431 blue_select
.size
, green_select
.size
, red_select
.size
,
437 HDLcd::displayTimings() const
439 return DisplayTimings(
440 h_data
.val
+ 1, v_data
.val
+ 1,
441 h_back_porch
.val
+ 1, h_sync
.val
+ 1, h_front_porch
.val
+ 1,
442 v_back_porch
.val
+ 1, v_sync
.val
+ 1, v_front_porch
.val
+ 1);
446 HDLcd::createDmaEngine()
448 if (bus_options
.max_outstanding
== 0) {
449 warn("Maximum number of outstanding DMA transfers set to 0.");
453 const uint32_t dma_burst_flags(bus_options
.burst_len
);
454 const uint32_t dma_burst_len(
456 (1UL << (findMsbSet(dma_burst_flags
) - 1)) :
458 // Some drivers seem to set the DMA line count incorrectly. This
459 // could either be a driver bug or a specification bug. Unlike for
460 // timings, the specification does not require 1 to be added to
461 // the DMA engine's line count.
462 const uint32_t dma_lines(
463 fb_line_count
+ (workaroundDmaLineCount
? 1 : 0));
465 dmaEngine
.reset(new DmaEngine(
466 *this, pixelBufferSize
,
467 AXI_PORT_WIDTH
* dma_burst_len
,
468 bus_options
.max_outstanding
,
469 fb_line_length
, fb_line_pitch
, dma_lines
));
476 conv
= pixelConverter();
477 pixelPump
.start(displayTimings());
484 dmaEngine
->abortFrame();
488 HDLcd::pxlNext(Pixel
&p
)
490 uint8_t pixel_data
[MAX_PIXEL_SIZE
];
491 assert(conv
.length
<= sizeof(pixel_data
));
492 if (dmaEngine
->tryGet(pixel_data
, conv
.length
)) {
493 p
= conv
.toPixel(pixel_data
);
501 HDLcd::pxlVSyncBegin()
503 DPRINTF(HDLcd
, "Raising VSYNC interrupt.\n");
510 DPRINTF(HDLcd
, "End of VSYNC, starting DMA engine\n");
511 dmaEngine
->startFrame(fb_base
);
517 DPRINTF(HDLcd
, "Buffer underrun, stopping DMA fill.\n");
519 intRaise(INT_UNDERRUN
);
520 dmaEngine
->abortFrame();
524 HDLcd::pxlFrameDone()
526 DPRINTF(HDLcd
, "Reached end of last visible line.\n");
528 if (dmaEngine
->size()) {
529 warn("HDLCD %u bytes still in FIFO after frame: Ensure that DMA "
530 "and PixelPump configuration is consistent\n",
532 dmaEngine
->dumpSettings();
533 pixelPump
.dumpSettings();
542 csprintf("%s.framebuffer.bmp", sys
->name()),
553 HDLcd::setInterrupts(uint32_t ints
, uint32_t mask
)
555 const bool old_ints(intStatus());
560 if (!old_ints
&& intStatus()) {
561 gic
->sendInt(intNum
);
562 } else if (old_ints
&& !intStatus()) {
563 gic
->clearInt(intNum
);
567 HDLcd::DmaEngine::DmaEngine(HDLcd
&_parent
, size_t size
,
568 unsigned request_size
, unsigned max_pending
,
569 size_t line_size
, ssize_t line_pitch
, unsigned num_lines
)
571 _parent
.dmaPort
, size
, request_size
, max_pending
,
572 Request::UNCACHEABLE
),
574 lineSize(line_size
), linePitch(line_pitch
), numLines(num_lines
),
580 HDLcd::DmaEngine::serialize(CheckpointOut
&cp
) const
582 DmaReadFifo::serialize(cp
);
584 SERIALIZE_SCALAR(nextLineAddr
);
585 SERIALIZE_SCALAR(frameEnd
);
589 HDLcd::DmaEngine::unserialize(CheckpointIn
&cp
)
591 DmaReadFifo::unserialize(cp
);
593 UNSERIALIZE_SCALAR(nextLineAddr
);
594 UNSERIALIZE_SCALAR(frameEnd
);
598 HDLcd::DmaEngine::startFrame(Addr fb_base
)
600 nextLineAddr
= fb_base
;
601 frameEnd
= fb_base
+ numLines
* linePitch
;
603 startFill(nextLineAddr
, lineSize
);
607 HDLcd::DmaEngine::abortFrame()
609 nextLineAddr
= frameEnd
;
616 HDLcd::DmaEngine::dumpSettings()
618 inform("DMA line size: %u bytes", lineSize
);
619 inform("DMA line pitch: %i bytes", linePitch
);
620 inform("DMA num lines: %u", numLines
);
624 HDLcd::DmaEngine::onEndOfBlock()
626 if (nextLineAddr
== frameEnd
)
627 // We're done with this frame. Ignore calls to this method
628 // until the next frame has been started.
631 nextLineAddr
+= linePitch
;
632 if (nextLineAddr
!= frameEnd
)
633 startFill(nextLineAddr
, lineSize
);
637 HDLcd::DmaEngine::onIdle()
639 parent
.intRaise(INT_DMA_END
);
643 HDLcd::PixelPump::dumpSettings()
645 const DisplayTimings
&t(timings());
647 inform("PixelPump width: %u", t
.width
);
648 inform("PixelPump height: %u", t
.height
);
650 inform("PixelPump horizontal back porch: %u", t
.hBackPorch
);
651 inform("PixelPump horizontal fron porch: %u", t
.hFrontPorch
);
652 inform("PixelPump horizontal fron porch: %u", t
.hSync
);
654 inform("PixelPump vertical back porch: %u", t
.vBackPorch
);
655 inform("PixelPump vertical fron porch: %u", t
.vFrontPorch
);
656 inform("PixelPump vertical fron porch: %u", t
.vSync
);
661 HDLcdParams::create()
663 return new HDLcd(this);