Skip to contentSkip to conversation

drm/i915: add kerneldoc for i915_audio_component

PATCH In review [email protected] 4 participants 8 messages Sep 2, 2015 – Sep 9, 2015 DRM drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/i915: add kerneldoc for i915_audio_component

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in i915_component.h

---
 include/drm/i915_component.h | 39 ++++++++++++++++++++++++---------------
 1 file changed, 24 insertions(+), 15 deletions(-)
include/drm/i915_component.h +24 -15
index 8ad6f1b..187acc8 100644
@@ -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_ */
Signature · 6 lines
1.9.1

_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
#1 lore raw
Quoted 18 lines · On Wed, Sep 02, 2015 at 02:12:24PM +0800, [email protected] wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in i915_component.h

---
 include/drm/i915_component.h | 39 ++++++++++++++++++++++++---------------
 1 file changed, 24 insertions(+), 15 deletions(-)
include/drm/i915_component.h +1 -0
index 8ad6f1b..187acc8 100644
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
+/**

include/drm/i915_component.h line 37

Quoted 10 lines
include/drm/i915_component.h +10 -0
+ * 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;

New kerneldoc in 4.3 allows you to split structure documentation up into per-member comments. Especially with vtables I think this makes a lot of sense, since then you have enough space to document where and how exactly a given hook is called (looks, place in the overall sequence).

Also please include your stancas in the drm.tmpl docbook template, otherwise it won't be included in the html docs. And finally please add a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Thanks, Daniel

Quoted 36 lines
include/drm/i915_component.h +13 -15
+	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_ */
Signature · 1 line
1.9.1
Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
#2 lore raw
Quoted 54 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Wednesday, September 02, 2015 8:18 PM
To: Yang, Libin
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 7 lines · On Wed, Sep 02, 2015 at 02:12:24PM +0800, [email protected] wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in i915_component.h

---
 include/drm/i915_component.h | 39 ++++++++++++++++++++++++--

-------------

Review

Quoted 3 lines
 1 file changed, 24 insertions(+), 15 deletions(-)
(quoted diff) +0 -0

b/include/drm/i915_component.h

include/drm/i915_component.h line 28

Quoted 9 lines

index 8ad6f1b..187acc8 100644

include/drm/i915_component.h +2 -0
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx

driver

include/drm/i915_component.h

Quoted 4 lines
include/drm/i915_component.h +4 -0
+ * @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

include/drm/i915_component.h line 37

Quoted 5 lines
include/drm/i915_component.h +5 -0
+ * @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;

New kerneldoc in 4.3 allows you to split structure documentation up into
per-member comments. Especially with vtables I think this makes a lot of
sense, since then you have enough space to document where and how exactly
a given hook is called (looks, place in the overall sequence).

Quoted 2 lines

Also please include your stancas in the drm.tmpl docbook template, otherwise it won't be included in the html docs. And finally please add

OK, I will add it in drm.tmpl.

Quoted 3 lines

a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Where the DOC should be located in?

Quoted 38 lines

Thanks, Daniel

Quoted 10 lines
include/drm/i915_component.h +10 -0
+	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

include/drm/i915_component.h

Quoted 10 lines
include/drm/i915_component.h +2 -6
+ * @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);

include/drm/i915_component.h

Quoted 3 lines
include/drm/i915_component.h +0 -3
-		int (*get_cdclk_freq)(struct device *);
-		/**
-		 * @sync_audio_rate: set n/cts based on the sample

rate

include/drm/i915_component.h

Quoted 5 lines
include/drm/i915_component.h +0 -5
-		 *
-		 * 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);

Quoted 4 lines
include/drm/i915_component.h +1 -1
-	} *ops;
+	const struct i915_audio_component_ops *ops;
 };
 
Quoted 9 lines
Quoted 4 lines
include/drm/i915_component.h +0 -1
 #endif /* _I915_COMPONENT_H_ */
--

1.9.1

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx

#3 lore raw
Quoted 56 lines · Libin
Quoted 53 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Wednesday, September 02, 2015 8:18 PM
To: Yang, Libin
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 7 lines · On Wed, Sep 02, 2015 at 02:12:24PM +0800, [email protected] wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in i915_component.h

