[alsa-devel] [PATCH 05/39] ALSA: seq: add documentation for snd_seq_kernel_client_ctl

[Takashi Iwai]

On Sun, 07 Aug 2016 11:48:41 +0200,
Takashi Sakamoto wrote:
> 
> This kernel API is used by kernel implementation. Currently, it's used for
> kernel clients of ALSA sequencer, while it can be used for application
> clients. The difference is just on address spaces of argument. In short,
> this kernel API can be available for application client with data in kernel
> space.
> 
> This commit adds a document about this.
> 
> Signed-off-by: Takashi Sakamoto <o-takashi at sakamocchi.jp>
> ---
>  sound/core/seq/seq_clientmgr.c | 14 +++++++++++---
>  1 file changed, 11 insertions(+), 3 deletions(-)
> 
> diff --git a/sound/core/seq/seq_clientmgr.c b/sound/core/seq/seq_clientmgr.c
> index 17d988a..a09cb84 100644
> --- a/sound/core/seq/seq_clientmgr.c
> +++ b/sound/core/seq/seq_clientmgr.c
> @@ -2494,9 +2494,17 @@ int snd_seq_kernel_client_dispatch(int client, struct snd_seq_event * ev,
>  
>  EXPORT_SYMBOL(snd_seq_kernel_client_dispatch);
>  
> -/*
> - * exported, called by kernel clients to perform same functions as with
> - * userland ioctl() 
> +/**
> + * snd_seq_kernel_client_ctl - operate a command for a client with data in
> + *			       kernel space.
> + * @clientid:	A numerical ID for a client.
> + * @cmd:	An ioctl(2) command for ALSA sequencer operation.
> + * @arg:	A pointer to data in kernel space.
> + *
> + * Against its name, both kernel/application client can be handled by this
> + * kernel API. Address space for 'arg' argument should be in kernel space.
> + *
> + * Return: 0 at success. Minus error code at failure.

s/Minus/Negative/


Takashi