From patchwork Thu Nov 1 13:45:18 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 1685111 Return-Path: X-Original-To: patchwork-dri-devel@patchwork.kernel.org Delivered-To: patchwork-process-083081@patchwork2.kernel.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by patchwork2.kernel.org (Postfix) with ESMTP id 485A8DFE75 for ; Thu, 1 Nov 2012 13:56:29 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 486C9A0DE7 for ; Thu, 1 Nov 2012 06:56:29 -0700 (PDT) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-ee0-f49.google.com (mail-ee0-f49.google.com [74.125.83.49]) by gabe.freedesktop.org (Postfix) with ESMTP id C75779E7D1 for ; Thu, 1 Nov 2012 06:53:52 -0700 (PDT) Received: by mail-ee0-f49.google.com with SMTP id c1so1312456eek.36 for ; Thu, 01 Nov 2012 06:53:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=+AS4RybyUVqzKQSrE0cE40SuEOM5dfXoJSxiWfw2SRY=; b=ZYOcIRHcQesRRYwnPp2wWq3d3nEx6kkIgPLrWxYtyx3uaj6/fDuA3Tz/tA9QXbXD+D hX9shoDWoApzfEG17wV04Kem53M2BwUP9LQf6XdaMNs4RHBj8F7bE7cu0EJnoB/TQe2G Qsd5kcPOTASfh1BWM4GjO9FJA3Ed+ntGC9CKQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references :x-gm-message-state; bh=+AS4RybyUVqzKQSrE0cE40SuEOM5dfXoJSxiWfw2SRY=; b=JpQ5jhUOxtFkM9QWIfysYQj8zwiNoCNo4kkXqz3CjFQneMscQWGmoHgEjsEYA4NT/7 XXeKDJ6uyj+DYpHtTUX5+cUTHTtzw2HbgRsGJud/lpozgxz2CvaE7iEhXZSRwpPGxc+0 2l5vzDM7ZTKS74m6T8U/gYayDfBnQVjDZB+OvRAF4VQzQ05ChHcr7cGM6QpLzDVYFU48 ZHUdntBh0qbQWen5wi7wZNVpkQvPRQTV/8IHOg96CfyTRed5e8sMu5Sq9YRJFn7cDQMS huDFijWr1BRzyT9bdMw9pYDnXrOetRsiHNJ1s6PISSl4Y5i1isdqXMcrLe48MOPAky58 eJfQ== Received: by 10.14.0.198 with SMTP id 46mr98314964eeb.21.1351778032363; Thu, 01 Nov 2012 06:53:52 -0700 (PDT) Received: from wespe.ffwll.local (178-83-130-250.dynamic.hispeed.ch. [178.83.130.250]) by mx.google.com with ESMTPS id k2sm14775358eep.15.2012.11.01.06.53.51 (version=TLSv1/SSLv3 cipher=OTHER); Thu, 01 Nov 2012 06:53:51 -0700 (PDT) From: Daniel Vetter To: Dave Airlie Subject: [PATCH 4/4] drm/doc: add new dp helpers into drm DocBook Date: Thu, 1 Nov 2012 14:45:18 +0100 Message-Id: <1351777518-11212-4-git-send-email-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 1.7.11.7 In-Reply-To: <1351777518-11212-1-git-send-email-daniel.vetter@ffwll.ch> References: <1351777518-11212-1-git-send-email-daniel.vetter@ffwll.ch> X-Gm-Message-State: ALoCoQkxkt3jAMju/W/PzDoUB1jysVvyuDWBKC4OHCKc2B4dcm8/HUv3Ps3qWI6AsqZTeobBfK4Q Cc: Daniel Vetter , DRI Development X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: dri-devel-bounces+patchwork-dri-devel=patchwork.kernel.org@lists.freedesktop.org Errors-To: dri-devel-bounces+patchwork-dri-devel=patchwork.kernel.org@lists.freedesktop.org I didn't bother with documenting the really trivial new "extract something from dpcd" helpers, but the i2c over aux ch is now documented a bit. v2: Clarify the comment for i2c_dp_aux_add_bus a bit. v3: Fix more spelling fail spotted by Laurent Pinchart. Acked-by: Laurent Pinchart Signed-off-by: Daniel Vetter --- Documentation/DocBook/drm.tmpl | 6 ++++++ drivers/gpu/drm/drm_dp_helper.c | 21 +++++++++++++++++++++ include/drm/drm_dp_helper.h | 8 ++++++++ 3 files changed, 35 insertions(+) diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index fadc48b..6948bad 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl @@ -2115,6 +2115,12 @@ void intel_crt_init(struct drm_device *dev) !Pdrivers/gpu/drm/drm_fb_helper.c fbdev helpers !Edrivers/gpu/drm/drm_fb_helper.c + + Display Port Helper Functions Reference +!Pdrivers/gpu/drm/drm_dp_helper.c dp helpers +!Iinclude/drm/drm_dp_helper.h +!Edrivers/gpu/drm/drm_dp_helper.c + diff --git a/drivers/gpu/drm/drm_dp_helper.c b/drivers/gpu/drm/drm_dp_helper.c index 3c4cccd..89e1966 100644 --- a/drivers/gpu/drm/drm_dp_helper.c +++ b/drivers/gpu/drm/drm_dp_helper.c @@ -30,6 +30,15 @@ #include #include +/** + * DOC: dp helpers + * + * These functions contain some common logic and helpers at various abstraction + * levels to deal with Display Port sink devices and related things like DP aux + * channel transfers, EDID reading over DP aux channels, decoding certain DPCD + * blocks, ... + */ + /* Run a single AUX_CH I2C transaction, writing/reading data as necessary */ static int i2c_algo_dp_aux_transaction(struct i2c_adapter *adapter, int mode, @@ -193,6 +202,18 @@ i2c_dp_aux_prepare_bus(struct i2c_adapter *adapter) return 0; } +/** + * i2c_dp_aux_add_bus() - register an i2c adapter using the aux ch helper + * @adapter: i2c adapter to register + * + * This registers an i2c adapater that uses dp aux channel as it's underlaying + * transport. The driver needs to fill out the &i2c_algo_dp_aux_data structure + * and store it in the algo_data member of the @adapter argument. This will be + * used by the i2c over dp aux algorithm to drive the hardware. + * + * RETURNS: + * 0 on success, -ERRNO on failure. + */ int i2c_dp_aux_add_bus(struct i2c_adapter *adapter) { diff --git a/include/drm/drm_dp_helper.h b/include/drm/drm_dp_helper.h index c09d367..e8e1417 100644 --- a/include/drm/drm_dp_helper.h +++ b/include/drm/drm_dp_helper.h @@ -312,6 +312,14 @@ #define MODE_I2C_READ 4 #define MODE_I2C_STOP 8 +/** + * struct i2c_algo_dp_aux_data - driver interface structure for i2c over dp + * aux algorithm + * @running: set by the algo indicating whether an i2c is ongoing or whether + * the i2c bus is quiescent + * @address: i2c target address for the currently ongoing transfer + * @aux_ch: driver callback to transfer a single byte of the i2c payload + */ struct i2c_algo_dp_aux_data { bool running; u16 address;