---
 include/drm/i915_component.h | 39 ++++++++++++++++++++++++--

-------------

Review

Quoted 3 lines
 1 file changed, 24 insertions(+), 15 deletions(-)
(quoted diff) +0 -0

b/include/drm/i915_component.h

include/drm/i915_component.h line 28

Quoted 9 lines

index 8ad6f1b..187acc8 100644

include/drm/i915_component.h +2 -0
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx

driver

include/drm/i915_component.h

Quoted 4 lines
include/drm/i915_component.h +4 -0
+ * @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

include/drm/i915_component.h line 37

Quoted 5 lines
include/drm/i915_component.h +5 -0
+ * @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;

New kerneldoc in 4.3 allows you to split structure documentation up into
per-member comments. Especially with vtables I think this makes a lot of
sense, since then you have enough space to document where and how exactly
a given hook is called (looks, place in the overall sequence).

Quoted 2 lines

Also please include your stancas in the drm.tmpl docbook template, otherwise it won't be included in the html docs. And finally please add

Quoted 7 lines

OK, I will add it in drm.tmpl.

Quoted 3 lines

a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Where the DOC should be located in?

i915/intel_audio.c already has a "DOC: High Definition Audio over HDMI and Display Port" comment. IMO you could just amend that, as there's already some references to the audio driver.

BR,
Jani.

Signature · 5 lines
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
#4 lore raw
Quoted 63 lines · Jani Nikula
Quoted 62 lines · Libin
Quoted 53 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Wednesday, September 02, 2015 8:18 PM
To: Yang, Libin
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 7 lines · On Wed, Sep 02, 2015 at 02:12:24PM +0800, [email protected] wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in i915_component.h

---
 include/drm/i915_component.h | 39 ++++++++++++++++++++++++--

-------------

Review

Quoted 3 lines
 1 file changed, 24 insertions(+), 15 deletions(-)
(quoted diff) +0 -0

b/include/drm/i915_component.h

include/drm/i915_component.h line 28

Quoted 9 lines

index 8ad6f1b..187acc8 100644

include/drm/i915_component.h +2 -0
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx

driver

include/drm/i915_component.h

Quoted 4 lines
include/drm/i915_component.h +4 -0
+ * @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

include/drm/i915_component.h line 37

Quoted 5 lines
include/drm/i915_component.h +5 -0
+ * @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;

New kerneldoc in 4.3 allows you to split structure documentation up into
per-member comments. Especially with vtables I think this makes a lot of
sense, since then you have enough space to document where and how exactly
a given hook is called (looks, place in the overall sequence).

Quoted 2 lines

Also please include your stancas in the drm.tmpl docbook template, otherwise it won't be included in the html docs. And finally please add

OK, I will add it in drm.tmpl.

Quoted 3 lines

a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Quoted 5 lines
Quoted 1 line

Where the DOC should be located in?

i915/intel_audio.c already has a "DOC: High Definition Audio over HDMI and Display Port" comment. IMO you could just amend that, as there's already some references to the audio driver.

Yeah I think that would be a perfect place.
-Daniel

Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
#5 lore raw

Hi Daniel,

As Takashi has already accepted the first 3 patches for sync_audio_rate() and the patches are not merged into -nightly branch. If I make a kerneldoc patch based on currently -nightly branch, there will be conflict when you are merging Takashi's branch.

What do you think if I make the kerneldoc patch after the sync_audio_rate() patches are merged into the -nightly branch?

Regards,
Libin

Quoted 89 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Friday, September 04, 2015 3:55 PM
To: Jani Nikula
Cc: Yang, Libin; Daniel Vetter; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 11 lines · Jani Nikula
Quoted 10 lines · Libin
Quoted 10 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Wednesday, September 02, 2015 8:18 PM
To: Yang, Libin
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 1 line
Quoted 1 line
Quoted 1 line

On Wed, Sep 02, 2015 at 02:12:24PM +0800,

[email protected]

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 3 lines · wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in

i915_component.h

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
---
 include/drm/i915_component.h | 39

++++++++++++++++++++++++--

Quoted 12 lines
Quoted 12 lines
Quoted 12 lines

-------------

Review

Quoted 3 lines
 1 file changed, 24 insertions(+), 15 deletions(-)
