From patchwork Wed Oct 31 09:11:50 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 1676901 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 425E1DF2F6 for ; Wed, 31 Oct 2012 09:24:55 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 0E026A0ACC for ; Wed, 31 Oct 2012 02:24:55 -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 BB459A0212 for ; Wed, 31 Oct 2012 02:20:23 -0700 (PDT) Received: by mail-ee0-f49.google.com with SMTP id c1so618182eek.36 for ; Wed, 31 Oct 2012 02:20:23 -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=iID5lisAlGmYpYzXRfdIDHRb9wFPMXwgaXkbu5Sy6DY=; b=ZLQw36Z78BOEmp2+lnFjd8h2ipHiTd5jJJO03kBwSt1nUZLWdGNJVR3jUJ8YciouFZ eGDAj600fXA5Lnb5I8hznjnXLctwOt5V/PqrLUcS8ih/MGx6f1CMs5TIBzGVoDwxkl+R zY9UgV8rSxsOixNxzkHCUs6sJXGipic/OEvNE= 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=iID5lisAlGmYpYzXRfdIDHRb9wFPMXwgaXkbu5Sy6DY=; b=fZEuZzRZQ3uAiy7P4paaxt+b1Fkeoy4z6E3zgyDEN+AhzDVbwtcxY2AWmjDjLywgpb ahEyl7a60H5zd473QyFWoQ/aSDTysWtpGfAr85sq+N/i/gl1w28aJVPcvC7o3qtO2JJP 6B7x5WIkoDYBH5JQl2NuixL7g25os7uCmYuPILMJWwi54LtYaw13gJtinT4qk8m+lqFq G4WIqCZuaoTuISsuoDo3i5oRBiiT+uMQ6AsrQI4AnFeqKU2bpDPbmZlo6dHGt1AiYnX9 r2lnslXDDAV/89UrDgvi/ZgdwoWD+B3YowFvTSj2m9pN9Pv+qZtz2y4lz/HS24O1kQyB xUIw== Received: by 10.14.225.71 with SMTP id y47mr68869900eep.0.1351675223509; Wed, 31 Oct 2012 02:20:23 -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 f3sm6784078eeo.13.2012.10.31.02.20.22 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 31 Oct 2012 02:20:23 -0700 (PDT) From: Daniel Vetter To: DRI Development Subject: [PATCH 4/4] drm/doc: add new dp helpers into drm DocBook Date: Wed, 31 Oct 2012 10:11:50 +0100 Message-Id: <1351674710-11629-4-git-send-email-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 1.7.11.7 In-Reply-To: <1351674710-11629-1-git-send-email-daniel.vetter@ffwll.ch> References: <3853113.57kDjBA5be@avalon> <1351674710-11629-1-git-send-email-daniel.vetter@ffwll.ch> X-Gm-Message-State: ALoCoQnDqjGbhdwrONPcWvbSQ0gbX1KVSbWw6jaPzCSshRDdyCZRCw9bx/jmKqEdejnMMQXASrYk Cc: Daniel Vetter , Intel Graphics Development , Laurent Pinchart 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. Signed-off-by: Daniel Vetter --- Documentation/DocBook/drm.tmpl | 6 ++++++ drivers/gpu/drm/drm_dp_helper.c | 20 ++++++++++++++++++++ include/drm/drm_dp_helper.h | 7 +++++++ 3 files changed, 33 insertions(+) diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 15729eb..71edb57 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..2ff6482 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 come 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,17 @@ i2c_dp_aux_prepare_bus(struct i2c_adapter *adapter) return 0; } +/** + * i2c_dp_aux_add_bus() - register a i2c adaptar 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 + * which will be used by the the i2c over dp aux algo. + * + * 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..3f94ede 100644 --- a/include/drm/drm_dp_helper.h +++ b/include/drm/drm_dp_helper.h @@ -312,6 +312,13 @@ #define MODE_I2C_READ 4 #define MODE_I2C_STOP 8 +/** + * struct i2c_algo_dp_aux_data - driver interface structure for i2c over dp aux algo + * @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;