From patchwork Thu Sep 3 11:24:45 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Henningsson X-Patchwork-Id: 7116161 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id BBC659F36E for ; Thu, 3 Sep 2015 11:24:50 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id E6D6A20818 for ; Thu, 3 Sep 2015 11:24:49 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id EC8A920820 for ; Thu, 3 Sep 2015 11:24:48 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 56ED16E903; Thu, 3 Sep 2015 04:24:48 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from youngberry.canonical.com (youngberry.canonical.com [91.189.89.112]) by gabe.freedesktop.org (Postfix) with ESMTPS id A627B6E903 for ; Thu, 3 Sep 2015 04:24:47 -0700 (PDT) Received: from c83-254-154-239.bredband.comhem.se ([83.254.154.239] helo=localhost.localdomain) by youngberry.canonical.com with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.76) (envelope-from ) id 1ZXSdH-0004cS-NF; Thu, 03 Sep 2015 11:24:43 +0000 From: David Henningsson To: intel-gfx@lists.freedesktop.org, alsa-devel@alsa-project.org, tiwai@suse.de, daniel@ffwll.ch, libin.yang@intel.com, jani.nikula@linux.intel.com Date: Thu, 3 Sep 2015 13:24:45 +0200 Message-Id: <1441279485-328-1-git-send-email-david.henningsson@canonical.com> X-Mailer: git-send-email 1.9.1 Cc: David Henningsson Subject: [Intel-gfx] [PATCH] drm/i915: Improve kernel-doc for i915_audio_component struct X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP To make kernel-doc happy, the i915_audio_component_audio_ops struct cannot be nested. Signed-off-by: David Henningsson --- Note that I didn't do the same un-nesting for i915_audio_component_ops. This is to make it easier to merge the pending sync_audio_rate patch set. It applies on top of my just sent patches so should probably be taken through Takashi's tree. Documentation/DocBook/drm.tmpl | 1 + include/drm/i915_component.h | 33 +++++++++++++++++++++++---------- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 2fb9a54..7554679 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl @@ -4048,6 +4048,7 @@ int num_ioctls; High Definition Audio !Pdrivers/gpu/drm/i915/intel_audio.c High Definition Audio over HDMI and Display Port !Idrivers/gpu/drm/i915/intel_audio.c +!Iinclude/drm/i915_component.h Panel Self Refresh PSR (PSR/SRD) diff --git a/include/drm/i915_component.h b/include/drm/i915_component.h index b2d56dd..89d6362 100644 --- a/include/drm/i915_component.h +++ b/include/drm/i915_component.h @@ -24,6 +24,28 @@ #ifndef _I915_COMPONENT_H_ #define _I915_COMPONENT_H_ +/** + * struct i915_audio_component_audio_ops - i915 directly calling hda driver + * + * @audio_ptr: Pointer to pass when calling pin_eld_notify. + * @pin_eld_notify: Called from i915 driver, notifying the HDA driver that + * pin sense and/or ELD information has changed. + * + * These functions are implemented by hda driver and called by the i915 + * driver. + */ +struct i915_audio_component_audio_ops { + void *audio_ptr; + void (*pin_eld_notify)(void *audio_ptr, int port); +}; + +/** + * struct i915_audio_component - Used for direct communication between i915 and hda drivers + * + * @dev: i915 device, used as parameter for ops + * @ops: Ops implemented by i915 driver, called by hda driver + * @audio_ops: Ops implemented by hda driver, called by i915 driver + */ struct i915_audio_component { struct device *dev; @@ -35,16 +57,7 @@ struct i915_audio_component { int (*get_cdclk_freq)(struct device *); } *ops; - const struct i915_audio_component_audio_ops { - void *audio_ptr; - /** - * Call from i915 driver, notifying the HDA driver that - * pin sense and/or ELD information has changed. - * @audio_ptr: HDA driver object - * @port: Which port has changed (PORTA / PORTB / PORTC etc) - */ - void (*pin_eld_notify)(void *audio_ptr, int port); - } *audio_ops; + const struct i915_audio_component_audio_ops *audio_ops; }; #endif /* _I915_COMPONENT_H_ */