€•`€      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ/translations/zh_CN/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/zh_TW/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/it_IT/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ja_JP/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ko_KR/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/pt_BR/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/sp_SP/gpu/vc4”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ$drm/vc4 Broadcom VC4 Graphics Driver”h]”hŒ$drm/vc4 Broadcom VC4 Graphics Driver”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³Œ5/var/lib/git/docbuild/linux/Documentation/gpu/vc4.rst”h´KubhŒ	paragraph”“”)”}”(hŒÙThe Broadcom VideoCore 4 (present in the Raspberry Pi) contains a
OpenGL ES 2.0-compatible 3D engine called V3D, and a highly
configurable display output pipeline that supports HDMI, DSI, DPI,
and Composite TV output.”h]”hŒÙThe Broadcom VideoCore 4 (present in the Raspberry Pi) contains a
OpenGL ES 2.0-compatible 3D engine called V3D, and a highly
configurable display output pipeline that supports HDMI, DSI, DPI,
and Composite TV output.”…””}”(hhÍh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒT/var/lib/git/docbuild/linux/Documentation/gpu/vc4:5: ./drivers/gpu/drm/vc4/vc4_drv.c”h´Khh·h²hubhÌ)”}”(hXG  The 3D engine also has an interface for submitting arbitrary
compute shader-style jobs using the same shader processor as is
used for vertex and fragment shaders in GLES 2.0.  However, given
that the hardware isn't able to expose any standard interfaces like
OpenGL compute shaders or OpenCL, it isn't supported by this
driver.”h]”hXK  The 3D engine also has an interface for submitting arbitrary
compute shader-style jobs using the same shader processor as is
used for vertex and fragment shaders in GLES 2.0.  However, given
that the hardware isnâ€™t able to expose any standard interfaces like
OpenGL compute shaders or OpenCL, it isnâ€™t supported by this
driver.”…””}”(hhÜh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒT/var/lib/git/docbuild/linux/Documentation/gpu/vc4:5: ./drivers/gpu/drm/vc4/vc4_drv.c”h´Khh·h²hubh¶)”}”(hhh]”(h»)”}”(hŒDisplay Hardware Handling”h]”hŒDisplay Hardware Handling”…””}”(hhîh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhhëh²hh³hÊh´K	ubhÌ)”}”(hŒ»This section covers everything related to the display hardware including
the mode setting infrastructure, plane, sprite and cursor handling and
display, output probing and related topics.”h]”hŒ»This section covers everything related to the display hardware including
the mode setting infrastructure, plane, sprite and cursor handling and
display, output probing and related topics.”…””}”(hhüh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khhëh²hubh¶)”}”(hhh]”(h»)”}”(hŒPixel Valve (DRM CRTC)”h]”hŒPixel Valve (DRM CRTC)”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj
  h²hh³hÊh´KubhÌ)”}”(hŒûIn VC4, the Pixel Valve is what most closely corresponds to the
DRM's concept of a CRTC.  The PV generates video timings from the
encoder's clock plus its configuration.  It pulls scaled pixels from
the HVS at that timing, and feeds it to the encoder.”h]”hŒÿIn VC4, the Pixel Valve is what most closely corresponds to the
DRMâ€™s concept of a CRTC.  The PV generates video timings from the
encoderâ€™s clock plus its configuration.  It pulls scaled pixels from
the HVS at that timing, and feeds it to the encoder.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:18: ./drivers/gpu/drm/vc4/vc4_crtc.c”h´Khj
  h²hubhÌ)”}”(hŒÏHowever, the DRM CRTC also collects the configuration of all the
DRM planes attached to it.  As a result, the CRTC is also
responsible for writing the display list for the HVS channel that
the CRTC will use.”h]”hŒÏHowever, the DRM CRTC also collects the configuration of all the
DRM planes attached to it.  As a result, the CRTC is also
responsible for writing the display list for the HVS channel that
the CRTC will use.”…””}”(hj*  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:18: ./drivers/gpu/drm/vc4/vc4_crtc.c”h´Khj
  h²hubhÌ)”}”(hXB  The 2835 has 3 different pixel valves.  pv0 in the audio power
domain feeds DSI0 or DPI, while pv1 feeds DS1 or SMI.  pv2 in the
image domain can feed either HDMI or the SDTV controller.  The
pixel valve chooses from the CPRMAN clocks (HSM for HDMI, VEC for
SDTV, etc.) according to which output type is chosen in the mux.”h]”hXB  The 2835 has 3 different pixel valves.  pv0 in the audio power
domain feeds DSI0 or DPI, while pv1 feeds DS1 or SMI.  pv2 in the
image domain can feed either HDMI or the SDTV controller.  The
pixel valve chooses from the CPRMAN clocks (HSM for HDMI, VEC for
SDTV, etc.) according to which output type is chosen in the mux.”…””}”(hj9  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:18: ./drivers/gpu/drm/vc4/vc4_crtc.c”h´Khj
  h²hubhÌ)”}”(hX  For power management, the pixel valve's registers are all clocked
by the AXI clock, while the timings and FIFOs make use of the
output-specific clock.  Since the encoders also directly consume
the CPRMAN clocks, and know what timings they need, they are the
ones that set the clock.”h]”hX  For power management, the pixel valveâ€™s registers are all clocked
by the AXI clock, while the timings and FIFOs make use of the
output-specific clock.  Since the encoders also directly consume
the CPRMAN clocks, and know what timings they need, they are the
ones that set the clock.”…””}”(hjH  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:18: ./drivers/gpu/drm/vc4/vc4_crtc.c”h´Khj
  h²hubeh}”(h]”Œpixel-valve-drm-crtc”ah ]”h"]”Œpixel valve (drm crtc)”ah$]”h&]”uh1hµhhëh²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒHVS”h]”hŒHVS”…””}”(hjb  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj_  h²hh³hÊh´KubhÌ)”}”(hX^  The Hardware Video Scaler (HVS) is the piece of hardware that does
translation, scaling, colorspace conversion, and compositing of
pixels stored in framebuffers into a FIFO of pixels going out to
the Pixel Valve (CRTC).  It operates at the system clock rate (the
system audio clock gate, specifically), which is much higher than
the pixel clock rate.”h]”hX^  The Hardware Video Scaler (HVS) is the piece of hardware that does
translation, scaling, colorspace conversion, and compositing of
pixels stored in framebuffers into a FIFO of pixels going out to
the Pixel Valve (CRTC).  It operates at the system clock rate (the
system audio clock gate, specifically), which is much higher than
the pixel clock rate.”…””}”(hjp  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:24: ./drivers/gpu/drm/vc4/vc4_hvs.c”h´Khj_  h²hubhÌ)”}”(hŒÏThere is a single global HVS, with multiple output FIFOs that can
be consumed by the PVs.  This file just manages the resources for
the HVS, while the vc4_crtc.c code actually drives HVS setup for
each CRTC.”h]”hŒÏThere is a single global HVS, with multiple output FIFOs that can
be consumed by the PVs.  This file just manages the resources for
the HVS, while the vc4_crtc.c code actually drives HVS setup for
each CRTC.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:24: ./drivers/gpu/drm/vc4/vc4_hvs.c”h´Khj_  h²hubeh}”(h]”Œhvs”ah ]”h"]”Œhvs”ah$]”h&]”uh1hµhhëh²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ
HVS planes”h]”hŒ
HVS planes”…””}”(hj™  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj–  h²hh³hÊh´KubhÌ)”}”(hŒAEach DRM plane is a layer of pixels being scanned out by the HVS.”h]”hŒAEach DRM plane is a layer of pixels being scanned out by the HVS.”…””}”(hj§  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒW/var/lib/git/docbuild/linux/Documentation/gpu/vc4:30: ./drivers/gpu/drm/vc4/vc4_plane.c”h´Khj–  h²hubhÌ)”}”(hXB  At atomic modeset check time, we compute the HVS display element
state that would be necessary for displaying the plane (giving us a
chance to figure out if a plane configuration is invalid), then at
atomic flush time the CRTC will ask us to write our element state
into the region of the HVS that it has allocated for us.”h]”hXB  At atomic modeset check time, we compute the HVS display element
state that would be necessary for displaying the plane (giving us a
chance to figure out if a plane configuration is invalid), then at
atomic flush time the CRTC will ask us to write our element state
into the region of the HVS that it has allocated for us.”…””}”(hj¶  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒW/var/lib/git/docbuild/linux/Documentation/gpu/vc4:30: ./drivers/gpu/drm/vc4/vc4_plane.c”h´K	hj–  h²hubeh}”(h]”Œ
hvs-planes”ah ]”h"]”Œ
hvs planes”ah$]”h&]”uh1hµhhëh²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒHDMI encoder”h]”hŒHDMI encoder”…””}”(hjÐ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÍ  h²hh³hÊh´K"ubhÌ)”}”(hŒ®The HDMI core has a state machine and a PHY.  On BCM2835, most of
the unit operates off of the HSM clock from CPRMAN.  It also
internally uses the PLLH_PIX clock for the PHY.”h]”hŒ®The HDMI core has a state machine and a PHY.  On BCM2835, most of
the unit operates off of the HSM clock from CPRMAN.  It also
internally uses the PLLH_PIX clock for the PHY.”…””}”(hjÞ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:36: ./drivers/gpu/drm/vc4/vc4_hdmi.c”h´K
hjÍ  h²hubhÌ)”}”(hŒ{HDMI infoframes are kept within a small packet ram, where each
packet can be individually enabled for including in a frame.”h]”hŒ{HDMI infoframes are kept within a small packet ram, where each
packet can be individually enabled for including in a frame.”…””}”(hjí  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:36: ./drivers/gpu/drm/vc4/vc4_hdmi.c”h´KhjÍ  h²hubhÌ)”}”(hX  HDMI audio is implemented entirely within the HDMI IP block.  A
register in the HDMI encoder takes SPDIF frames from the DMA engine
and transfers them over an internal MAI (multi-channel audio
interconnect) bus to the encoder side for insertion into the video
blank regions.”h]”hX  HDMI audio is implemented entirely within the HDMI IP block.  A
register in the HDMI encoder takes SPDIF frames from the DMA engine
and transfers them over an internal MAI (multi-channel audio
interconnect) bus to the encoder side for insertion into the video
blank regions.”…””}”(hjü  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:36: ./drivers/gpu/drm/vc4/vc4_hdmi.c”h´KhjÍ  h²hubhÌ)”}”(hŒêThe driver's HDMI encoder does not yet support power management.
The HDMI encoder's power domain and the HSM/pixel clocks are kept
continuously running, and only the HDMI logic and packet ram are
powered off/on at disable/enable time.”h]”hŒîThe driverâ€™s HDMI encoder does not yet support power management.
The HDMI encoderâ€™s power domain and the HSM/pixel clocks are kept
continuously running, and only the HDMI logic and packet ram are
powered off/on at disable/enable time.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:36: ./drivers/gpu/drm/vc4/vc4_hdmi.c”h´KhjÍ  h²hubhÌ)”}”(hŒ[The driver does not yet support CEC control, though the HDMI
encoder block has CEC support.”h]”hŒ[The driver does not yet support CEC control, though the HDMI
encoder block has CEC support.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:36: ./drivers/gpu/drm/vc4/vc4_hdmi.c”h´KhjÍ  h²hubeh}”(h]”Œhdmi-encoder”ah ]”h"]”Œhdmi encoder”ah$]”h&]”uh1hµhhëh²hh³hÊh´K"ubh¶)”}”(hhh]”(h»)”}”(hŒDSI encoder”h]”hŒDSI encoder”…””}”(hj4  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj1  h²hh³hÊh´K(ubhÌ)”}”(hŒŠBCM2835 contains two DSI modules, DSI0 and DSI1.  DSI0 is a
single-lane DSI controller, while DSI1 is a more modern 4-lane DSI
controller.”h]”hŒŠBCM2835 contains two DSI modules, DSI0 and DSI1.  DSI0 is a
single-lane DSI controller, while DSI1 is a more modern 4-lane DSI
controller.”…””}”(hjB  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:42: ./drivers/gpu/drm/vc4/vc4_dsi.c”h´Khj1  h²hubhÌ)”}”(hŒzMost Raspberry Pi boards expose DSI1 as their "DISPLAY" connector,
while the compute module brings both DSI0 and DSI1 out.”h]”hŒ~Most Raspberry Pi boards expose DSI1 as their â€œDISPLAYâ€ connector,
while the compute module brings both DSI0 and DSI1 out.”…””}”(hjQ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:42: ./drivers/gpu/drm/vc4/vc4_dsi.c”h´Khj1  h²hubhÌ)”}”(hŒŠThis driver has been tested for DSI1 video-mode display only
currently, with most of the information necessary for DSI0
hopefully present.”h]”hŒŠThis driver has been tested for DSI1 video-mode display only
currently, with most of the information necessary for DSI0
hopefully present.”…””}”(hj`  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:42: ./drivers/gpu/drm/vc4/vc4_dsi.c”h´Khj1  h²hubeh}”(h]”Œdsi-encoder”ah ]”h"]”Œdsi encoder”ah$]”h&]”uh1hµhhëh²hh³hÊh´K(ubh¶)”}”(hhh]”(h»)”}”(hŒDPI encoder”h]”hŒDPI encoder”…””}”(hjz  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjw  h²hh³hÊh´K.ubhÌ)”}”(hŒThe VC4 DPI hardware supports MIPI DPI type 4 and Nokia ViSSI
signals.  On BCM2835, these can be routed out to GPIO0-27 with the
ALT2 function.”h]”hŒThe VC4 DPI hardware supports MIPI DPI type 4 and Nokia ViSSI
signals.  On BCM2835, these can be routed out to GPIO0-27 with the
ALT2 function.”…””}”(hjˆ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:48: ./drivers/gpu/drm/vc4/vc4_dpi.c”h´Khjw  h²hubeh}”(h]”Œdpi-encoder”ah ]”h"]”Œdpi encoder”ah$]”h&]”uh1hµhhëh²hh³hÊh´K.ubh¶)”}”(hhh]”(h»)”}”(hŒVEC (Composite TV out) encoder”h]”hŒVEC (Composite TV out) encoder”…””}”(hj¢  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjŸ  h²hh³hÊh´K4ubhÌ)”}”(hŒ=The VEC encoder generates PAL or NTSC composite video output.”h]”hŒ=The VEC encoder generates PAL or NTSC composite video output.”…””}”(hj°  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:54: ./drivers/gpu/drm/vc4/vc4_vec.c”h´KhjŸ  h²hubhÌ)”}”(hŒ¤TV mode selection is done by an atomic property on the encoder,
because a drm_mode_modeinfo is insufficient to distinguish between
PAL and PAL-M or NTSC and NTSC-J.”h]”hŒ¤TV mode selection is done by an atomic property on the encoder,
because a drm_mode_modeinfo is insufficient to distinguish between
PAL and PAL-M or NTSC and NTSC-J.”…””}”(hj¿  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒU/var/lib/git/docbuild/linux/Documentation/gpu/vc4:54: ./drivers/gpu/drm/vc4/vc4_vec.c”h´K	hjŸ  h²hubeh}”(h]”Œvec-composite-tv-out-encoder”ah ]”h"]”Œvec (composite tv out) encoder”ah$]”h&]”uh1hµhhëh²hh³hÊh´K4ubeh}”(h]”Œdisplay-hardware-handling”ah ]”h"]”Œdisplay hardware handling”ah$]”h&]”uh1hµhh·h²hh³hÊh´K	ubh¶)”}”(hhh]”(h»)”}”(hŒKUnit Tests”h]”hŒKUnit Tests”…””}”(hjá  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÞ  h²hh³hÊh´K:ubhÌ)”}”(hŒPThe VC4 Driver uses KUnit to perform driver-specific unit and
integration tests.”h]”hŒPThe VC4 Driver uses KUnit to perform driver-specific unit and
integration tests.”…””}”(hjï  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K<hjÞ  h²hubhÌ)”}”(hŒqThese tests are using a mock driver and can be ran using the
command below, on either arm or arm64 architectures,”h]”hŒqThese tests are using a mock driver and can be ran using the
command below, on either arm or arm64 architectures,”…””}”(hjý  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K?hjÞ  h²hubhŒliteral_block”“”)”}”(hŒ$ ./tools/testing/kunit/kunit.py run \
        --kunitconfig=drivers/gpu/drm/vc4/tests/.kunitconfig \
        --cross_compile aarch64-linux-gnu- --arch arm64”h]”hŒ$ ./tools/testing/kunit/kunit.py run \
        --kunitconfig=drivers/gpu/drm/vc4/tests/.kunitconfig \
        --cross_compile aarch64-linux-gnu- --arch arm64”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”Œforce”‰Œlanguage”Œbash”Œhighlight_args”}”uh1j  h³hÊh´KBhjÞ  h²hubhŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒParts of the driver that are currently covered by tests are:
