Commit 12cddbd8 authored by Takashi Iwai's avatar Takashi Iwai
Browse files

ALSA: control: Add missing kerneldoc comments to exported functions 



A few functions have no proper documentation yet, so let's add them.
Along with it, remove superfluous blank line between the closing brace
and EXPORT_SYMBOL() line.

Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 438f4e28

sound/core/control.c

+49 −15
Original line number Diff line number Diff line
@@ -141,6 +141,16 @@ static int snd_ctl_release(struct inode *inode, struct file *file) 
	return 0;

}



/**

 * snd_ctl_notify - Send notification to user-space for a control change

 * @card: the card to send notification

 * @mask: the event mask, SNDRV_CTL_EVENT_*

 * @id: the ctl element id to send notification

 *

 * This function adds an event record with the given id and mask, appends

 * to the list and wakes up the user-space for notification.  This can be

 * called in the atomic context.

 */

void snd_ctl_notify(struct snd_card *card, unsigned int mask,

		    struct snd_ctl_elem_id *id)

{
@@ -179,7 +189,6 @@ void snd_ctl_notify(struct snd_card *card, unsigned int mask, 
	}

	read_unlock(&card->ctl_files_rwlock);

}



EXPORT_SYMBOL(snd_ctl_notify);



/**
@@ -261,7 +270,6 @@ struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol, 
	kctl.private_data = private_data;

	return snd_ctl_new(&kctl, access);

}



EXPORT_SYMBOL(snd_ctl_new1);



/**
@@ -280,7 +288,6 @@ void snd_ctl_free_one(struct snd_kcontrol *kcontrol) 
		kfree(kcontrol);

	}

}



EXPORT_SYMBOL(snd_ctl_free_one);



static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
@@ -376,7 +383,6 @@ int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol) 
	snd_ctl_free_one(kcontrol);

	return err;

}



EXPORT_SYMBOL(snd_ctl_add);



/**
@@ -471,7 +477,6 @@ int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol) 
	snd_ctl_free_one(kcontrol);

	return 0;

}



EXPORT_SYMBOL(snd_ctl_remove);



/**
@@ -499,7 +504,6 @@ int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id) 
	up_write(&card->controls_rwsem);

	return ret;

}



EXPORT_SYMBOL(snd_ctl_remove_id);



/**
@@ -617,7 +621,6 @@ int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id, 
	up_write(&card->controls_rwsem);

	return 0;

}



EXPORT_SYMBOL(snd_ctl_rename_id);



/**
@@ -645,7 +648,6 @@ struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numi 
	}

	return NULL;

}



EXPORT_SYMBOL(snd_ctl_find_numid);



/**
@@ -687,7 +689,6 @@ struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card, 
	}

	return NULL;

}



EXPORT_SYMBOL(snd_ctl_find_id);



static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
@@ -1526,19 +1527,28 @@ static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head * 
	return 0;

}



/**

 * snd_ctl_register_ioctl - register the device-specific control-ioctls

 * @fcn: ioctl callback function

 *

 * called from each device manager like pcm.c, hwdep.c, etc.

 */

int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)

{

	return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);

}



EXPORT_SYMBOL(snd_ctl_register_ioctl);



#ifdef CONFIG_COMPAT

/**

 * snd_ctl_register_ioctl_compat - register the device-specific 32bit compat

 * control-ioctls

 * @fcn: ioctl callback function

 */

int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)

{

	return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);

}



EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);

#endif
@@ -1566,19 +1576,26 @@ static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn, 
	return -EINVAL;

}



/**

 * snd_ctl_unregister_ioctl - de-register the device-specific control-ioctls

 * @fcn: ioctl callback function to unregister

 */

int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)

{

	return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);

}



EXPORT_SYMBOL(snd_ctl_unregister_ioctl);



#ifdef CONFIG_COMPAT

/**

 * snd_ctl_unregister_ioctl - de-register the device-specific compat 32bit

 * control-ioctls

 * @fcn: ioctl callback function to unregister

 */

int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)

{

	return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);

}



EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);

#endif
@@ -1702,6 +1719,16 @@ int snd_ctl_create(struct snd_card *card) 
/*

 * Frequently used control callbacks/helpers

 */



/**

 * snd_ctl_boolean_mono_info - Helper function for a standard boolean info

 * callback with a mono channel

 * @kcontrol: the kcontrol instance

 * @uinfo: info to store

 *

 * This is a function that can be used as info callback for a standard

 * boolean control with a single mono channel.

 */

int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,

			      struct snd_ctl_elem_info *uinfo)

{
@@ -1711,9 +1738,17 @@ int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol, 
	uinfo->value.integer.max = 1;

	return 0;

}



EXPORT_SYMBOL(snd_ctl_boolean_mono_info);



/**

 * snd_ctl_boolean_stereo_info - Helper function for a standard boolean info

 * callback with stereo two channels

 * @kcontrol: the kcontrol instance

 * @uinfo: info to store

 *

 * This is a function that can be used as info callback for a standard

 * boolean control with stereo two channels.

 */

int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,

				struct snd_ctl_elem_info *uinfo)

{
@@ -1723,7 +1758,6 @@ int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol, 
	uinfo->value.integer.max = 1;

	return 0;

}



EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);



/**

CRA Git | Maintained and supported by SUSTech CRA and CCSE