From nobody Mon May 11 00:51:12 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 44C9FC433EF for ; Wed, 20 Apr 2022 07:25:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1354438AbiDTH1z (ORCPT ); Wed, 20 Apr 2022 03:27:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41380 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1359766AbiDTH1R (ORCPT ); Wed, 20 Apr 2022 03:27:17 -0400 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id A7DBF3B572 for ; Wed, 20 Apr 2022 00:24:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1650439461; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=70+NNt2xtRmHQqLOMHsElopnyuSB4rdpz+fN4EuTmaU=; b=hC7KtBwqKEusVwUJWnZwYZJDR2nt/cdp1YQf2DLXWlCpjZMqud57HfrUxy8aHospkWAQpa 7DBhxHwb7s3B+hDu54kTTD3yaqLxr+1OeVLfD5AGvNivLV+txTLg8sayBX+XMQxRjKySiq HWni8nGz3hDRWp5lkLxnrojl277q37E= Received: from mail-wr1-f70.google.com (mail-wr1-f70.google.com [209.85.221.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-86-Ii8a3Q7pNf2ojSwbuwiOww-1; Wed, 20 Apr 2022 03:24:20 -0400 X-MC-Unique: Ii8a3Q7pNf2ojSwbuwiOww-1 Received: by mail-wr1-f70.google.com with SMTP id s13-20020adfa28d000000b00205e049cff2so109770wra.17 for ; Wed, 20 Apr 2022 00:24:20 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=70+NNt2xtRmHQqLOMHsElopnyuSB4rdpz+fN4EuTmaU=; b=B4zAlzYo27fJ9knQKWqTCZs+WjH2DYtM8Kd63e2BlBTSxEs6HNbaPTQyxAF7n5JSUW MjmXwzVqEkKxtg6rpUbmad2e/soaGIvLLCFsSXITXyr+/o0Vgnd62oRlAjEvEZrZXMpm f/oIkHn55TWbFhFvmXHxLWiR/jTaHJ05oDfVwxP9urHEwNtEM1cjrCu9UiGgpBAabs9w HaKw42NlcRsHuUCVfkYsG1FGFPLnA8ME7AdFzc7faR+YB1KhCqJtSkVz8hFmFHulIRwc EbuhhSVMPuaCSxZsR7Dokm40Wx1CClsxyPV5e4mNod8mygohOrHEdHL8vCu9zg04/3w3 mYzA== X-Gm-Message-State: AOAM531EF4QHfDOj2BGzW+jGGYKAVx88Y2cKVlG/e4viS+EUEhReV+tf 6Swd4+HGpMQASs9b/DzQ4+rNPW7oObMd2fcDbW2+EJi49tjt4xS/+/zhM2S24hCnnCK/SPCsiCR sYT7EM8DMo9B0gmyp65aMrcqPPnvLqpqf4MOpJ/gIAgJ0WCrvsNvsCjNtfaD48FIwZESCQw9a3K Y= X-Received: by 2002:adf:e5d2:0:b0:207:9be3:c080 with SMTP id a18-20020adfe5d2000000b002079be3c080mr14296722wrn.519.1650439458992; Wed, 20 Apr 2022 00:24:18 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxnCOhTmNd8q/c576iu7dDGltRjR3ltNWqTw2/47SyRKDaivg8p55/9kL/BCNiJ6SF0CgqILw== X-Received: by 2002:adf:e5d2:0:b0:207:9be3:c080 with SMTP id a18-20020adfe5d2000000b002079be3c080mr14296698wrn.519.1650439458646; Wed, 20 Apr 2022 00:24:18 -0700 (PDT) Received: from minerva.home ([92.176.231.205]) by smtp.gmail.com with ESMTPSA id m7-20020adfe0c7000000b002060e7bbe49sm17026889wri.45.2022.04.20.00.24.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Apr 2022 00:24:18 -0700 (PDT) From: Javier Martinez Canillas To: linux-kernel@vger.kernel.org Cc: Daniel Vetter , Pekka Paalanen , Thomas Zimmermann , Laurent Pinchart , Javier Martinez Canillas , Daniel Vetter , David Airlie , Jonathan Corbet , Maarten Lankhorst , Maxime Ripard , dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org Subject: [PATCH v3] drm/doc: Add sections about tiny drivers and external refs to intro page Date: Wed, 20 Apr 2022 09:24:11 +0200 Message-Id: <20220420072411.15104-1-javierm@redhat.com> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Learning about the DRM subsystem could be quite overwhelming for newcomers but there are lots of useful talks, slides and articles available that can help to understand the needed concepts and ease the learning curve. There are also simple DRM drivers that can be used as example about how a DRM driver should look like. Add sections to the introduction page, that contains references to these. Suggested-by: Daniel Vetter Signed-off-by: Javier Martinez Canillas Acked-by: Pekka Paalanen Acked-by: Thomas Zimmermann Acked-by: Daniel Vetter --- Changes in v3: - Fix typos and grammar errors that found when re-reading the changes. Changes in v2: - Remove paragraph that gave wrong impression that DRM is complex (Pekka Pa= alanen). - Add Thomas Zimmermann's and Pekka Paalanen's Acked-by tags. - Replace "Learning material" title with "External References" (Thomas Zimm= ermann). - Add a section about tiny DRM drivers being a good first example (Daniel V= etter). - Add some more external references that I found interesting since v1 was p= osted. Documentation/gpu/introduction.rst | 60 ++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/Documentation/gpu/introduction.rst b/Documentation/gpu/introdu= ction.rst index 25a56e9c0cfd..f05eccd2c07c 100644 --- a/Documentation/gpu/introduction.rst +++ b/Documentation/gpu/introduction.rst @@ -112,3 +112,63 @@ Please conduct yourself in a respectful and civilised = manner when interacting with community members on mailing lists, IRC, or bug trackers. The community represents the project as a whole, and abusive or bullying behaviour is not tolerated by the project. + +Simple DRM drivers to use as examples +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The DRM subsystem contains a lot of helper functions to ease writing drive= rs for +simple graphic devices. For example, the `drivers/gpu/drm/tiny/` directory= has a +set of drivers that are simple enough to be implemented in a single source= file. + +These drivers make use of the `struct drm_simple_display_pipe_funcs`, that= hides +any complexity of the DRM subsystem and just requires drivers to implement= a few +functions needed to operate the device. This could be used for devices tha= t just +need a display pipeline with one full-screen scanout buffer feeding one ou= tput. + +The tiny DRM drivers are good examples to understand how DRM drivers shoul= d look +like. Since are just a few hundreds lines of code, they are quite easy to = read. + +External References +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Delving into a Linux kernel subsystem for the first time can be an overwhe= lming +experience, one needs to get familiar with all the concepts and learn abou= t the +subsystem's internals, among other details. + +To shallow the learning curve, this section contains a list of presentatio= ns +and documents that can be used to learn about DRM/KMS and graphics in gene= ral. + +There are different reasons why someone might want to get into DRM: portin= g an +existing fbdev driver, write a DRM driver for a new hardware, fixing bugs = that +could face when working on the graphics user-space stack, etc. For this re= ason, +the learning material covers many aspects of the Linux graphics stack. Fro= m an +overview of the kernel and user-space stacks to very specific topics. + +The list is sorted in reverse chronological order, to keep the most up-to-= date +material at the top. But all of them contain useful information, and it ca= n be +valuable to go through older material to understand the rationale and cont= ext +in which the changes to the DRM subsystem were made. + +Conference talks +---------------- + +* `An Overview of the Linux and Userspace Graphics Stack `_ - Paul Kocialkowski (2020) +* `Getting pixels on screen on Linux: introduction to Kernel Mode Setting = `_ - Simon Ser (2020) +* `Everything Great about Upstream Graphics `_ - Daniel Vetter (2019) +* `An introduction to the Linux DRM subsystem `_ - Maxime Ripard (2017) +* `Embrace the Atomic (Display) Age `_ - Daniel Vetter (2016) +* `Anatomy of an Atomic KMS Driver `_ - Laurent Pinchart (2015) +* `Atomic Modesetting for Drivers `_ - Daniel Vetter (2015) +* `Anatomy of an Embedded KMS Driver `_ - Laurent Pinchart (2013) + +Slides and articles +------------------- + +* `Understanding the Linux Graphics Stack `_ - Bootlin (2022) +* `DRM KMS overview `_= - STMicroelectronics (2021) +* `Linux graphic stack `_ - Nathan Gau=C3=ABr (2017) +* `Atomic mode setting design overview, part 1 `_ - Daniel Vetter (2015) +* `Atomic mode setting design overview, part 2 `_ - Daniel Vetter (2015) +* `The DRM/KMS subsystem from a newbie=E2=80=99s point of view `_ - Boris Brezillon (2014) +* `A brief introduction to the Linux graphics stack `_ = - Iago Toral (2014) +* `The Linux Graphics Stack `_ - Jasper St. Pierre (2012) --=20 2.35.1