From mboxrd@z Thu Jan 1 00:00:00 1970 From: Peter Wu Subject: [PATCH v2 4/4] drm/fb-helper: improve documentation and print warnings Date: Fri, 7 Sep 2018 00:18:10 +0200 Message-ID: <20180906221810.20170-5-peter@lekensteyn.nl> References: <20180906221810.20170-1-peter@lekensteyn.nl> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: Received: from mail.lekensteyn.nl (mail.lekensteyn.nl [IPv6:2a02:2308::360:1:25]) by gabe.freedesktop.org (Postfix) with ESMTPS id 8D20F6E781 for ; Thu, 6 Sep 2018 22:18:18 +0000 (UTC) In-Reply-To: <20180906221810.20170-1-peter@lekensteyn.nl> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Gerd Hoffmann Cc: linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org List-Id: dri-devel@lists.freedesktop.org Q2xhcmlmeSB0aGUgcmVsYXRpb24gYmV0d2VlbiBkcm1fZmJfaGVscGVyX2ZiZGV2X3NldHVwL3Rl YXJkb3duLiBDbGFyaWZ5CnJlcXVpcmVtZW50cyBmb3IgdGhlIG5ldyBnZW5lcmljIGZiZGV2IGVt dWxhdGlvbiBBUEkgYW5kIGxvZyBzb21lIG1vcmUKZGV0YWlscyBpbiBjYXNlIHRoZSBkcml2ZXIg ZG9lcyBzb21ldGhpbmcgd3JvbmcuIEZpeCByZWxhdGVkIHR5cG9zLgoKQ2M6IE5vcmFsZiBUcsO4 bm5lcyA8bm9yYWxmQHRyb25uZXMub3JnPgpTaWduZWQtb2ZmLWJ5OiBQZXRlciBXdSA8cGV0ZXJA bGVrZW5zdGV5bi5ubD4KLS0tCiBkcml2ZXJzL2dwdS9kcm0vZHJtX2ZiX2hlbHBlci5jIHwgMjUg KysrKysrKysrKysrKysrKysrKy0tLS0tLQogMSBmaWxlIGNoYW5nZWQsIDE5IGluc2VydGlvbnMo KyksIDYgZGVsZXRpb25zKC0pCgpkaWZmIC0tZ2l0IGEvZHJpdmVycy9ncHUvZHJtL2RybV9mYl9o ZWxwZXIuYyBiL2RyaXZlcnMvZ3B1L2RybS9kcm1fZmJfaGVscGVyLmMKaW5kZXggNGIwZGQyMGJj Y2I4Li43ZjkyZmYxNzM5ODYgMTAwNjQ0Ci0tLSBhL2RyaXZlcnMvZ3B1L2RybS9kcm1fZmJfaGVs cGVyLmMKKysrIGIvZHJpdmVycy9ncHUvZHJtL2RybV9mYl9oZWxwZXIuYwpAQCAtMjgyMSw3ICsy ODIxLDkgQEAgRVhQT1JUX1NZTUJPTChkcm1fZmJfaGVscGVyX2hvdHBsdWdfZXZlbnQpOwogICog VGhlIGNhbGxlciBtdXN0IHRvIHByb3ZpZGUgYSAmZHJtX2ZiX2hlbHBlcl9mdW5jcy0+ZmJfcHJv YmUgY2FsbGJhY2sKICAqIGZ1bmN0aW9uLgogICoKLSAqIFNlZSBhbHNvOiBkcm1fZmJfaGVscGVy X2luaXRpYWxfY29uZmlnKCkKKyAqIFVzZSBkcm1fZmJfaGVscGVyX2ZiZGV2X3RlYXJkb3duKCkg dG8gZGVzdHJveSB0aGUgZmJkZXYuCisgKgorICogU2VlIGFsc286IGRybV9mYl9oZWxwZXJfaW5p dGlhbF9jb25maWcoKSwgZHJtX2ZiZGV2X2dlbmVyaWNfc2V0dXAoKS4KICAqCiAgKiBSZXR1cm5z OgogICogWmVybyBvbiBzdWNjZXNzIG9yIG5lZ2F0aXZlIGVycm9yIGNvZGUgb24gZmFpbHVyZS4K QEAgLTMwMzcsNyArMzAzOSw3IEBAIHN0YXRpYyBzdHJ1Y3QgZmJfZGVmZXJyZWRfaW8gZHJtX2Zi ZGV2X2RlZmlvID0gewogICogQGZiX2hlbHBlcjogZmJkZXYgaGVscGVyIHN0cnVjdHVyZQogICog QHNpemVzOiBkZXNjcmliZXMgZmJkZXYgc2l6ZSBhbmQgc2Nhbm91dCBzdXJmYWNlIHNpemUKICAq Ci0gKiBUaGlzIGZ1bmN0aW9uIHVzZXMgdGhlIGNsaWVudCBBUEkgdG8gY3JhdGUgYSBmcmFtZWJ1 ZmZlciBiYWNrZWQgYnkgYSBkdW1iIGJ1ZmZlci4KKyAqIFRoaXMgZnVuY3Rpb24gdXNlcyB0aGUg Y2xpZW50IEFQSSB0byBjcmVhdGUgYSBmcmFtZWJ1ZmZlciBiYWNrZWQgYnkgYSBkdW1iIGJ1ZmZl ci4KICAqCiAgKiBUaGUgX3N5c18gdmVyc2lvbnMgYXJlIHVzZWQgZm9yICZmYl9vcHMuZmJfcmVh ZCwgZmJfd3JpdGUsIGZiX2ZpbGxyZWN0LAogICogZmJfY29weWFyZWEsIGZiX2ltYWdlYmxpdC4K QEAgLTMxNjUsOCArMzE2NywxMCBAQCBzdGF0aWMgaW50IGRybV9mYmRldl9jbGllbnRfaG90cGx1 ZyhzdHJ1Y3QgZHJtX2NsaWVudF9kZXYgKmNsaWVudCkKIAlpZiAoZGV2LT5mYl9oZWxwZXIpCiAJ CXJldHVybiBkcm1fZmJfaGVscGVyX2hvdHBsdWdfZXZlbnQoZGV2LT5mYl9oZWxwZXIpOwogCi0J aWYgKCFkZXYtPm1vZGVfY29uZmlnLm51bV9jb25uZWN0b3IpCisJaWYgKCFkZXYtPm1vZGVfY29u ZmlnLm51bV9jb25uZWN0b3IpIHsKKwkJRFJNX0RFVl9ERUJVRyhkZXYtPmRldiwgIk5vIGNvbm5l Y3RvcnMgZm91bmQsIHdpbGwgbm90IGNyZWF0ZSBmcmFtZWJ1ZmZlciFcbiIpOwogCQlyZXR1cm4g MDsKKwl9CiAKIAlyZXQgPSBkcm1fZmJfaGVscGVyX2ZiZGV2X3NldHVwKGRldiwgZmJfaGVscGVy LCAmZHJtX2ZiX2hlbHBlcl9nZW5lcmljX2Z1bmNzLAogCQkJCQlmYl9oZWxwZXItPnByZWZlcnJl ZF9icHAsIDApOwpAQCAtMzE4NywxMyArMzE5MSwxNSBAQCBzdGF0aWMgY29uc3Qgc3RydWN0IGRy bV9jbGllbnRfZnVuY3MgZHJtX2ZiZGV2X2NsaWVudF9mdW5jcyA9IHsKIH07CiAKIC8qKgotICog ZHJtX2ZiX2hlbHBlcl9nZW5lcmljX2ZiZGV2X3NldHVwKCkgLSBTZXR1cCBnZW5lcmljIGZiZGV2 IGVtdWxhdGlvbgorICogZHJtX2ZiZGV2X2dlbmVyaWNfc2V0dXAoKSAtIFNldHVwIGdlbmVyaWMg ZmJkZXYgZW11bGF0aW9uCiAgKiBAZGV2OiBEUk0gZGV2aWNlCiAgKiBAcHJlZmVycmVkX2JwcDog UHJlZmVycmVkIGJpdHMgcGVyIHBpeGVsIGZvciB0aGUgZGV2aWNlLgogICogICAgICAgICAgICAg ICAgIEBkZXYtPm1vZGVfY29uZmlnLnByZWZlcnJlZF9kZXB0aCBpcyB1c2VkIGlmIHRoaXMgaXMg emVyby4KICAqCiAgKiBUaGlzIGZ1bmN0aW9uIHNldHMgdXAgZ2VuZXJpYyBmYmRldiBlbXVsYXRp b24gZm9yIGRyaXZlcnMgdGhhdCBzdXBwb3J0cwotICogZHVtYiBidWZmZXJzIHdpdGggYSB2aXJ0 dWFsIGFkZHJlc3MgYW5kIHRoYXQgY2FuIGJlIG1tYXAnZWQuCisgKiBkdW1iIGJ1ZmZlcnMgd2l0 aCBhIHZpcnR1YWwgYWRkcmVzcyBhbmQgdGhhdCBjYW4gYmUgbW1hcCdlZC4gSWYgdGhlIGRyaXZl cgorICogZG9lcyBub3Qgc3VwcG9ydCB0aGVzZSBmdW5jdGlvbnMsIGl0IGNvdWxkIHVzZSBkcm1f ZmJfaGVscGVyX2ZiZGV2X3NldHVwKCkuCisgKiBUaGlzIGZ1bmN0aW9uIGNhbiBvbmx5IGJlIHVz ZWQgd2l0aCBkZXZpY2VzIGNyZWF0ZWQgdXNpbmcgZHJtX2Rldl9yZWdpc3RlcigpLgogICoKICAq IFJlc3RvcmUsIGhvdHBsdWcgZXZlbnRzIGFuZCB0ZWFyZG93biBhcmUgYWxsIHRha2VuIGNhcmUg b2YuIERyaXZlcnMgdGhhdCBkbwogICogc3VzcGVuZC9yZXN1bWUgbmVlZCB0byBjYWxsIGRybV9m Yl9oZWxwZXJfc2V0X3N1c3BlbmRfdW5sb2NrZWQoKSB0aGVtc2VsdmVzLgpAQCAtMzIwNiw2ICsz MjEyLDggQEAgc3RhdGljIGNvbnN0IHN0cnVjdCBkcm1fY2xpZW50X2Z1bmNzIGRybV9mYmRldl9j bGllbnRfZnVuY3MgPSB7CiAgKiBUaGlzIGZ1bmN0aW9uIGlzIHNhZmUgdG8gY2FsbCBldmVuIHdo ZW4gdGhlcmUgYXJlIG5vIGNvbm5lY3RvcnMgcHJlc2VudC4KICAqIFNldHVwIHdpbGwgYmUgcmV0 cmllZCBvbiB0aGUgbmV4dCBob3RwbHVnIGV2ZW50LgogICoKKyAqIFRoZSBmYmRldiBpcyBkZXN0 cm95ZWQgYnkgZHJtX2Rldl91bnJlZ2lzdGVyKCkuCisgKgogICogUmV0dXJuczoKICAqIFplcm8g b24gc3VjY2VzcyBvciBuZWdhdGl2ZSBlcnJvciBjb2RlIG9uIGZhaWx1cmUuCiAgKi8KQEAgLTMy MTQsNiArMzIyMiw4IEBAIGludCBkcm1fZmJkZXZfZ2VuZXJpY19zZXR1cChzdHJ1Y3QgZHJtX2Rl dmljZSAqZGV2LCB1bnNpZ25lZCBpbnQgcHJlZmVycmVkX2JwcCkKIAlzdHJ1Y3QgZHJtX2ZiX2hl bHBlciAqZmJfaGVscGVyOwogCWludCByZXQ7CiAKKwlXQVJOKGRldi0+ZmJfaGVscGVyLCAiZmJf aGVscGVyIGlzIGFscmVhZHkgc2V0IVxuIik7CisKIAlpZiAoIWRybV9mYmRldl9lbXVsYXRpb24p CiAJCXJldHVybiAwOwogCkBAIC0zMjI0LDEyICszMjM0LDE1IEBAIGludCBkcm1fZmJkZXZfZ2Vu ZXJpY19zZXR1cChzdHJ1Y3QgZHJtX2RldmljZSAqZGV2LCB1bnNpZ25lZCBpbnQgcHJlZmVycmVk X2JwcCkKIAlyZXQgPSBkcm1fY2xpZW50X25ldyhkZXYsICZmYl9oZWxwZXItPmNsaWVudCwgImZi ZGV2IiwgJmRybV9mYmRldl9jbGllbnRfZnVuY3MpOwogCWlmIChyZXQpIHsKIAkJa2ZyZWUoZmJf aGVscGVyKTsKKwkJRFJNX0RFVl9FUlJPUihkZXYtPmRldiwgIkZhaWxlZCB0byByZWdpc3RlciBj bGllbnQ6ICVkXG4iLCByZXQpOwogCQlyZXR1cm4gcmV0OwogCX0KIAogCWZiX2hlbHBlci0+cHJl ZmVycmVkX2JwcCA9IHByZWZlcnJlZF9icHA7CiAKLQlkcm1fZmJkZXZfY2xpZW50X2hvdHBsdWco JmZiX2hlbHBlci0+Y2xpZW50KTsKKwlyZXQgPSBkcm1fZmJkZXZfY2xpZW50X2hvdHBsdWcoJmZi X2hlbHBlci0+Y2xpZW50KTsKKwlpZiAocmV0KQorCQlEUk1fREVWX0RFQlVHKGRldi0+ZGV2LCAi Y2xpZW50IGhvdHBsdWcgcmV0PSVkXG4iLCByZXQpOwogCiAJcmV0dXJuIDA7CiB9Ci0tIAoyLjE4 LjAKCl9fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fCmRyaS1k ZXZlbCBtYWlsaW5nIGxpc3QKZHJpLWRldmVsQGxpc3RzLmZyZWVkZXNrdG9wLm9yZwpodHRwczov L2xpc3RzLmZyZWVkZXNrdG9wLm9yZy9tYWlsbWFuL2xpc3RpbmZvL2RyaS1kZXZlbAo= From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id AFE3FC4321E for ; Thu, 6 Sep 2018 22:18:43 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 68189206BA for ; Thu, 6 Sep 2018 22:18:43 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lekensteyn.nl header.i=@lekensteyn.nl header.b="yPKsMqIB" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 68189206BA Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=lekensteyn.nl Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728344AbeIGCzy (ORCPT ); Thu, 6 Sep 2018 22:55:54 -0400 Received: from lekensteyn.nl ([178.21.112.251]:47253 "EHLO lekensteyn.nl" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728170AbeIGCzx (ORCPT ); Thu, 6 Sep 2018 22:55:53 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lekensteyn.nl; s=s2048-2015-q1; h=Content-Transfer-Encoding:Content-Type:MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From; bh=1aZbXxiFoDDSHnKHZSWLhkTST3t+hkEUs5imDri/IRQ=; b=yPKsMqIB8CFC0VC+7VPUVvNu8ofFefpDWx3DXBvBrVtVdr3H0O4GK3UFmLc7GzyfIio5HbmkhqI2eJoRmR8eF4FjdP36QnrXmrn5D/apb//ZqAtzjmnY3UERpYzEYVGesII/MY7Rhz59KFwGJ7ya1kvkFCcurFS/xVdjj8iKCPGJiaVG2vuxbX94mkOdGG+7zv9d/f/F+v8XnCNc7u7m0XFhUqUsXc5coSWWOpnwtGOpK9R8a72T1/AswUgli0ICdApiNAWWHEK9El46wxQ+yizqH+iaUq4UnFgzBR5Rv9SF4bp2ZY/1Hav4EFQCwDkBdPTt6sNzUOlruxbDN2L4FA==; Received: by lekensteyn.nl with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1fy2bO-0005Us-IX; Fri, 07 Sep 2018 00:18:15 +0200 From: Peter Wu To: Gerd Hoffmann Cc: =?UTF-8?q?Noralf=20Tr=C3=B8nnes?= , dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 4/4] drm/fb-helper: improve documentation and print warnings Date: Fri, 7 Sep 2018 00:18:10 +0200 Message-Id: <20180906221810.20170-5-peter@lekensteyn.nl> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20180906221810.20170-1-peter@lekensteyn.nl> References: <20180906221810.20170-1-peter@lekensteyn.nl> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Clarify the relation between drm_fb_helper_fbdev_setup/teardown. Clarify requirements for the new generic fbdev emulation API and log some more details in case the driver does something wrong. Fix related typos. Cc: Noralf Trønnes Signed-off-by: Peter Wu --- drivers/gpu/drm/drm_fb_helper.c | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/drivers/gpu/drm/drm_fb_helper.c b/drivers/gpu/drm/drm_fb_helper.c index 4b0dd20bccb8..7f92ff173986 100644 --- a/drivers/gpu/drm/drm_fb_helper.c +++ b/drivers/gpu/drm/drm_fb_helper.c @@ -2821,7 +2821,9 @@ EXPORT_SYMBOL(drm_fb_helper_hotplug_event); * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback * function. * - * See also: drm_fb_helper_initial_config() + * Use drm_fb_helper_fbdev_teardown() to destroy the fbdev. + * + * See also: drm_fb_helper_initial_config(), drm_fbdev_generic_setup(). * * Returns: * Zero on success or negative error code on failure. @@ -3037,7 +3039,7 @@ static struct fb_deferred_io drm_fbdev_defio = { * @fb_helper: fbdev helper structure * @sizes: describes fbdev size and scanout surface size * - * This function uses the client API to crate a framebuffer backed by a dumb buffer. + * This function uses the client API to create a framebuffer backed by a dumb buffer. * * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect, * fb_copyarea, fb_imageblit. @@ -3165,8 +3167,10 @@ static int drm_fbdev_client_hotplug(struct drm_client_dev *client) if (dev->fb_helper) return drm_fb_helper_hotplug_event(dev->fb_helper); - if (!dev->mode_config.num_connector) + if (!dev->mode_config.num_connector) { + DRM_DEV_DEBUG(dev->dev, "No connectors found, will not create framebuffer!\n"); return 0; + } ret = drm_fb_helper_fbdev_setup(dev, fb_helper, &drm_fb_helper_generic_funcs, fb_helper->preferred_bpp, 0); @@ -3187,13 +3191,15 @@ static const struct drm_client_funcs drm_fbdev_client_funcs = { }; /** - * drm_fb_helper_generic_fbdev_setup() - Setup generic fbdev emulation + * drm_fbdev_generic_setup() - Setup generic fbdev emulation * @dev: DRM device * @preferred_bpp: Preferred bits per pixel for the device. * @dev->mode_config.preferred_depth is used if this is zero. * * This function sets up generic fbdev emulation for drivers that supports - * dumb buffers with a virtual address and that can be mmap'ed. + * dumb buffers with a virtual address and that can be mmap'ed. If the driver + * does not support these functions, it could use drm_fb_helper_fbdev_setup(). + * This function can only be used with devices created using drm_dev_register(). * * Restore, hotplug events and teardown are all taken care of. Drivers that do * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves. @@ -3206,6 +3212,8 @@ static const struct drm_client_funcs drm_fbdev_client_funcs = { * This function is safe to call even when there are no connectors present. * Setup will be retried on the next hotplug event. * + * The fbdev is destroyed by drm_dev_unregister(). + * * Returns: * Zero on success or negative error code on failure. */ @@ -3214,6 +3222,8 @@ int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp) struct drm_fb_helper *fb_helper; int ret; + WARN(dev->fb_helper, "fb_helper is already set!\n"); + if (!drm_fbdev_emulation) return 0; @@ -3224,12 +3234,15 @@ int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp) ret = drm_client_new(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs); if (ret) { kfree(fb_helper); + DRM_DEV_ERROR(dev->dev, "Failed to register client: %d\n", ret); return ret; } fb_helper->preferred_bpp = preferred_bpp; - drm_fbdev_client_hotplug(&fb_helper->client); + ret = drm_fbdev_client_hotplug(&fb_helper->client); + if (ret) + DRM_DEV_DEBUG(dev->dev, "client hotplug ret=%d\n", ret); return 0; } -- 2.18.0