* The HVS to PixelValve dynamic FIFO assignment, for the BCM2835-7
  and BCM2711.
”h]”(hŒterm”“”)”}”(hŒ<Parts of the driver that are currently covered by tests are:”h]”hŒ<Parts of the driver that are currently covered by tests are:”…””}”(hj/  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j-  h³hÊh´KJhj)  ubhŒ
definition”“”)”}”(hhh]”hŒbullet_list”“”)”}”(hhh]”hŒ	list_item”“”)”}”(hŒNThe HVS to PixelValve dynamic FIFO assignment, for the BCM2835-7
and BCM2711.
”h]”hÌ)”}”(hŒMThe HVS to PixelValve dynamic FIFO assignment, for the BCM2835-7
and BCM2711.”h]”hŒMThe HVS to PixelValve dynamic FIFO assignment, for the BCM2835-7
and BCM2711.”…””}”(hjM  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KIhjI  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjD  ubah}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1jB  h³hÊh´KIhj?  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j=  hj)  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j'  h³hÊh´KJhj$  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j"  hjÞ  h²hh³Nh´Nubeh}”(h]”Œkunit-tests”ah ]”h"]”Œkunit tests”ah$]”h&]”uh1hµhh·h²hh³hÊh´K:ubh¶)”}”(hhh]”(h»)”}”(hŒ+Memory Management and 3D Command Submission”h]”hŒ+Memory Management and 3D Command Submission”…””}”(hj†  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjƒ  h²hh³hÊh´KMubhÌ)”}”(hŒ=This section covers the GEM implementation in the vc4 driver.”h]”hŒ=This section covers the GEM implementation in the vc4 driver.”…””}”(hj”  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KOhjƒ  h²hubh¶)”}”(hhh]”(h»)”}”(hŒ!GPU buffer object (BO) management”h]”hŒ!GPU buffer object (BO) management”…””}”(hj¥  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj¢  h²hh³hÊh´KRubhÌ)”}”(hŒâThe VC4 GPU architecture (both scanout and rendering) has direct
access to system memory with no MMU in between.  To support it, we
use the GEM DMA helper functions to allocate contiguous ranges of
physical memory for our BOs.”h]”hŒâThe VC4 GPU architecture (both scanout and rendering) has direct
access to system memory with no MMU in between.  To support it, we
use the GEM DMA helper functions to allocate contiguous ranges of
physical memory for our BOs.”…””}”(hj³  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒT/var/lib/git/docbuild/linux/Documentation/gpu/vc4:84: ./drivers/gpu/drm/vc4/vc4_bo.c”h´Khj¢  h²hubhÌ)”}”(hŒ¢Since the DMA allocator is very slow, we keep a cache of recently
freed BOs around so that the kernel's allocation of objects for 3D
rendering can return quickly.”h]”hŒ¤Since the DMA allocator is very slow, we keep a cache of recently
freed BOs around so that the kernelâ€™s allocation of objects for 3D
rendering can return quickly.”…””}”(hjÂ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒT/var/lib/git/docbuild/linux/Documentation/gpu/vc4:84: ./drivers/gpu/drm/vc4/vc4_bo.c”h´Khj¢  h²hubeh}”(h]”Œgpu-buffer-object-bo-management”ah ]”h"]”Œ!gpu buffer object (bo) management”ah$]”h&]”uh1hµhjƒ  h²hh³hÊh´KRubh¶)”}”(hhh]”(h»)”}”(hŒ(V3D binner command list (BCL) validation”h]”hŒ(V3D binner command list (BCL) validation”…””}”(hjÜ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÙ  h²hh³hÊh´KXubhÌ)”}”(hX  Since the VC4 has no IOMMU between it and system memory, a user
with access to execute command lists could escalate privilege by
overwriting system memory (drawing to it as a framebuffer) or
reading system memory it shouldn't (reading it as a vertex buffer
or index buffer)”h]”hX  Since the VC4 has no IOMMU between it and system memory, a user
with access to execute command lists could escalate privilege by
overwriting system memory (drawing to it as a framebuffer) or
reading system memory it shouldnâ€™t (reading it as a vertex buffer
or index buffer)”…””}”(hjê  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒZ/var/lib/git/docbuild/linux/Documentation/gpu/vc4:90: ./drivers/gpu/drm/vc4/vc4_validate.c”h´KhjÙ  h²hubhÌ)”}”(hX  We validate binner command lists to ensure that all accesses are
within the bounds of the GEM objects referenced by the submitted
job.  It explicitly whitelists packets, and looks at the offsets in
any address fields to make sure they're contained within the BOs
they reference.”h]”hX  We validate binner command lists to ensure that all accesses are
within the bounds of the GEM objects referenced by the submitted
job.  It explicitly whitelists packets, and looks at the offsets in
any address fields to make sure theyâ€™re contained within the BOs
they reference.”…””}”(hjù  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒZ/var/lib/git/docbuild/linux/Documentation/gpu/vc4:90: ./drivers/gpu/drm/vc4/vc4_validate.c”h´KhjÙ  h²hubhÌ)”}”(hX  Note that because CL validation is already reading the
user-submitted CL and writing the validated copy out to the memory
that the GPU will actually read, this is also where GEM relocation
processing (turning BO references into actual addresses for the GPU
to use) happens.”h]”hX  Note that because CL validation is already reading the
user-submitted CL and writing the validated copy out to the memory
that the GPU will actually read, this is also where GEM relocation
processing (turning BO references into actual addresses for the GPU
to use) happens.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒZ/var/lib/git/docbuild/linux/Documentation/gpu/vc4:90: ./drivers/gpu/drm/vc4/vc4_validate.c”h´K%hjÙ  h²hubeh}”(h]”Œ&v3d-binner-command-list-bcl-validation”ah ]”h"]”Œ(v3d binner command list (bcl) validation”ah$]”h&]”uh1hµhjƒ  h²hh³hÊh´KXubh¶)”}”(hhh]”(h»)”}”(hŒ(V3D render command list (RCL) generation”h]”hŒ(V3D render command list (RCL) generation”…””}”(hj"  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´K^ubhÌ)”}”(hŒ¶In the V3D hardware, render command lists are what load and store
tiles of a framebuffer and optionally call out to binner-generated
command lists to do the 3D drawing for that tile.”h]”hŒ¶In the V3D hardware, render command lists are what load and store
tiles of a framebuffer and optionally call out to binner-generated
command lists to do the 3D drawing for that tile.”…””}”(hj0  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³Œ[/var/lib/git/docbuild/linux/Documentation/gpu/vc4:96: ./drivers/gpu/drm/vc4/vc4_render_cl.c”h´Khj  h²hubhÌ)”}”(hX)  In the VC4 driver, render command list generation is performed by the
kernel instead of userspace.  We do this because validating a
user-submitted command list is hard to get right and has high CPU overhead,
while the number of valid configurations for render command lists is
actually fairly low.”h]”hX)  In the VC4 driver, render command list generation is performed by the
kernel instead of userspace.  We do this because validating a
user-submitted command list is hard to get right and has high CPU overhead,
while the number of valid configurations for render command lists is
actually fairly low.”…””}”(hj?  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³Œ[/var/lib/git/docbuild/linux/Documentation/gpu/vc4:96: ./drivers/gpu/drm/vc4/vc4_render_cl.c”h´Khj  h²hubeh}”(h]”Œ&v3d-render-command-list-rcl-generation”ah ]”h"]”Œ(v3d render command list (rcl) generation”ah$]”h&]”uh1hµhjƒ  h²hh³hÊh´K^ubh¶)”}”(hhh]”(h»)”}”(hŒShader validator for VC4”h]”hŒShader validator for VC4”…””}”(hjY  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjV  h²hh³hÊh´KdubhÌ)”}”(hXJ  Since the VC4 has no IOMMU between it and system memory, a user
with access to execute shaders could escalate privilege by
overwriting system memory (using the VPM write address register in
the general-purpose DMA mode) or reading system memory it shouldn't
(reading it as a texture, uniform data, or direct-addressed TMU
lookup).”h]”hXL  Since the VC4 has no IOMMU between it and system memory, a user
with access to execute shaders could escalate privilege by
overwriting system memory (using the VPM write address register in
the general-purpose DMA mode) or reading system memory it shouldnâ€™t
(reading it as a texture, uniform data, or direct-addressed TMU
lookup).”…””}”(hjg  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³Œc/var/lib/git/docbuild/linux/Documentation/gpu/vc4:101: ./drivers/gpu/drm/vc4/vc4_validate_shaders.c”h´KhjV  h²hubhÌ)”}”(hŒÐThe shader validator walks over a shader's BO, ensuring that its
accesses are appropriately bounded, and recording where texture
accesses are made so that we can do relocations for them in the
uniform stream.”h]”hŒÒThe shader validator walks over a shaderâ€™s BO, ensuring that its
accesses are appropriately bounded, and recording where texture
accesses are made so that we can do relocations for them in the
uniform stream.”…””}”(hjv  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³Œc/var/lib/git/docbuild/linux/Documentation/gpu/vc4:101: ./drivers/gpu/drm/vc4/vc4_validate_shaders.c”h´K hjV  h²hubhÌ)”}”(hŒ´Shader BO are immutable for their lifetimes (enforced by not
allowing mmaps, GEM prime export, or rendering to from a CL), so
this validation is only performed at BO creation time.”h]”hŒ´Shader BO are immutable for their lifetimes (enforced by not
allowing mmaps, GEM prime export, or rendering to from a CL), so
this validation is only performed at BO creation time.”…””}”(hj…  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³Œc/var/lib/git/docbuild/linux/Documentation/gpu/vc4:101: ./drivers/gpu/drm/vc4/vc4_validate_shaders.c”h´K%hjV  h²hubeh}”(h]”Œshader-validator-for-vc4”ah ]”h"]”Œshader validator for vc4”ah$]”h&]”uh1hµhjƒ  h²hh³hÊh´Kdubh¶)”}”(hhh]”(h»)”}”(hŒV3D Interrupts”h]”hŒV3D Interrupts”…””}”(hjŸ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjœ  h²hh³hÊh´KiubhÌ)”}”(hXf  We have an interrupt status register (V3D_INTCTL) which reports
interrupts, and where writing 1 bits clears those interrupts.
There are also a pair of interrupt registers
(V3D_INTENA/V3D_INTDIS) where writing a 1 to their bits enables or
disables that specific interrupt, and 0s written are ignored
(reading either one returns the set of enabled interrupts).”h]”hXf  We have an interrupt status register (V3D_INTCTL) which reports
interrupts, and where writing 1 bits clears those interrupts.
There are also a pair of interrupt registers
(V3D_INTENA/V3D_INTDIS) where writing a 1 to their bits enables or
disables that specific interrupt, and 0s written are ignored
(reading either one returns the set of enabled interrupts).”…””}”(hj­  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:107: ./drivers/gpu/drm/vc4/vc4_irq.c”h´Khjœ  h²hubhÌ)”}”(hŒ‹When we take a binning flush done interrupt, we need to submit the
next frame for binning and move the finished frame to the render
thread.”h]”hŒ‹When we take a binning flush done interrupt, we need to submit the
next frame for binning and move the finished frame to the render
thread.”…””}”(hj¼  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:107: ./drivers/gpu/drm/vc4/vc4_irq.c”h´K hjœ  h²hubhÌ)”}”(hŒÉWhen we take a render frame interrupt, we need to wake the
processes waiting for some frame to be done, and get the next frame
submitted ASAP (so the hardware doesn't sit idle when there's work
to do).”h]”hŒÍWhen we take a render frame interrupt, we need to wake the
processes waiting for some frame to be done, and get the next frame
submitted ASAP (so the hardware doesnâ€™t sit idle when thereâ€™s work
to do).”…””}”(hjË  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:107: ./drivers/gpu/drm/vc4/vc4_irq.c”h´K$hjœ  h²hubhÌ)”}”(hŒ™When we take the binner out of memory interrupt, we need to
allocate some new memory and pass it to the binner so that the
current job can make progress.”h]”hŒ™When we take the binner out of memory interrupt, we need to
allocate some new memory and pass it to the binner so that the
current job can make progress.”…””}”(hjÚ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³ŒV/var/lib/git/docbuild/linux/Documentation/gpu/vc4:107: ./drivers/gpu/drm/vc4/vc4_irq.c”h´K)hjœ  h²hubeh}”(h]”Œv3d-interrupts”ah ]”h"]”Œv3d interrupts”ah$]”h&]”uh1hµhjƒ  h²hh³hÊh´Kiubeh}”(h]”Œ+memory-management-and-3d-command-submission”ah ]”h"]”Œ+memory management and 3d command submission”ah$]”h&]”uh1hµhh·h²hh³hÊh´KMubeh}”(h]”Œ$drm-vc4-broadcom-vc4-graphics-driver”ah ]”h"]”Œ$drm/vc4 broadcom vc4 graphics driver”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j$  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jþ  jû  jÛ  jØ  j\  jY  j“  j  jÊ  jÇ  j.  j+  jt  jq  jœ  j™  jÓ  jÐ  j€  j}  jö  jó  jÖ  jÓ  j  j  jS  jP  j™  j–  jî  jë  uŒ	nametypes”}”(jþ  ‰jÛ  ‰j\  ‰j“  ‰jÊ  ‰j.  ‰jt  ‰jœ  ‰jÓ  ‰j€  ‰jö  ‰jÖ  ‰j  ‰jS  ‰j™  ‰jî  ‰uh}”(jû  h·jØ  hëjY  j
  j  j_  jÇ  j–  j+  jÍ  jq  j1  j™  jw  jÐ  jŸ  j}  jÞ  jó  jƒ  jÓ  j¢  j  jÙ  jP  j  j–  jV  jë  jœ  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.