pcm.h 39 KB

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