Documentation/gpu/introduction.rst

5 The Linux DRM layer contains code intended to support the needs of
8 make use of DRM functions to make tasks like memory management,
17 [Insert diagram of typical DRM stack here]
23 are written as all-uppercase, for example: DRM, KMS, IOCTL, CRTC, and so
24 on. To aid in reading, documentations make full use of the markup
29 entries in function vtables (and structure members in general) please use
37 documentation than runtime noise this provides more value. And on top of
44 Functions which have a non-\ ``void`` return value should have a section
47 section name should be all upper-case or not, and whether it should end
48 in a colon or not. Go with the file-local style. Other common section
55 -----------------------------------
63 authors: Internal functions of drm.ko and definitely static functions should not
64 have formal kerneldoc comments. Use normal C comments if you feel like a comment
65 is warranted. You may use kerneldoc syntax in the comment, but it shall not
77 Anyone looking to kick it up a notch can find a list of janitorial tasks on
85 Here we just document some of the specialities of the GPU subsystem.
88 -----------------------
90 All feature work must be in the linux-next tree by the -rc6 release of the
92 merge window. All patches must have landed in the drm-next tree by latest -rc7,
93 but if your branch is not in linux-next then this must have happened by -rc6
97 with the -rc1 release) are allowed. No new platform enabling or new drivers are
100 This means that there's a blackout-period of about one month where feature work
101 can't be merged. The recommended way to deal with that is having a -next tree
102 that's always open, but making sure to not feed it into linux-next during the
103 blackout period. As an example, drm-misc works like that.
105 Code of Conduct
106 ---------------
108 As a freedesktop.org project, dri-devel, and the DRM community, follows the
116 Simple DRM drivers to use as examples
119 The DRM subsystem contains a lot of helper functions to ease writing drivers for
121 set of drivers that are simple enough to be implemented in a single source file.
123 These drivers make use of the `struct drm_simple_display_pipe_funcs`, that hides
124 any complexity of the DRM subsystem and just requires drivers to implement a few
126 need a display pipeline with one full-screen scanout buffer feeding one output.
129 like. Since are just a few hundreds lines of code, they are quite easy to read.
138 To shallow the learning curve, this section contains a list of presentations
143 could face when working on the graphics user-space stack, etc. For this reason,
144 the learning material covers many aspects of the Linux graphics stack. From an
145 overview of the kernel and user-space stacks to very specific topics.
147 The list is sorted in reverse chronological order, to keep the most up-to-date
148 material at the top. But all of them contain useful information, and it can be
153 ----------------
155 * `An Overview of the Linux and Userspace Graphics Stack <https://www.youtube.com/watch?v=wjAJmqwg4…
156 …roduction to Kernel Mode Setting <https://www.youtube.com/watch?v=haes4_Xnc5Q>`_ - Simon Ser (2020)
157 * `Everything Great about Upstream Graphics <https://www.youtube.com/watch?v=kVzHOgt6WGE>`_ - Simon…
158 * `An introduction to the Linux DRM subsystem <https://www.youtube.com/watch?v=LbDOCJcDRoo>`_ - Max…
159 * `Embrace the Atomic (Display) Age <https://www.youtube.com/watch?v=LjiB_JeDn2M>`_ - Simona Vetter…
160 * `Anatomy of an Atomic KMS Driver <https://www.youtube.com/watch?v=lihqR9sENpc>`_ - Laurent Pincha…
161 * `Atomic Modesetting for Drivers <https://www.youtube.com/watch?v=kl9suFgbTc8>`_ - Simona Vetter (…
162 * `Anatomy of an Embedded KMS Driver <https://www.youtube.com/watch?v=Ja8fM7rTae4>`_ - Laurent Pinc…
165 -------------------
167 * `The Linux graphics stack in a nutshell, part 1 <https://lwn.net/Articles/955376/>`_ - Thomas Zim…
168 * `The Linux graphics stack in a nutshell, part 2 <https://lwn.net/Articles/955708/>`_ - Thomas Zim…
169 …x Graphics Stack <https://bootlin.com/doc/training/graphics/graphics-slides.pdf>`_ - Bootlin (2022)
170 * `DRM KMS overview <https://wiki.st.com/stm32mpu/wiki/DRM_KMS_overview>`_ - STMicroelectronics (20…
171 * `Linux graphic stack <https://studiopixl.com/2017-05-13/linux-graphic-stack-an-overview>`_ - Nath…
172 * `Atomic mode setting design overview, part 1 <https://lwn.net/Articles/653071/>`_ - Simona Vetter…
173 * `Atomic mode setting design overview, part 2 <https://lwn.net/Articles/653466/>`_ - Simona Vetter…
174 …stem from a newbie’s point of view <https://bootlin.com/pub/conferences/2014/elce/brezillon-drm-km…
175 …tack <https://blogs.igalia.com/itoral/2014/07/29/a-brief-introduction-to-the-linux-graphics-stack/…
176 * `The Linux Graphics Stack <https://blog.mecheye.net/2012/06/the-linux-graphics-stack/>`_ - Jasper…