Commit 5f217f90 authored by Takashi Sakamoto's avatar Takashi Sakamoto Committed by Takashi Iwai
Browse files

ALSA: firewire-lib: fix kerneldoc errors 



Complete missing parameters, correct wrong reference, and add an explaination
about the differences between the latest specification and our implementation.

Signed-off-by: default avatarTakashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 1ea7a568

sound/firewire/amdtp.h

+22 −2
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ 
 *	corresponds to the end of event in the packet. Out of IEC 61883.

 * @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets.

 *	The value of data_block_quadlets is used instead of reported value.

 * @SKIP_DBC_ZERO_CHECK: Only for in-stream.  Packets with zero in dbc is

 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream.  Packets with zero in dbc is

 *	skipped for detecting discontinuity.

 * @CIP_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first

 *	packet is not continuous from an initial value.
@@ -43,7 +43,27 @@ enum cip_flags { 
};



/**

 * enum cip_sfc - a stream's sample rate

 * enum cip_sfc - supported Sampling Frequency Codes (SFCs)

 * @CIP_SFC_32000:   32,000 data blocks

 * @CIP_SFC_44100:   44,100 data blocks

 * @CIP_SFC_48000:   48,000 data blocks

 * @CIP_SFC_88200:   88,200 data blocks

 * @CIP_SFC_96000:   96,000 data blocks

 * @CIP_SFC_176400: 176,400 data blocks

 * @CIP_SFC_192000: 192,000 data blocks

 * @CIP_SFC_COUNT: the number of supported SFCs

 *

 * These values are used to show nominal Sampling Frequency Code in

 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,

 * this code means the number of events per second. Actually the code

 * represents the number of data blocks transferred per second in an AMDTP

 * stream.

 *

 * In IEC 61883-6:2005, some extensions were added to support more types of

 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became

 * different depending on the types.

 *

 * Currently our implementation is compatible with IEC 61883-6:2002.

 */

enum cip_sfc {

	CIP_SFC_32000  = 0,

sound/firewire/cmp.c

+2 −0
Original line number Diff line number Diff line
@@ -114,6 +114,7 @@ static int pcr_modify(struct cmp_connection *c, 
 * cmp_connection_init - initializes a connection manager

 * @c: the connection manager to initialize

 * @unit: a unit of the target device

 * @direction: input or output

 * @pcr_index: the index of the iPCR/oPCR on the target device

 */

int cmp_connection_init(struct cmp_connection *c,
@@ -154,6 +155,7 @@ EXPORT_SYMBOL(cmp_connection_init); 
/**

 * cmp_connection_check_used - check connection is already esablished or not

 * @c: the connection manager to be checked

 * @used: the pointer to store the result of checking the connection

 */

int cmp_connection_check_used(struct cmp_connection *c, bool *used)

{