pcm.h 40 KB

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