(quoted diff) +0 -0

b/include/drm/i915_component.h

Quoted 7 lines

index 8ad6f1b..187acc8 100644

include/drm/i915_component.h +0 -0
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

include/drm/i915_component.h line 28

Quoted 2 lines
include/drm/i915_component.h +2 -0
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx

driver

Quoted 4 lines
include/drm/i915_component.h +4 -0
+ * @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

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

wake signal

include/drm/i915_component.h line 37

Quoted 5 lines
include/drm/i915_component.h +5 -0
+ * @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;

New kerneldoc in 4.3 allows you to split structure documentation

up

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

into
per-member comments. Especially with vtables I think this makes

a lot

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

of
sense, since then you have enough space to document where and

how

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

exactly
a given hook is called (looks, place in the overall sequence).

Also please include your stancas in the drm.tmpl docbook

template,

Quoted 1 line
Quoted 1 line
Quoted 1 line

otherwise it won't be included in the html docs. And finally please

add

Quoted 10 lines
Quoted 8 lines

OK, I will add it in drm.tmpl.

Quoted 3 lines

a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Where the DOC should be located in?

i915/intel_audio.c already has a "DOC: High Definition Audio over

HDMI

Quoted 1 line

and Display Port" comment. IMO you could just amend that, as

there's

Quoted 8 lines
Quoted 1 line

already some references to the audio driver.

Yeah I think that would be a perfect place.
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx

#6 lore raw
Quoted 11 lines · Libin

Hi Daniel,

As Takashi has already accepted the first 3 patches for sync_audio_rate() and the patches are not merged into -nightly branch. If I make a kerneldoc patch based on currently -nightly branch, there will be conflict when you are merging Takashi's branch.

What do you think if I make the kerneldoc patch after the sync_audio_rate() patches are merged into the -nightly branch?

Hm, I do pull in sound/for-next into drm-intel-nightly ... Are the patches somewhere else? I can easily add another branch to nightly to make things easier. Takashi, which branches should I all pull in to get all the audio stuff into drm-intel-nightly?

Thanks, Daniel

Quoted 102 lines

Regards,
Libin

Quoted 97 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Friday, September 04, 2015 3:55 PM
To: Jani Nikula
Cc: Yang, Libin; Daniel Vetter; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 11 lines · Jani Nikula
Quoted 10 lines · Libin
Quoted 10 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Wednesday, September 02, 2015 8:18 PM
To: Yang, Libin
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 1 line
Quoted 1 line
Quoted 1 line

On Wed, Sep 02, 2015 at 02:12:24PM +0800,

[email protected]

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 3 lines · wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in

i915_component.h

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
---
 include/drm/i915_component.h | 39

++++++++++++++++++++++++--

Quoted 12 lines
Quoted 12 lines
Quoted 12 lines

-------------

Review

Quoted 3 lines
 1 file changed, 24 insertions(+), 15 deletions(-)
(quoted diff) +0 -0

b/include/drm/i915_component.h

Quoted 7 lines

index 8ad6f1b..187acc8 100644

include/drm/i915_component.h +0 -0
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

include/drm/i915_component.h line 28

Quoted 2 lines
include/drm/i915_component.h +2 -0
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx

driver

Quoted 4 lines
include/drm/i915_component.h +4 -0
+ * @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

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

wake signal

include/drm/i915_component.h line 37

Quoted 5 lines
include/drm/i915_component.h +5 -0
+ * @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;

New kerneldoc in 4.3 allows you to split structure documentation

up

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

into
per-member comments. Especially with vtables I think this makes

a lot

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

of
sense, since then you have enough space to document where and

how

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

exactly
a given hook is called (looks, place in the overall sequence).

Also please include your stancas in the drm.tmpl docbook

template,

Quoted 1 line
Quoted 1 line
Quoted 1 line

otherwise it won't be included in the html docs. And finally please

add

Quoted 10 lines
Quoted 8 lines

OK, I will add it in drm.tmpl.

Quoted 3 lines

a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Where the DOC should be located in?

i915/intel_audio.c already has a "DOC: High Definition Audio over

HDMI

Quoted 1 line

and Display Port" comment. IMO you could just amend that, as

there's

Quoted 1 line

already some references to the audio driver.

Yeah I think that would be a perfect place.
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
#7 lore raw
Quoted 10 lines · Daniel Vetter
Quoted 8 lines · Libin

Hi Daniel,

As Takashi has already accepted the first 3 patches for sync_audio_rate() and the patches are not merged into -nightly branch. If I make a kerneldoc patch based on currently -nightly branch, there will be conflict when you are merging Takashi's branch.

Quoted 8 lines
Quoted 3 lines

What do you think if I make the kerneldoc patch after the sync_audio_rate() patches are merged into the -nightly branch?

Hm, I do pull in sound/for-next into drm-intel-nightly ... Are the patches somewhere else? I can easily add another branch to nightly to make things easier. Takashi, which branches should I all pull in to get all the audio stuff into drm-intel-nightly?

No, it's not merged into for-next branch because the 4th patch is missing, and I didn't get your proper ack yet. The three patches are left in topic/drm-sync-audio-rate branch. If these are OK for you, I'll add Acked-by to them before you pulling it (if any).

But, still I'm not sure whether we should really merge these partial changes to 4.3. Will the last patch be ready in time? If yes, we can go forward now.

thanks,

Takashi

Quoted 97 lines

Thanks, Daniel

Quoted 94 lines

Regards,
Libin

Quoted 89 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Friday, September 04, 2015 3:55 PM
To: Jani Nikula
Cc: Yang, Libin; Daniel Vetter; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 11 lines · Jani Nikula
Quoted 10 lines · Libin
Quoted 10 lines

-----Original Message-----
From: Daniel Vetter [mailto:[email protected]] On Behalf Of Daniel Vetter
Sent: Wednesday, September 02, 2015 8:18 PM
To: Yang, Libin
Cc: [email protected]; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] drm/i915: add kerneldoc for i915_audio_component

Quoted 1 line
Quoted 1 line
Quoted 1 line

On Wed, Sep 02, 2015 at 02:12:24PM +0800,

[email protected]

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 3 lines · wrote:

From: Libin Yang <[email protected]>

Add the kerneldoc for i915_audio_component in

i915_component.h

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
---
 include/drm/i915_component.h | 39

++++++++++++++++++++++++--

Quoted 12 lines
Quoted 12 lines
Quoted 12 lines

-------------

Review

Quoted 3 lines
 1 file changed, 24 insertions(+), 15 deletions(-)
(quoted diff) +0 -0

b/include/drm/i915_component.h

Quoted 7 lines

index 8ad6f1b..187acc8 100644

include/drm/i915_component.h +0 -0
@@ -24,23 +24,32 @@
 #ifndef _I915_COMPONENT_H_
 #define _I915_COMPONENT_H_
 
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

include/drm/i915_component.h line 28

Quoted 2 lines
include/drm/i915_component.h +2 -0
+/**
+ * struct i915_audio_component_ops - callbacks defined in gfx

driver

Quoted 4 lines
include/drm/i915_component.h +4 -0
+ * @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

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

wake signal

include/drm/i915_component.h line 37

Quoted 5 lines
include/drm/i915_component.h +5 -0
+ * @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;

New kerneldoc in 4.3 allows you to split structure documentation

up

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

into
per-member comments. Especially with vtables I think this makes

a lot

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

of
sense, since then you have enough space to document where and

how

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

exactly
a given hook is called (looks, place in the overall sequence).

Also please include your stancas in the drm.tmpl docbook

template,

Quoted 1 line
Quoted 1 line
Quoted 1 line

otherwise it won't be included in the html docs. And finally please

add

Quoted 10 lines
Quoted 8 lines

OK, I will add it in drm.tmpl.

Quoted 3 lines

a
DOC: overview section which explains at a high level how i915 and hda-intel corporate for hdmi/dp audio.

Where the DOC should be located in?

i915/intel_audio.c already has a "DOC: High Definition Audio over

HDMI

Quoted 1 line

and Display Port" comment. IMO you could just amend that, as

there's

Quoted 14 lines
Quoted 8 lines
Quoted 8 lines
Quoted 1 line

already some references to the audio driver.

Yeah I think that would be a perfect place.
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

_______________________________________________
Intel-gfx mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/intel-gfx