From mboxrd@z Thu Jan 1 00:00:00 1970 From: Daniel Vetter Subject: Re: [PATCH 18/18] drm/i915/audio: add DOC comment describing HDA over HDMI/DP Date: Fri, 3 Oct 2014 18:22:09 +0200 Message-ID: <20141003162209.GH16117@phenom.ffwll.local> References: <5666d9107be4b2b29306e0d67573a50e4d064daa.1412339886.git.jani.nikula@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: Received: from mail-wi0-f175.google.com (mail-wi0-f175.google.com [209.85.212.175]) by gabe.freedesktop.org (Postfix) with ESMTP id 7A4AB6E176 for ; Fri, 3 Oct 2014 09:22:13 -0700 (PDT) Received: by mail-wi0-f175.google.com with SMTP id d1so7720130wiv.14 for ; Fri, 03 Oct 2014 09:22:12 -0700 (PDT) Content-Disposition: inline In-Reply-To: <5666d9107be4b2b29306e0d67573a50e4d064daa.1412339886.git.jani.nikula@intel.com> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" To: Jani Nikula Cc: intel-gfx@lists.freedesktop.org, shuang.he@linux.intel.com List-Id: intel-gfx@lists.freedesktop.org On Fri, Oct 03, 2014 at 03:44:01PM +0300, Jani Nikula wrote: > Signed-off-by: Jani Nikula > --- > drivers/gpu/drm/i915/intel_audio.c | 21 +++++++++++++++++++++ > 1 file changed, 21 insertions(+) > > diff --git a/drivers/gpu/drm/i915/intel_audio.c b/drivers/gpu/drm/i915/intel_audio.c > index 58de48ff3585..6d1f8438dc4d 100644 > --- a/drivers/gpu/drm/i915/intel_audio.c > +++ b/drivers/gpu/drm/i915/intel_audio.c > @@ -28,6 +28,27 @@ > #include "intel_drv.h" > #include "i915_drv.h" > > +/** > + * DOC: High Definition Audio over HDMI and Display Port > + * > + * The graphics and audio drivers together support High Definition Audio over > + * HDMI and Display Port. The audio programming sequences are divided into audio > + * codec and controller enable and disable sequences. The graphics driver > + * handles the audio codec sequences, while the audio driver handles the audio > + * controller sequences. > + * > + * The disable sequences must be performed before disabling the transcoder or > + * port. The enable sequences may only be performed after enabling the > + * transcoder and port, and after completed link training. > + * > + * The codec and controller sequences could be done either parallel or serial, > + * but generally the ELDV/PD change in the codec sequence indicates to the audio > + * driver that the controller sequence should start. Indeed, most of the > + * co-operation between the graphics and audio drivers is handled via audio > + * related registers. (The notable exception is the power management, not > + * covered here.) > + */ Generally when documenting a new file I also document all the non-static functions exported to the driver. But I guess this can wait until the functional/interface changes are merged. Also, this should get pulled into the drm/i915 docbook in a new chapter in the modeset section. Otherwise I like the series, at least from a very high-level read-through. Please sign someone up for review. -Daniel > + > static const struct { > int clock; > u32 config; > -- > 1.9.1 > > _______________________________________________ > Intel-gfx mailing list > Intel-gfx@lists.freedesktop.org > http://lists.freedesktop.org/mailman/listinfo/intel-gfx -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch