pcm.h 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161
  1. #ifndef __SOUND_PCM_H
  2. #define __SOUND_PCM_H
  3. /*
  4. * Digital Audio (PCM) abstract layer
  5. * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
  6. * Abramo Bagnara <abramo@alsa-project.org>
  7. *
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License as published by
  11. * the Free Software Foundation; either version 2 of the License, or
  12. * (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22. *
  23. */
  24. #include <sound/asound.h>
  25. #include <sound/memalloc.h>
  26. #include <sound/minors.h>
  27. #include <linux/poll.h>
  28. #include <linux/mm.h>
  29. #include <linux/bitops.h>
  30. #include <linux/pm_qos.h>
  31. #define snd_pcm_substream_chip(substream) ((substream)->private_data)
  32. #define snd_pcm_chip(pcm) ((pcm)->private_data)
  33. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  34. #include "pcm_oss.h"
  35. #endif
  36. /*
  37. * Hardware (lowlevel) section
  38. */
  39. struct snd_pcm_hardware {
  40. unsigned int info; /* SNDRV_PCM_INFO_* */
  41. u64 formats; /* SNDRV_PCM_FMTBIT_* */
  42. unsigned int rates; /* SNDRV_PCM_RATE_* */
  43. unsigned int rate_min; /* min rate */
  44. unsigned int rate_max; /* max rate */
  45. unsigned int channels_min; /* min channels */
  46. unsigned int channels_max; /* max channels */
  47. size_t buffer_bytes_max; /* max buffer size */
  48. size_t period_bytes_min; /* min period size */
  49. size_t period_bytes_max; /* max period size */
  50. unsigned int periods_min; /* min # of periods */
  51. unsigned int periods_max; /* max # of periods */
  52. size_t fifo_size; /* fifo size in bytes */
  53. };
  54. struct snd_pcm_substream;
  55. struct snd_pcm_ops {
  56. int (*open)(struct snd_pcm_substream *substream);
  57. int (*close)(struct snd_pcm_substream *substream);
  58. int (*ioctl)(struct snd_pcm_substream * substream,
  59. unsigned int cmd, void *arg);
  60. int (*hw_params)(struct snd_pcm_substream *substream,
  61. struct snd_pcm_hw_params *params);
  62. int (*hw_free)(struct snd_pcm_substream *substream);
  63. int (*prepare)(struct snd_pcm_substream *substream);
  64. int (*trigger)(struct snd_pcm_substream *substream, int cmd);
  65. snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
  66. int (*copy)(struct snd_pcm_substream *substream, int channel,
  67. snd_pcm_uframes_t pos,
  68. void __user *buf, snd_pcm_uframes_t count);
  69. int (*silence)(struct snd_pcm_substream *substream, int channel,
  70. snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
  71. struct page *(*page)(struct snd_pcm_substream *substream,
  72. unsigned long offset);
  73. int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
  74. int (*ack)(struct snd_pcm_substream *substream);
  75. int (*restart)(struct snd_pcm_substream *substream);
  76. };
  77. /*
  78. *
  79. */
  80. #if defined(CONFIG_SND_DYNAMIC_MINORS)
  81. #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
  82. #else
  83. #define SNDRV_PCM_DEVICES 8
  84. #endif
  85. #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
  86. #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
  87. #define SNDRV_PCM_IOCTL1_RESET 0
  88. #define SNDRV_PCM_IOCTL1_INFO 1
  89. #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
  90. #define SNDRV_PCM_IOCTL1_GSTATE 3
  91. #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
  92. #define SNDRV_PCM_TRIGGER_STOP 0
  93. #define SNDRV_PCM_TRIGGER_START 1
  94. #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
  95. #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
  96. #define SNDRV_PCM_TRIGGER_SUSPEND 5
  97. #define SNDRV_PCM_TRIGGER_RESUME 6
  98. #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
  99. #define SNDRV_DMA_MODE (0)
  100. #define SNDRV_NON_DMA_MODE (1 << 0)
  101. #define SNDRV_RENDER_STOPPED (1 << 1)
  102. #define SNDRV_RENDER_RUNNING (1 << 2)
  103. /* If you change this don't forget to change rates[] table in pcm_native.c */
  104. #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
  105. #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
  106. #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
  107. #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
  108. #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
  109. #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
  110. #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
  111. #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
  112. #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
  113. #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
  114. #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
  115. #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
  116. #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
  117. #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
  118. #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
  119. #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
  120. SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
  121. SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
  122. #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
  123. #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
  124. SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
  125. #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
  126. SNDRV_PCM_RATE_192000)
  127. #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
  128. #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
  129. #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
  130. #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
  131. #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
  132. #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
  133. #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
  134. #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
  135. #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
  136. #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
  137. #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
  138. #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
  139. #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
  140. #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
  141. #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
  142. #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
  143. #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
  144. #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
  145. #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
  146. #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
  147. #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
  148. #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
  149. #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
  150. #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
  151. #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
  152. #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
  153. #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
  154. #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
  155. #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
  156. #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
  157. #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
  158. #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
  159. #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
  160. #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
  161. #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
  162. #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
  163. #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
  164. #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
  165. #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
  166. #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
  167. #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
  168. #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
  169. #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
  170. #ifdef SNDRV_LITTLE_ENDIAN
  171. #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
  172. #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
  173. #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
  174. #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
  175. #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
  176. #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
  177. #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
  178. #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
  179. #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
  180. #endif
  181. #ifdef SNDRV_BIG_ENDIAN
  182. #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
  183. #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
  184. #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
  185. #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
  186. #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
  187. #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
  188. #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
  189. #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
  190. #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
  191. #endif
  192. struct snd_pcm_file {
  193. struct snd_pcm_substream *substream;
  194. int no_compat_mmap;
  195. };
  196. struct snd_pcm_hw_rule;
  197. typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
  198. struct snd_pcm_hw_rule *rule);
  199. struct snd_pcm_hw_rule {
  200. unsigned int cond;
  201. snd_pcm_hw_rule_func_t func;
  202. int var;
  203. int deps[4];
  204. void *private;
  205. };
  206. struct snd_pcm_hw_constraints {
  207. struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
  208. SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
  209. struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
  210. SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
  211. unsigned int rules_num;
  212. unsigned int rules_all;
  213. struct snd_pcm_hw_rule *rules;
  214. };
  215. static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
  216. snd_pcm_hw_param_t var)
  217. {
  218. return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
  219. }
  220. static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
  221. snd_pcm_hw_param_t var)
  222. {
  223. return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
  224. }
  225. struct snd_ratnum {
  226. unsigned int num;
  227. unsigned int den_min, den_max, den_step;
  228. };
  229. struct snd_ratden {
  230. unsigned int num_min, num_max, num_step;
  231. unsigned int den;
  232. };
  233. struct snd_pcm_hw_constraint_ratnums {
  234. int nrats;
  235. struct snd_ratnum *rats;
  236. };
  237. struct snd_pcm_hw_constraint_ratdens {
  238. int nrats;
  239. struct snd_ratden *rats;
  240. };
  241. struct snd_pcm_hw_constraint_list {
  242. unsigned int count;
  243. unsigned int *list;
  244. unsigned int mask;
  245. };
  246. struct snd_pcm_hwptr_log;
  247. struct snd_pcm_runtime {
  248. /* -- Status -- */
  249. struct snd_pcm_substream *trigger_master;
  250. struct timespec trigger_tstamp; /* trigger timestamp */
  251. int overrange;
  252. snd_pcm_uframes_t avail_max;
  253. snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
  254. snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
  255. unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
  256. unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
  257. snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
  258. /* -- HW params -- */
  259. snd_pcm_access_t access; /* access mode */
  260. snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
  261. snd_pcm_subformat_t subformat; /* subformat */
  262. unsigned int rate; /* rate in Hz */
  263. unsigned int channels; /* channels */
  264. snd_pcm_uframes_t period_size; /* period size */
  265. unsigned int periods; /* periods */
  266. snd_pcm_uframes_t buffer_size; /* buffer size */
  267. snd_pcm_uframes_t min_align; /* Min alignment for the format */
  268. size_t byte_align;
  269. unsigned int frame_bits;
  270. unsigned int sample_bits;
  271. unsigned int info;
  272. unsigned int rate_num;
  273. unsigned int rate_den;
  274. unsigned int no_period_wakeup: 1;
  275. unsigned int render_flag;
  276. /* -- SW params -- */
  277. int tstamp_mode; /* mmap timestamp is updated */
  278. unsigned int period_step;
  279. snd_pcm_uframes_t start_threshold;
  280. snd_pcm_uframes_t stop_threshold;
  281. snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
  282. noise is nearest than this */
  283. snd_pcm_uframes_t silence_size; /* Silence filling size */
  284. snd_pcm_uframes_t boundary; /* pointers wrap point */
  285. snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
  286. snd_pcm_uframes_t silence_filled; /* size filled with silence */
  287. union snd_pcm_sync_id sync; /* hardware synchronization ID */
  288. /* -- mmap -- */
  289. struct snd_pcm_mmap_status *status;
  290. struct snd_pcm_mmap_control *control;
  291. /* -- locking / scheduling -- */
  292. snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
  293. wait_queue_head_t sleep; /* poll sleep */
  294. wait_queue_head_t tsleep; /* transfer sleep */
  295. struct fasync_struct *fasync;
  296. /* -- private section -- */
  297. void *private_data;
  298. void (*private_free)(struct snd_pcm_runtime *runtime);
  299. /* -- hardware description -- */
  300. struct snd_pcm_hardware hw;
  301. struct snd_pcm_hw_constraints hw_constraints;
  302. /* -- interrupt callbacks -- */
  303. void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
  304. void (*transfer_ack_end)(struct snd_pcm_substream *substream);
  305. /* -- timer -- */
  306. unsigned int timer_resolution; /* timer resolution */
  307. int tstamp_type; /* timestamp type */
  308. /* -- DMA -- */
  309. unsigned char *dma_area; /* DMA area */
  310. dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
  311. size_t dma_bytes; /* size of DMA area */
  312. struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
  313. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  314. /* -- OSS things -- */
  315. struct snd_pcm_oss_runtime oss;
  316. #endif
  317. #ifdef CONFIG_SND_PCM_XRUN_DEBUG
  318. struct snd_pcm_hwptr_log *hwptr_log;
  319. #endif
  320. };
  321. struct snd_pcm_group { /* keep linked substreams */
  322. spinlock_t lock;
  323. struct list_head substreams;
  324. int count;
  325. };
  326. struct pid;
  327. struct snd_pcm_substream {
  328. struct snd_pcm *pcm;
  329. struct snd_pcm_str *pstr;
  330. void *private_data; /* copied from pcm->private_data */
  331. int number;
  332. char name[32]; /* substream name */
  333. int stream; /* stream (direction) */
  334. struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
  335. size_t buffer_bytes_max; /* limit ring buffer size */
  336. struct snd_dma_buffer dma_buffer;
  337. unsigned int dma_buf_id;
  338. size_t dma_max;
  339. /* -- hardware operations -- */
  340. struct snd_pcm_ops *ops;
  341. /* -- runtime information -- */
  342. struct snd_pcm_runtime *runtime;
  343. /* -- timer section -- */
  344. struct snd_timer *timer; /* timer */
  345. unsigned timer_running: 1; /* time is running */
  346. /* -- next substream -- */
  347. struct snd_pcm_substream *next;
  348. /* -- linked substreams -- */
  349. struct list_head link_list; /* linked list member */
  350. struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
  351. struct snd_pcm_group *group; /* pointer to current group */
  352. /* -- assigned files -- */
  353. void *file;
  354. int ref_count;
  355. atomic_t mmap_count;
  356. unsigned int f_flags;
  357. void (*pcm_release)(struct snd_pcm_substream *);
  358. struct pid *pid;
  359. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  360. /* -- OSS things -- */
  361. struct snd_pcm_oss_substream oss;
  362. #endif
  363. #ifdef CONFIG_SND_VERBOSE_PROCFS
  364. struct snd_info_entry *proc_root;
  365. struct snd_info_entry *proc_info_entry;
  366. struct snd_info_entry *proc_hw_params_entry;
  367. struct snd_info_entry *proc_sw_params_entry;
  368. struct snd_info_entry *proc_status_entry;
  369. struct snd_info_entry *proc_prealloc_entry;
  370. struct snd_info_entry *proc_prealloc_max_entry;
  371. #endif
  372. /* misc flags */
  373. unsigned int hw_opened: 1;
  374. unsigned int hw_no_buffer: 1; /* substream may not have a buffer */
  375. };
  376. #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
  377. struct snd_pcm_str {
  378. int stream; /* stream (direction) */
  379. struct snd_pcm *pcm;
  380. /* -- substreams -- */
  381. unsigned int substream_count;
  382. unsigned int substream_opened;
  383. struct snd_pcm_substream *substream;
  384. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  385. /* -- OSS things -- */
  386. struct snd_pcm_oss_stream oss;
  387. #endif
  388. #ifdef CONFIG_SND_VERBOSE_PROCFS
  389. struct snd_info_entry *proc_root;
  390. struct snd_info_entry *proc_info_entry;
  391. #ifdef CONFIG_SND_PCM_XRUN_DEBUG
  392. unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
  393. struct snd_info_entry *proc_xrun_debug_entry;
  394. #endif
  395. #endif
  396. struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
  397. struct snd_kcontrol *vol_kctl; /* volume controls */
  398. };
  399. struct snd_pcm {
  400. struct snd_card *card;
  401. struct list_head list;
  402. int device; /* device number */
  403. unsigned int info_flags;
  404. unsigned short dev_class;
  405. unsigned short dev_subclass;
  406. char id[64];
  407. char name[80];
  408. struct snd_pcm_str streams[2];
  409. struct mutex open_mutex;
  410. wait_queue_head_t open_wait;
  411. void *private_data;
  412. void (*private_free) (struct snd_pcm *pcm);
  413. struct device *dev; /* actual hw device this belongs to */
  414. bool internal; /* pcm is for internal use only */
  415. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  416. struct snd_pcm_oss oss;
  417. #endif
  418. };
  419. struct snd_pcm_notify {
  420. int (*n_register) (struct snd_pcm * pcm);
  421. int (*n_disconnect) (struct snd_pcm * pcm);
  422. int (*n_unregister) (struct snd_pcm * pcm);
  423. struct list_head list;
  424. };
  425. /*
  426. * Registering
  427. */
  428. extern const struct file_operations snd_pcm_f_ops[2];
  429. int snd_pcm_new(struct snd_card *card, const char *id, int device,
  430. int playback_count, int capture_count,
  431. struct snd_pcm **rpcm);
  432. int snd_pcm_new_soc_be(struct snd_card *card, const char *id, int device,
  433. int playback_count, int capture_count,
  434. struct snd_pcm ** rpcm);
  435. int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
  436. int playback_count, int capture_count,
  437. struct snd_pcm **rpcm);
  438. int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
  439. int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
  440. /*
  441. * Native I/O
  442. */
  443. extern rwlock_t snd_pcm_link_rwlock;
  444. int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
  445. int snd_pcm_info_user(struct snd_pcm_substream *substream,
  446. struct snd_pcm_info __user *info);
  447. int snd_pcm_status(struct snd_pcm_substream *substream,
  448. struct snd_pcm_status *status);
  449. int snd_pcm_start(struct snd_pcm_substream *substream);
  450. int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
  451. int snd_pcm_drain_done(struct snd_pcm_substream *substream);
  452. #ifdef CONFIG_PM
  453. int snd_pcm_suspend(struct snd_pcm_substream *substream);
  454. int snd_pcm_suspend_all(struct snd_pcm *pcm);
  455. #endif
  456. int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
  457. int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
  458. struct snd_pcm_substream **rsubstream);
  459. void snd_pcm_release_substream(struct snd_pcm_substream *substream);
  460. int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
  461. struct snd_pcm_substream **rsubstream);
  462. void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
  463. void snd_pcm_vma_notify_data(void *client, void *data);
  464. int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
  465. #ifdef CONFIG_SND_DEBUG
  466. void snd_pcm_debug_name(struct snd_pcm_substream *substream,
  467. char *name, size_t len);
  468. #else
  469. static inline void
  470. snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
  471. {
  472. *buf = 0;
  473. }
  474. #endif
  475. /*
  476. * PCM library
  477. */
  478. static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
  479. {
  480. return substream->group != &substream->self_group;
  481. }
  482. static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
  483. {
  484. read_lock(&snd_pcm_link_rwlock);
  485. spin_lock(&substream->self_group.lock);
  486. }
  487. static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
  488. {
  489. spin_unlock(&substream->self_group.lock);
  490. read_unlock(&snd_pcm_link_rwlock);
  491. }
  492. static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
  493. {
  494. read_lock_irq(&snd_pcm_link_rwlock);
  495. spin_lock(&substream->self_group.lock);
  496. }
  497. static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
  498. {
  499. spin_unlock(&substream->self_group.lock);
  500. read_unlock_irq(&snd_pcm_link_rwlock);
  501. }
  502. #define snd_pcm_stream_lock_irqsave(substream, flags) \
  503. do { \
  504. read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
  505. spin_lock(&substream->self_group.lock); \
  506. } while (0)
  507. #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
  508. do { \
  509. spin_unlock(&substream->self_group.lock); \
  510. read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
  511. } while (0)
  512. #define snd_pcm_group_for_each_entry(s, substream) \
  513. list_for_each_entry(s, &substream->group->substreams, link_list)
  514. static inline int snd_pcm_running(struct snd_pcm_substream *substream)
  515. {
  516. return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
  517. (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
  518. substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
  519. }
  520. static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
  521. {
  522. return size * 8 / runtime->sample_bits;
  523. }
  524. static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
  525. {
  526. return size * 8 / runtime->frame_bits;
  527. }
  528. static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
  529. {
  530. return size * runtime->sample_bits / 8;
  531. }
  532. static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
  533. {
  534. return size * runtime->frame_bits / 8;
  535. }
  536. static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
  537. {
  538. return bytes % runtime->byte_align == 0;
  539. }
  540. static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
  541. {
  542. struct snd_pcm_runtime *runtime = substream->runtime;
  543. return frames_to_bytes(runtime, runtime->buffer_size);
  544. }
  545. static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
  546. {
  547. struct snd_pcm_runtime *runtime = substream->runtime;
  548. return frames_to_bytes(runtime, runtime->period_size);
  549. }
  550. /*
  551. * result is: 0 ... (boundary - 1)
  552. */
  553. static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
  554. {
  555. snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
  556. if (avail < 0)
  557. avail += runtime->boundary;
  558. else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
  559. avail -= runtime->boundary;
  560. return avail;
  561. }
  562. /*
  563. * result is: 0 ... (boundary - 1)
  564. */
  565. static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
  566. {
  567. snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
  568. if (avail < 0)
  569. avail += runtime->boundary;
  570. return avail;
  571. }
  572. static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
  573. {
  574. return runtime->buffer_size - snd_pcm_playback_avail(runtime);
  575. }
  576. static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
  577. {
  578. return runtime->buffer_size - snd_pcm_capture_avail(runtime);
  579. }
  580. /**
  581. * snd_pcm_playback_ready - check whether the playback buffer is available
  582. * @substream: the pcm substream instance
  583. *
  584. * Checks whether enough free space is available on the playback buffer.
  585. *
  586. * Returns non-zero if available, or zero if not.
  587. */
  588. static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
  589. {
  590. struct snd_pcm_runtime *runtime = substream->runtime;
  591. return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
  592. }
  593. /**
  594. * snd_pcm_capture_ready - check whether the capture buffer is available
  595. * @substream: the pcm substream instance
  596. *
  597. * Checks whether enough capture data is available on the capture buffer.
  598. *
  599. * Returns non-zero if available, or zero if not.
  600. */
  601. static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
  602. {
  603. struct snd_pcm_runtime *runtime = substream->runtime;
  604. return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
  605. }
  606. /**
  607. * snd_pcm_playback_data - check whether any data exists on the playback buffer
  608. * @substream: the pcm substream instance
  609. *
  610. * Checks whether any data exists on the playback buffer. If stop_threshold
  611. * is bigger or equal to boundary, then this function returns always non-zero.
  612. *
  613. * Returns non-zero if exists, or zero if not.
  614. */
  615. static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
  616. {
  617. struct snd_pcm_runtime *runtime = substream->runtime;
  618. if (runtime->stop_threshold >= runtime->boundary)
  619. return 1;
  620. return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
  621. }
  622. /**
  623. * snd_pcm_playback_empty - check whether the playback buffer is empty
  624. * @substream: the pcm substream instance
  625. *
  626. * Checks whether the playback buffer is empty.
  627. *
  628. * Returns non-zero if empty, or zero if not.
  629. */
  630. static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
  631. {
  632. struct snd_pcm_runtime *runtime = substream->runtime;
  633. return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
  634. }
  635. /**
  636. * snd_pcm_capture_empty - check whether the capture buffer is empty
  637. * @substream: the pcm substream instance
  638. *
  639. * Checks whether the capture buffer is empty.
  640. *
  641. * Returns non-zero if empty, or zero if not.
  642. */
  643. static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
  644. {
  645. struct snd_pcm_runtime *runtime = substream->runtime;
  646. return snd_pcm_capture_avail(runtime) == 0;
  647. }
  648. static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
  649. struct snd_pcm_substream *master)
  650. {
  651. substream->runtime->trigger_master = master;
  652. }
  653. static inline int hw_is_mask(int var)
  654. {
  655. return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
  656. var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
  657. }
  658. static inline int hw_is_interval(int var)
  659. {
  660. return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
  661. var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
  662. }
  663. static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
  664. snd_pcm_hw_param_t var)
  665. {
  666. return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
  667. }
  668. static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
  669. snd_pcm_hw_param_t var)
  670. {
  671. return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
  672. }
  673. static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
  674. snd_pcm_hw_param_t var)
  675. {
  676. return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
  677. }
  678. static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
  679. snd_pcm_hw_param_t var)
  680. {
  681. return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
  682. }
  683. #define params_channels(p) \
  684. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
  685. #define params_rate(p) \
  686. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
  687. #define params_period_size(p) \
  688. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
  689. #define params_periods(p) \
  690. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
  691. #define params_buffer_size(p) \
  692. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
  693. #define params_buffer_bytes(p) \
  694. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
  695. int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
  696. void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
  697. void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
  698. void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
  699. unsigned int k, struct snd_interval *c);
  700. void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
  701. const struct snd_interval *b, struct snd_interval *c);
  702. int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
  703. int snd_interval_ratnum(struct snd_interval *i,
  704. unsigned int rats_count, struct snd_ratnum *rats,
  705. unsigned int *nump, unsigned int *denp);
  706. void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
  707. void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
  708. int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
  709. int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
  710. int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
  711. int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
  712. int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
  713. u_int32_t mask);
  714. int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
  715. u_int64_t mask);
  716. int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
  717. unsigned int min, unsigned int max);
  718. int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
  719. int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
  720. unsigned int cond,
  721. snd_pcm_hw_param_t var,
  722. struct snd_pcm_hw_constraint_list *l);
  723. int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
  724. unsigned int cond,
  725. snd_pcm_hw_param_t var,
  726. struct snd_pcm_hw_constraint_ratnums *r);
  727. int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
  728. unsigned int cond,
  729. snd_pcm_hw_param_t var,
  730. struct snd_pcm_hw_constraint_ratdens *r);
  731. int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
  732. unsigned int cond,
  733. unsigned int width,
  734. unsigned int msbits);
  735. int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
  736. unsigned int cond,
  737. snd_pcm_hw_param_t var,
  738. unsigned long step);
  739. int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
  740. unsigned int cond,
  741. snd_pcm_hw_param_t var);
  742. int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
  743. unsigned int base_rate);
  744. int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
  745. unsigned int cond,
  746. int var,
  747. snd_pcm_hw_rule_func_t func, void *private,
  748. int dep, ...);
  749. int snd_pcm_format_signed(snd_pcm_format_t format);
  750. int snd_pcm_format_unsigned(snd_pcm_format_t format);
  751. int snd_pcm_format_linear(snd_pcm_format_t format);
  752. int snd_pcm_format_little_endian(snd_pcm_format_t format);
  753. int snd_pcm_format_big_endian(snd_pcm_format_t format);
  754. #if 0 /* just for DocBook */
  755. /**
  756. * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
  757. * @format: the format to check
  758. *
  759. * Returns 1 if the given PCM format is CPU-endian, 0 if
  760. * opposite, or a negative error code if endian not specified.
  761. */
  762. int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
  763. #endif /* DocBook */
  764. #ifdef SNDRV_LITTLE_ENDIAN
  765. #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
  766. #else
  767. #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
  768. #endif
  769. int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
  770. int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
  771. ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
  772. const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
  773. int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
  774. snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
  775. void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
  776. void snd_pcm_set_sync(struct snd_pcm_substream *substream);
  777. int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
  778. int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
  779. unsigned int cmd, void *arg);
  780. int snd_pcm_update_state(struct snd_pcm_substream *substream,
  781. struct snd_pcm_runtime *runtime);
  782. int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
  783. int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
  784. int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
  785. int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
  786. int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
  787. void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
  788. void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
  789. snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
  790. const void __user *buf,
  791. snd_pcm_uframes_t frames);
  792. snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
  793. void __user *buf, snd_pcm_uframes_t frames);
  794. snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
  795. void __user **bufs, snd_pcm_uframes_t frames);
  796. snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
  797. void __user **bufs, snd_pcm_uframes_t frames);
  798. extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
  799. int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
  800. unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
  801. static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
  802. struct snd_dma_buffer *bufp)
  803. {
  804. struct snd_pcm_runtime *runtime = substream->runtime;
  805. if (bufp) {
  806. runtime->dma_buffer_p = bufp;
  807. runtime->dma_area = bufp->area;
  808. runtime->dma_addr = bufp->addr;
  809. runtime->dma_bytes = bufp->bytes;
  810. } else {
  811. runtime->dma_buffer_p = NULL;
  812. runtime->dma_area = NULL;
  813. runtime->dma_addr = 0;
  814. runtime->dma_bytes = 0;
  815. }
  816. }
  817. /*
  818. * Timer interface
  819. */
  820. void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
  821. void snd_pcm_timer_init(struct snd_pcm_substream *substream);
  822. void snd_pcm_timer_done(struct snd_pcm_substream *substream);
  823. static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
  824. struct timespec *tv)
  825. {
  826. if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
  827. do_posix_clock_monotonic_gettime(tv);
  828. else
  829. getnstimeofday(tv);
  830. }
  831. /*
  832. * Memory
  833. */
  834. int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
  835. int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
  836. int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
  837. int type, struct device *data,
  838. size_t size, size_t max);
  839. int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
  840. int type, void *data,
  841. size_t size, size_t max);
  842. int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
  843. int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
  844. int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
  845. size_t size, gfp_t gfp_flags);
  846. int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
  847. struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
  848. unsigned long offset);
  849. #if 0 /* for kernel-doc */
  850. /**
  851. * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
  852. * @substream: the substream to allocate the buffer to
  853. * @size: the requested buffer size, in bytes
  854. *
  855. * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
  856. * contiguous in kernel virtual space, but not in physical memory. Use this
  857. * if the buffer is accessed by kernel code but not by device DMA.
  858. *
  859. * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
  860. * code.
  861. */
  862. static int snd_pcm_lib_alloc_vmalloc_buffer
  863. (struct snd_pcm_substream *substream, size_t size);
  864. /**
  865. * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
  866. * @substream: the substream to allocate the buffer to
  867. * @size: the requested buffer size, in bytes
  868. *
  869. * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
  870. * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
  871. */
  872. static int snd_pcm_lib_alloc_vmalloc_32_buffer
  873. (struct snd_pcm_substream *substream, size_t size);
  874. #endif
  875. #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
  876. _snd_pcm_lib_alloc_vmalloc_buffer \
  877. (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
  878. #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
  879. _snd_pcm_lib_alloc_vmalloc_buffer \
  880. (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
  881. #ifdef CONFIG_SND_DMA_SGBUF
  882. /*
  883. * SG-buffer handling
  884. */
  885. #define snd_pcm_substream_sgbuf(substream) \
  886. ((substream)->runtime->dma_buffer_p->private_data)
  887. static inline dma_addr_t
  888. snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
  889. {
  890. struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
  891. return snd_sgbuf_get_addr(sg, ofs);
  892. }
  893. static inline void *
  894. snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
  895. {
  896. struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
  897. return snd_sgbuf_get_ptr(sg, ofs);
  898. }
  899. struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
  900. unsigned long offset);
  901. unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
  902. unsigned int ofs, unsigned int size);
  903. #else /* !SND_DMA_SGBUF */
  904. /*
  905. * fake using a continuous buffer
  906. */
  907. static inline dma_addr_t
  908. snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
  909. {
  910. return substream->runtime->dma_addr + ofs;
  911. }
  912. static inline void *
  913. snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
  914. {
  915. return substream->runtime->dma_area + ofs;
  916. }
  917. #define snd_pcm_sgbuf_ops_page NULL
  918. #define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size) (size)
  919. #endif /* SND_DMA_SGBUF */
  920. /* handle mmap counter - PCM mmap callback should handle this counter properly */
  921. static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
  922. {
  923. struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
  924. atomic_inc(&substream->mmap_count);
  925. }
  926. static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
  927. {
  928. struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
  929. atomic_dec(&substream->mmap_count);
  930. }
  931. int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
  932. struct vm_area_struct *area);
  933. /* mmap for io-memory area */
  934. #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
  935. #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
  936. int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
  937. #else
  938. #define SNDRV_PCM_INFO_MMAP_IOMEM 0
  939. #define snd_pcm_lib_mmap_iomem NULL
  940. #endif
  941. #define snd_pcm_lib_mmap_vmalloc NULL
  942. static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
  943. {
  944. *max = dma < 4 ? 64 * 1024 : 128 * 1024;
  945. }
  946. /*
  947. * Misc
  948. */
  949. #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
  950. (IEC958_AES1_CON_ORIGINAL<<8)|\
  951. (IEC958_AES1_CON_PCM_CODER<<8)|\
  952. (IEC958_AES3_CON_FS_48000<<24))
  953. #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
  954. const char *snd_pcm_format_name(snd_pcm_format_t format);
  955. /*
  956. * PCM channel-mapping control API
  957. */
  958. /* array element of channel maps */
  959. struct snd_pcm_chmap_elem {
  960. unsigned char channels;
  961. unsigned char map[15];
  962. };
  963. /* channel map information; retrieved via snd_kcontrol_chip() */
  964. struct snd_pcm_chmap {
  965. struct snd_pcm *pcm; /* assigned PCM instance */
  966. int stream; /* PLAYBACK or CAPTURE */
  967. struct snd_kcontrol *kctl;
  968. const struct snd_pcm_chmap_elem *chmap;
  969. unsigned int max_channels;
  970. unsigned int channel_mask; /* optional: active channels bitmask */
  971. void *private_data; /* optional: private data pointer */
  972. };
  973. /* get the PCM substream assigned to the given chmap info */
  974. static inline struct snd_pcm_substream *
  975. snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
  976. {
  977. struct snd_pcm_substream *s;
  978. for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
  979. if (s->number == idx)
  980. return s;
  981. return NULL;
  982. }
  983. /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
  984. extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
  985. /* Other world's standard channel maps (C/LFE prior to RL/RR) */
  986. extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
  987. /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
  988. #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
  989. #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
  990. #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
  991. int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
  992. const struct snd_pcm_chmap_elem *chmap,
  993. int max_channels,
  994. unsigned long private_value,
  995. struct snd_pcm_chmap **info_ret);
  996. /*
  997. * PCM Volume control API
  998. */
  999. /* array element of volume */
  1000. struct snd_pcm_volume_elem {
  1001. int volume;
  1002. };
  1003. /* pp information; retrieved via snd_kcontrol_chip() */
  1004. struct snd_pcm_volume {
  1005. struct snd_pcm *pcm; /* assigned PCM instance */
  1006. int stream; /* PLAYBACK or CAPTURE */
  1007. struct snd_kcontrol *kctl;
  1008. const struct snd_pcm_volume_elem *volume;
  1009. int max_length;
  1010. void *private_data; /* optional: private data pointer */
  1011. };
  1012. int snd_pcm_add_volume_ctls(struct snd_pcm *pcm, int stream,
  1013. const struct snd_pcm_volume_elem *volume,
  1014. int max_length,
  1015. unsigned long private_value,
  1016. struct snd_pcm_volume **info_ret);
  1017. #endif /* __SOUND_PCM_H */