Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 1c85cc64456c97f3b265788abafec5c482c6a908

Authored by Randy Dunlap
Committed by Takashi Iwai
1 parent 9a3f371e99
Exists in master and in 7 other branches imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-l5.0.0_1.0.0-ga

ALSA: kernel docs: fix sound/core/ kernel-doc 

Add kernel-doc function short descriptions to sound/core functions that
are missing this short description.  Mostly this involves moving some of
the function description onto the @funcname line.

Also correct a few variable names and fix other kernel-doc notation.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>

Showing 2 changed files with 32 additions and 40 deletions Side-by-side Diff

sound/core/pcm_lib.c
Diff comments   View file @ 1c85cc6
... ... @@ -908,12 +908,12 @@
908 908 EXPORT_SYMBOL(snd_pcm_hw_rule_add);
909 909  
910 910 /**
911   - * snd_pcm_hw_constraint_mask
  911 + * snd_pcm_hw_constraint_mask - apply the given bitmap mask constraint
912 912 * @runtime: PCM runtime instance
913 913 * @var: hw_params variable to apply the mask
914 914 * @mask: the bitmap mask
915 915 *
916   - * Apply the constraint of the given bitmap mask to a mask parameter.
  916 + * Apply the constraint of the given bitmap mask to a 32-bit mask parameter.
917 917 */
918 918 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
919 919 u_int32_t mask)
920 920  
... ... @@ -928,12 +928,12 @@
928 928 }
929 929  
930 930 /**
931   - * snd_pcm_hw_constraint_mask64
  931 + * snd_pcm_hw_constraint_mask64 - apply the given bitmap mask constraint
932 932 * @runtime: PCM runtime instance
933 933 * @var: hw_params variable to apply the mask
934 934 * @mask: the 64bit bitmap mask
935 935 *
936   - * Apply the constraint of the given bitmap mask to a mask parameter.
  936 + * Apply the constraint of the given bitmap mask to a 64-bit mask parameter.
937 937 */
938 938 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
939 939 u_int64_t mask)
... ... @@ -949,7 +949,7 @@
949 949 }
950 950  
951 951 /**
952   - * snd_pcm_hw_constraint_integer
  952 + * snd_pcm_hw_constraint_integer - apply an integer constraint to an interval
953 953 * @runtime: PCM runtime instance
954 954 * @var: hw_params variable to apply the integer constraint
955 955 *
... ... @@ -964,7 +964,7 @@
964 964 EXPORT_SYMBOL(snd_pcm_hw_constraint_integer);
965 965  
966 966 /**
967   - * snd_pcm_hw_constraint_minmax
  967 + * snd_pcm_hw_constraint_minmax - apply a min/max range constraint to an interval
968 968 * @runtime: PCM runtime instance
969 969 * @var: hw_params variable to apply the range
970 970 * @min: the minimal value
... ... @@ -995,7 +995,7 @@
995 995  
996 996  
997 997 /**
998   - * snd_pcm_hw_constraint_list
  998 + * snd_pcm_hw_constraint_list - apply a list of constraints to a parameter
999 999 * @runtime: PCM runtime instance
1000 1000 * @cond: condition bits
1001 1001 * @var: hw_params variable to apply the list constraint
... ... @@ -1031,7 +1031,7 @@
1031 1031 }
1032 1032  
1033 1033 /**
1034   - * snd_pcm_hw_constraint_ratnums
  1034 + * snd_pcm_hw_constraint_ratnums - apply ratnums constraint to a parameter
1035 1035 * @runtime: PCM runtime instance
1036 1036 * @cond: condition bits
1037 1037 * @var: hw_params variable to apply the ratnums constraint
... ... @@ -1064,7 +1064,7 @@
1064 1064 }
1065 1065  
1066 1066 /**
1067   - * snd_pcm_hw_constraint_ratdens
  1067 + * snd_pcm_hw_constraint_ratdens - apply ratdens constraint to a parameter
1068 1068 * @runtime: PCM runtime instance
1069 1069 * @cond: condition bits
1070 1070 * @var: hw_params variable to apply the ratdens constraint
... ... @@ -1095,7 +1095,7 @@
1095 1095 }
1096 1096  
1097 1097 /**
1098   - * snd_pcm_hw_constraint_msbits
  1098 + * snd_pcm_hw_constraint_msbits - add a hw constraint msbits rule
1099 1099 * @runtime: PCM runtime instance
1100 1100 * @cond: condition bits
1101 1101 * @width: sample bits width
... ... @@ -1123,7 +1123,7 @@
1123 1123 }
1124 1124  
1125 1125 /**
1126   - * snd_pcm_hw_constraint_step
  1126 + * snd_pcm_hw_constraint_step - add a hw constraint step rule
1127 1127 * @runtime: PCM runtime instance
1128 1128 * @cond: condition bits
1129 1129 * @var: hw_params variable to apply the step constraint
... ... @@ -1154,7 +1154,7 @@
1154 1154 }
1155 1155  
1156 1156 /**
1157   - * snd_pcm_hw_constraint_pow2
  1157 + * snd_pcm_hw_constraint_pow2 - add a hw constraint power-of-2 rule
1158 1158 * @runtime: PCM runtime instance
1159 1159 * @cond: condition bits
1160 1160 * @var: hw_params variable to apply the power-of-2 constraint
1161 1161  
1162 1162  
... ... @@ -1202,13 +1202,13 @@
1202 1202 EXPORT_SYMBOL(_snd_pcm_hw_params_any);
1203 1203  
1204 1204 /**
1205   - * snd_pcm_hw_param_value
  1205 + * snd_pcm_hw_param_value - return @params field @var value
1206 1206 * @params: the hw_params instance
1207 1207 * @var: parameter to retrieve
1208   - * @dir: pointer to the direction (-1,0,1) or NULL
  1208 + * @dir: pointer to the direction (-1,0,1) or %NULL
1209 1209 *
1210   - * Return the value for field PAR if it's fixed in configuration space
1211   - * defined by PARAMS. Return -EINVAL otherwise
  1210 + * Return the value for field @var if it's fixed in configuration space
  1211 + * defined by @params. Return -%EINVAL otherwise.
1212 1212 */
1213 1213 int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
1214 1214 snd_pcm_hw_param_t var, int *dir)
1215 1215  
1216 1216  
... ... @@ -1271,13 +1271,13 @@
1271 1271  
1272 1272  
1273 1273 /**
1274   - * snd_pcm_hw_param_first
  1274 + * snd_pcm_hw_param_first - refine config space and return minimum value
1275 1275 * @pcm: PCM instance
1276 1276 * @params: the hw_params instance
1277 1277 * @var: parameter to retrieve
1278   - * @dir: pointer to the direction (-1,0,1) or NULL
  1278 + * @dir: pointer to the direction (-1,0,1) or %NULL
1279 1279 *
1280   - * Inside configuration space defined by PARAMS remove from PAR all
  1280 + * Inside configuration space defined by @params remove from @var all
1281 1281 * values > minimum. Reduce configuration space accordingly.
1282 1282 * Return the minimum.
1283 1283 */
1284 1284  
1285 1285  
... ... @@ -1317,13 +1317,13 @@
1317 1317  
1318 1318  
1319 1319 /**
1320   - * snd_pcm_hw_param_last
  1320 + * snd_pcm_hw_param_last - refine config space and return maximum value
1321 1321 * @pcm: PCM instance
1322 1322 * @params: the hw_params instance
1323 1323 * @var: parameter to retrieve
1324   - * @dir: pointer to the direction (-1,0,1) or NULL
  1324 + * @dir: pointer to the direction (-1,0,1) or %NULL
1325 1325 *
1326   - * Inside configuration space defined by PARAMS remove from PAR all
  1326 + * Inside configuration space defined by @params remove from @var all
1327 1327 * values < maximum. Reduce configuration space accordingly.
1328 1328 * Return the maximum.
1329 1329 */
1330 1330  
... ... @@ -1345,11 +1345,11 @@
1345 1345 EXPORT_SYMBOL(snd_pcm_hw_param_last);
1346 1346  
1347 1347 /**
1348   - * snd_pcm_hw_param_choose
  1348 + * snd_pcm_hw_param_choose - choose a configuration defined by @params
1349 1349 * @pcm: PCM instance
1350 1350 * @params: the hw_params instance
1351 1351 *
1352   - * Choose one configuration from configuration space defined by PARAMS
  1352 + * Choose one configuration from configuration space defined by @params.
1353 1353 * The configuration chosen is that obtained fixing in this order:
1354 1354 * first access, first format, first subformat, min channels,
1355 1355 * min rate, min period time, max buffer size, min tick time
sound/core/pcm_native.c
Diff comments   View file @ 1c85cc6
... ... @@ -875,10 +875,8 @@
875 875 };
876 876  
877 877 /**
878   - * snd_pcm_start
  878 + * snd_pcm_start - start all linked streams
879 879 * @substream: the PCM substream instance
880   - *
881   - * Start all linked streams.
882 880 */
883 881 int snd_pcm_start(struct snd_pcm_substream *substream)
884 882 {
885 883  
... ... @@ -926,12 +924,11 @@
926 924 };
927 925  
928 926 /**
929   - * snd_pcm_stop
  927 + * snd_pcm_stop - try to stop all running streams in the substream group
930 928 * @substream: the PCM substream instance
931 929 * @state: PCM state after stopping the stream
932 930 *
933   - * Try to stop all running streams in the substream group.
934   - * The state of each stream is changed to the given value after that unconditionally.
  931 + * The state of each stream is then changed to the given state unconditionally.
935 932 */
936 933 int snd_pcm_stop(struct snd_pcm_substream *substream, int state)
937 934 {
938 935  
... ... @@ -941,11 +938,10 @@
941 938 EXPORT_SYMBOL(snd_pcm_stop);
942 939  
943 940 /**
944   - * snd_pcm_drain_done
  941 + * snd_pcm_drain_done - stop the DMA only when the given stream is playback
945 942 * @substream: the PCM substream
946 943 *
947   - * Stop the DMA only when the given stream is playback.
948   - * The state is changed to SETUP.
  944 + * After stopping, the state is changed to SETUP.
949 945 * Unlike snd_pcm_stop(), this affects only the given stream.
950 946 */
951 947 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
952 948  
... ... @@ -1065,10 +1061,9 @@
1065 1061 };
1066 1062  
1067 1063 /**
1068   - * snd_pcm_suspend
  1064 + * snd_pcm_suspend - trigger SUSPEND to all linked streams
1069 1065 * @substream: the PCM substream
1070 1066 *
1071   - * Trigger SUSPEND to all linked streams.
1072 1067 * After this call, all streams are changed to SUSPENDED state.
1073 1068 */
1074 1069 int snd_pcm_suspend(struct snd_pcm_substream *substream)
1075 1070  
... ... @@ -1088,10 +1083,9 @@
1088 1083 EXPORT_SYMBOL(snd_pcm_suspend);
1089 1084  
1090 1085 /**
1091   - * snd_pcm_suspend_all
  1086 + * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1092 1087 * @pcm: the PCM instance
1093 1088 *
1094   - * Trigger SUSPEND to all substreams in the given pcm.
1095 1089 * After this call, all streams are changed to SUSPENDED state.
1096 1090 */
1097 1091 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1098 1092  
... ... @@ -1313,11 +1307,9 @@
1313 1307 };
1314 1308  
1315 1309 /**
1316   - * snd_pcm_prepare
  1310 + * snd_pcm_prepare - prepare the PCM substream to be triggerable
1317 1311 * @substream: the PCM substream instance
1318 1312 * @file: file to refer f_flags
1319   - *
1320   - * Prepare the PCM substream to be triggerable.
1321 1313 */
1322 1314 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1323 1315 struct file *file)