Documentation/gpu/introduction.rst

   1 ============
   2 Introduction
   3 ============
   4
   5 The Linux DRM layer contains code intended to support the needs of
   6 complex graphics devices, usually containing programmable pipelines well
   7 suited to 3D graphics acceleration. Graphics drivers in the kernel may
   8 make use of DRM functions to make tasks like memory management,
   9 interrupt handling and DMA easier, and provide a uniform interface to
  10 applications.
  11
  12 A note on versions: this guide covers features found in the DRM tree,
  13 including the TTM memory manager, output configuration and mode setting,
  14 and the new vblank internals, in addition to all the regular features
  15 found in current kernels.
  16
  17 [Insert diagram of typical DRM stack here]
  18
  19 Style Guidelines
  20 ================
  21
  22 For consistency this documentation uses American English. Abbreviations
  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
  25 characters kerneldoc provides: @parameter for function parameters,
  26 @member for structure members (within the same structure), &struct structure to
  27 reference structures and function() for functions. These all get automatically
  28 hyperlinked if kerneldoc for the referenced objects exists. When referencing
  29 entries in function vtables (and structure members in general) please use
  30 &vtable_name.vfunc. Unfortunately this does not yet yield a direct link to the
  31 member, only the structure.
  32
  33 Except in special situations (to separate locked from unlocked variants)
  34 locking requirements for functions aren't documented in the kerneldoc.
  35 Instead locking should be check at runtime using e.g.
  36 ``WARN_ON(!mutex_is_locked(...));``. Since it's much easier to ignore
  37 documentation than runtime noise this provides more value. And on top of
  38 that runtime checks do need to be updated when the locking rules change,
  39 increasing the chances that they're correct. Within the documentation
  40 the locking rules should be explained in the relevant structures: Either
  41 in the comment for the lock explaining what it protects, or data fields
  42 need a note about which lock protects them, or both.
  43
  44 Functions which have a non-\ ``void`` return value should have a section
  45 called "Returns" explaining the expected return values in different
  46 cases and their meanings. Currently there's no consensus whether that
  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
  49 names are "Notes" with information for dangerous or tricky corner cases,
  50 and "FIXME" where the interface could be cleaned up.
  51
  52 Also read the :ref:`guidelines for the kernel documentation at large <doc_guide>`.
  53
  54 Documentation Requirements for kAPI
  55 -----------------------------------
  56
  57 All kernel APIs exported to other modules must be documented, including their
  58 datastructures and at least a short introductory section explaining the overall
  59 concepts. Documentation should be put into the code itself as kerneldoc comments
  60 as much as reasonable.
  61
  62 Do not blindly document everything, but document only what's relevant for driver
  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
  66 start with a /** kerneldoc marker. Similar for data structures, annotate
  67 anything entirely private with ``/* private: */`` comments as per the
  68 documentation guide.
  69
  70 Getting Started
  71 ===============
  72
  73 Developers interested in helping out with the DRM subsystem are very welcome.
  74 Often people will resort to sending in patches for various issues reported by
  75 checkpatch or sparse. We welcome such contributions.
  76
  77 Anyone looking to kick it up a notch can find a list of janitorial tasks on
  78 the :ref:`TODO list <todo>`.
  79
  80 Contribution Process
  81 ====================
  82
  83 Mostly the DRM subsystem works like any other kernel subsystem, see :ref:`the
  84 main process guidelines and documentation <process_index>` for how things work.
  85 Here we just document some of the specialities of the GPU subsystem.
  86
  87 Feature Merge Deadlines
  88 -----------------------
  89
  90 All feature work must be in the linux-next tree by the -rc6 release of the
  91 current release cycle, otherwise they must be postponed and can't reach the next
  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
  94 already.
  95
  96 After that point only bugfixes (like after the upstream merge window has closed
  97 with the -rc1 release) are allowed. No new platform enabling or new drivers are
  98 allowed.
  99
 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.
 104
 105 Code of Conduct
 106 ---------------
 107
 108 As a freedesktop.org project, dri-devel, and the DRM community, follows the
 109 Contributor Covenant, found at: https://www.freedesktop.org/wiki/CodeOfConduct
 110
 111 Please conduct yourself in a respectful and civilised manner when
 112 interacting with community members on mailing lists, IRC, or bug
 113 trackers. The community represents the project as a whole, and abusive
 114 or bullying behaviour is not tolerated by the project.