From: Libin Yang <libin.y...@intel.com>

Add the kerneldoc for i915_audio_component in i915_component.h

Signed-off-by: Libin Yang <libin.y...@intel.com>
---
 include/drm/i915_component.h | 39 ++++++++++++++++++++++++---------------
 1 file changed, 24 insertions(+), 15 deletions(-)

diff --git a/include/drm/i915_component.h b/include/drm/i915_component.h
index 8ad6f1b..187acc8 100644
--- a/include/drm/i915_component.h
+++ b/include/drm/i915_component.h
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx driver
+ * @owner: the module owner
+ * @get_power: get the POWER_DOMAIN_AUDIO power well
+ * @put_power: put the POWER_DOMAIN_AUDIO power well
+ * @codec_wake_override: Enable/Disable generating the codec wake signal
+ * @get_cdclk_freq: get the Core Display Clock in KHz
+ * @sync_audio_rate: set n/cts based on the sample rate
+ */
+struct i915_audio_component_ops {
+       struct module *owner;
+       void (*get_power)(struct device *);
+       void (*put_power)(struct device *);
+       void (*codec_wake_override)(struct device *, bool enable);
+       int (*get_cdclk_freq)(struct device *);
+       int (*sync_audio_rate)(struct device *, int port, int rate);
+};
+
+/**
+ * struct i915_audio_component - used for audio video interaction
+ * @dev: the device from gfx driver
+ * @ops: callback for audio driver calling
+ */
 struct i915_audio_component {
        struct device *dev;
-
-       const struct i915_audio_component_ops {
-               struct module *owner;
-               void (*get_power)(struct device *);
-               void (*put_power)(struct device *);
-               void (*codec_wake_override)(struct device *, bool enable);
-               int (*get_cdclk_freq)(struct device *);
-               /**
-                * @sync_audio_rate: set n/cts based on the sample rate
-                *
-                * Called from audio driver. After audio driver sets the
-                * sample rate, it will call this function to set n/cts
-                */
-               int (*sync_audio_rate)(struct device *, int port, int rate);
-       } *ops;
+       const struct i915_audio_component_ops *ops;
 };
 
 #endif /* _I915_COMPONENT_H_ */
-- 
1.9.1

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/intel-gfx

Reply via email to