From patchwork Fri Nov 1 15:37:54 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rob Herring X-Patchwork-Id: 11223333 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1BE94913 for ; Fri, 1 Nov 2019 15:37:59 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 0024021835 for ; Fri, 1 Nov 2019 15:37:58 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 0024021835 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 5E2906F829; Fri, 1 Nov 2019 15:37:58 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-ot1-f68.google.com (mail-ot1-f68.google.com [209.85.210.68]) by gabe.freedesktop.org (Postfix) with ESMTPS id B88936F829 for ; Fri, 1 Nov 2019 15:37:56 +0000 (UTC) Received: by mail-ot1-f68.google.com with SMTP id u13so8710304ote.0 for ; Fri, 01 Nov 2019 08:37:56 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=+yKNdLjlzkZtId7/VHsGjEwHkeu1ea1nr0nNcKO5t6A=; b=DcAOIKdR/RapcpvcG8IoFK6EQY/gjl7xe146stVXSG+fS/GX1L654iBJhvl/hQL5tp QJoPYRWlVDlzCTm1pUlMK0KWvvDc52Pl7AHlBg7JGu9FbrShSI54tnS4vOxB+VbdJjfJ tfu41E/OAtQ1pF3d7CrxK+hljQ5+TFMhhXDoIOcd9oHYrhDY4t9GU/0B+sDdQGEpx97l fIUIqv7AxTkTn0m6zMoiH9gEZB457KC9SUxeWIonEifBlL4mvd2bQIN8p7iK1a/D+bVB +s3Ih2ECTr3oBkYuDtJCuMhc9EA9QvZZipXHvrruQ32kWOf7gbe7NE8ki18t0iKH8Xb/ gUcw== X-Gm-Message-State: APjAAAX2HTwlxYQzF4uVKL8tYADIKrNDM1jLGViWY5Twy35SiqZghrLT tcvZhmd+sG7UtxyTaHog7ckO88c= X-Google-Smtp-Source: APXvYqzgj+8kLVxuNakZZieBzKGqtwkeH2Vc6DDYC9EgCR0ChCGUg6kksKEXjNn5vGMlNjswdtXSeg== X-Received: by 2002:a05:6830:1491:: with SMTP id s17mr9578349otq.310.1572622675509; Fri, 01 Nov 2019 08:37:55 -0700 (PDT) Received: from xps15.herring.priv (24-155-109-49.dyn.grandenetworks.net. [24.155.109.49]) by smtp.googlemail.com with ESMTPSA id t10sm2029720oib.49.2019.11.01.08.37.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 01 Nov 2019 08:37:54 -0700 (PDT) From: Rob Herring To: dri-devel@lists.freedesktop.org Subject: [PATCH] drm/shmem: Add docbook comments for drm_gem_shmem_object madvise fields Date: Fri, 1 Nov 2019 10:37:54 -0500 Message-Id: <20191101153754.22803-1-robh@kernel.org> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: David Airlie , Sean Paul Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Add missing docbook comments to madvise fields in struct drm_gem_shmem_object which fixes these warnings: include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv' not described in 'drm_gem_shmem_object' include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv_list' not described in 'drm_gem_shmem_object' Fixes: 17acb9f35ed7 ("drm/shmem: Add madvise state and purge helpers") Reported-by: Sean Paul Cc: Maarten Lankhorst Cc: Maxime Ripard Cc: David Airlie Cc: Daniel Vetter Signed-off-by: Rob Herring Reviewed-by: Sean Paul --- include/drm/drm_gem_shmem_helper.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/include/drm/drm_gem_shmem_helper.h b/include/drm/drm_gem_shmem_helper.h index e2e9947b4770..901eafb09209 100644 --- a/include/drm/drm_gem_shmem_helper.h +++ b/include/drm/drm_gem_shmem_helper.h @@ -44,7 +44,20 @@ struct drm_gem_shmem_object { */ unsigned int pages_use_count; + /** + * @madv: State for madvise + * + * 0 is active/inuse. + * A negative value is the object is purged. + * Positive values are driver specific and not used by the helpers. + */ int madv; + + /** + * @madv_list: List entry for madvise tracking + * + * Typically used by drivers to track purgeable objects + */ struct list_head madv_list; /**