pcm.h 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127
  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 (*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. u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
  254. /* -- HW params -- */
  255. snd_pcm_access_t access; /* access mode */
  256. snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
  257. snd_pcm_subformat_t subformat; /* subformat */
  258. unsigned int rate; /* rate in Hz */
  259. unsigned int channels; /* channels */
  260. snd_pcm_uframes_t period_size; /* period size */
  261. unsigned int periods; /* periods */
  262. snd_pcm_uframes_t buffer_size; /* buffer size */
  263. snd_pcm_uframes_t min_align; /* Min alignment for the format */
  264. size_t byte_align;
  265. unsigned int frame_bits;
  266. unsigned int sample_bits;
  267. unsigned int info;
  268. unsigned int rate_num;
  269. unsigned int rate_den;
  270. unsigned int no_period_wakeup: 1;
  271. /* -- SW params -- */
  272. int tstamp_mode; /* mmap timestamp is updated */
  273. unsigned int period_step;
  274. snd_pcm_uframes_t start_threshold;
  275. snd_pcm_uframes_t stop_threshold;
  276. snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
  277. noise is nearest than this */
  278. snd_pcm_uframes_t silence_size; /* Silence filling size */
  279. snd_pcm_uframes_t boundary; /* pointers wrap point */
  280. snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
  281. snd_pcm_uframes_t silence_filled; /* size filled with silence */
  282. union snd_pcm_sync_id sync; /* hardware synchronization ID */
  283. /* -- mmap -- */
  284. struct snd_pcm_mmap_status *status;
  285. struct snd_pcm_mmap_control *control;
  286. /* -- locking / scheduling -- */
  287. snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
  288. wait_queue_head_t sleep; /* poll sleep */
  289. wait_queue_head_t tsleep; /* transfer sleep */
  290. struct fasync_struct *fasync;
  291. /* -- private section -- */
  292. void *private_data;
  293. void (*private_free)(struct snd_pcm_runtime *runtime);
  294. /* -- hardware description -- */
  295. struct snd_pcm_hardware hw;
  296. struct snd_pcm_hw_constraints hw_constraints;
  297. /* -- interrupt callbacks -- */
  298. void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
  299. void (*transfer_ack_end)(struct snd_pcm_substream *substream);
  300. /* -- timer -- */
  301. unsigned int timer_resolution; /* timer resolution */
  302. int tstamp_type; /* timestamp type */
  303. /* -- DMA -- */
  304. unsigned char *dma_area; /* DMA area */
  305. dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
  306. size_t dma_bytes; /* size of DMA area */
  307. struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
  308. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  309. /* -- OSS things -- */
  310. struct snd_pcm_oss_runtime oss;
  311. #endif
  312. #ifdef CONFIG_SND_PCM_XRUN_DEBUG
  313. struct snd_pcm_hwptr_log *hwptr_log;
  314. #endif
  315. };
  316. struct snd_pcm_group { /* keep linked substreams */
  317. spinlock_t lock;
  318. struct list_head substreams;
  319. int count;
  320. };
  321. struct pid;
  322. struct snd_pcm_substream {
  323. struct snd_pcm *pcm;
  324. struct snd_pcm_str *pstr;
  325. void *private_data; /* copied from pcm->private_data */
  326. int number;
  327. char name[32]; /* substream name */
  328. int stream; /* stream (direction) */
  329. struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
  330. size_t buffer_bytes_max; /* limit ring buffer size */
  331. struct snd_dma_buffer dma_buffer;
  332. unsigned int dma_buf_id;
  333. size_t dma_max;
  334. /* -- hardware operations -- */
  335. struct snd_pcm_ops *ops;
  336. /* -- runtime information -- */
  337. struct snd_pcm_runtime *runtime;
  338. /* -- timer section -- */
  339. struct snd_timer *timer; /* timer */
  340. unsigned timer_running: 1; /* time is running */
  341. /* -- next substream -- */
  342. struct snd_pcm_substream *next;
  343. /* -- linked substreams -- */
  344. struct list_head link_list; /* linked list member */
  345. struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
  346. struct snd_pcm_group *group; /* pointer to current group */
  347. /* -- assigned files -- */
  348. void *file;
  349. int ref_count;
  350. atomic_t mmap_count;
  351. unsigned int f_flags;
  352. void (*pcm_release)(struct snd_pcm_substream *);
  353. struct pid *pid;
  354. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  355. /* -- OSS things -- */
  356. struct snd_pcm_oss_substream oss;
  357. #endif
  358. #ifdef CONFIG_SND_VERBOSE_PROCFS
  359. struct snd_info_entry *proc_root;
  360. struct snd_info_entry *proc_info_entry;
  361. struct snd_info_entry *proc_hw_params_entry;
  362. struct snd_info_entry *proc_sw_params_entry;
  363. struct snd_info_entry *proc_status_entry;
  364. struct snd_info_entry *proc_prealloc_entry;
  365. struct snd_info_entry *proc_prealloc_max_entry;
  366. #endif
  367. /* misc flags */
  368. unsigned int hw_opened: 1;
  369. };
  370. #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
  371. struct snd_pcm_str {
  372. int stream; /* stream (direction) */
  373. struct snd_pcm *pcm;
  374. /* -- substreams -- */
  375. unsigned int substream_count;
  376. unsigned int substream_opened;
  377. struct snd_pcm_substream *substream;
  378. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  379. /* -- OSS things -- */
  380. struct snd_pcm_oss_stream oss;
  381. #endif
  382. #ifdef CONFIG_SND_VERBOSE_PROCFS
  383. struct snd_info_entry *proc_root;
  384. struct snd_info_entry *proc_info_entry;
  385. #ifdef CONFIG_SND_PCM_XRUN_DEBUG
  386. unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
  387. struct snd_info_entry *proc_xrun_debug_entry;
  388. #endif
  389. #endif
  390. struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
  391. };
  392. struct snd_pcm {
  393. struct snd_card *card;
  394. struct list_head list;
  395. int device; /* device number */
  396. unsigned int info_flags;
  397. unsigned short dev_class;
  398. unsigned short dev_subclass;
  399. char id[64];
  400. char name[80];
  401. struct snd_pcm_str streams[2];
  402. struct mutex open_mutex;
  403. wait_queue_head_t open_wait;
  404. void *private_data;
  405. void (*private_free) (struct snd_pcm *pcm);
  406. struct device *dev; /* actual hw device this belongs to */
  407. bool internal; /* pcm is for internal use only */
  408. #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  409. struct snd_pcm_oss oss;
  410. #endif
  411. };
  412. struct snd_pcm_notify {
  413. int (*n_register) (struct snd_pcm * pcm);
  414. int (*n_disconnect) (struct snd_pcm * pcm);
  415. int (*n_unregister) (struct snd_pcm * pcm);
  416. struct list_head list;
  417. };
  418. /*
  419. * Registering
  420. */
  421. extern const struct file_operations snd_pcm_f_ops[2];
  422. int snd_pcm_new(struct snd_card *card, const char *id, int device,
  423. int playback_count, int capture_count,
  424. struct snd_pcm **rpcm);
  425. int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
  426. int playback_count, int capture_count,
  427. struct snd_pcm **rpcm);
  428. int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
  429. int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
  430. /*
  431. * Native I/O
  432. */
  433. extern rwlock_t snd_pcm_link_rwlock;
  434. int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
  435. int snd_pcm_info_user(struct snd_pcm_substream *substream,
  436. struct snd_pcm_info __user *info);
  437. int snd_pcm_status(struct snd_pcm_substream *substream,
  438. struct snd_pcm_status *status);
  439. int snd_pcm_start(struct snd_pcm_substream *substream);
  440. int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
  441. int snd_pcm_drain_done(struct snd_pcm_substream *substream);
  442. #ifdef CONFIG_PM
  443. int snd_pcm_suspend(struct snd_pcm_substream *substream);
  444. int snd_pcm_suspend_all(struct snd_pcm *pcm);
  445. #endif
  446. int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
  447. int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
  448. struct snd_pcm_substream **rsubstream);
  449. void snd_pcm_release_substream(struct snd_pcm_substream *substream);
  450. int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
  451. struct snd_pcm_substream **rsubstream);
  452. void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
  453. void snd_pcm_vma_notify_data(void *client, void *data);
  454. int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
  455. #ifdef CONFIG_SND_DEBUG
  456. void snd_pcm_debug_name(struct snd_pcm_substream *substream,
  457. char *name, size_t len);
  458. #else
  459. static inline void
  460. snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
  461. {
  462. *buf = 0;
  463. }
  464. #endif
  465. /*
  466. * PCM library
  467. */
  468. static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
  469. {
  470. return substream->group != &substream->self_group;
  471. }
  472. static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
  473. {
  474. read_lock(&snd_pcm_link_rwlock);
  475. spin_lock(&substream->self_group.lock);
  476. }
  477. static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
  478. {
  479. spin_unlock(&substream->self_group.lock);
  480. read_unlock(&snd_pcm_link_rwlock);
  481. }
  482. static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
  483. {
  484. read_lock_irq(&snd_pcm_link_rwlock);
  485. spin_lock(&substream->self_group.lock);
  486. }
  487. static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
  488. {
  489. spin_unlock(&substream->self_group.lock);
  490. read_unlock_irq(&snd_pcm_link_rwlock);
  491. }
  492. #define snd_pcm_stream_lock_irqsave(substream, flags) \
  493. do { \
  494. read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
  495. spin_lock(&substream->self_group.lock); \
  496. } while (0)
  497. #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
  498. do { \
  499. spin_unlock(&substream->self_group.lock); \
  500. read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
  501. } while (0)
  502. #define snd_pcm_group_for_each_entry(s, substream) \
  503. list_for_each_entry(s, &substream->group->substreams, link_list)
  504. static inline int snd_pcm_running(struct snd_pcm_substream *substream)
  505. {
  506. return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
  507. (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
  508. substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
  509. }
  510. static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
  511. {
  512. return size * 8 / runtime->sample_bits;
  513. }
  514. static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
  515. {
  516. return size * 8 / runtime->frame_bits;
  517. }
  518. static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
  519. {
  520. return size * runtime->sample_bits / 8;
  521. }
  522. static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
  523. {
  524. return size * runtime->frame_bits / 8;
  525. }
  526. static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
  527. {
  528. return bytes % runtime->byte_align == 0;
  529. }
  530. static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
  531. {
  532. struct snd_pcm_runtime *runtime = substream->runtime;
  533. return frames_to_bytes(runtime, runtime->buffer_size);
  534. }
  535. static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
  536. {
  537. struct snd_pcm_runtime *runtime = substream->runtime;
  538. return frames_to_bytes(runtime, runtime->period_size);
  539. }
  540. /*
  541. * result is: 0 ... (boundary - 1)
  542. */
  543. static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
  544. {
  545. snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
  546. if (avail < 0)
  547. avail += runtime->boundary;
  548. else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
  549. avail -= runtime->boundary;
  550. return avail;
  551. }
  552. /*
  553. * result is: 0 ... (boundary - 1)
  554. */
  555. static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
  556. {
  557. snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
  558. if (avail < 0)
  559. avail += runtime->boundary;
  560. return avail;
  561. }
  562. static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
  563. {
  564. return runtime->buffer_size - snd_pcm_playback_avail(runtime);
  565. }
  566. static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
  567. {
  568. return runtime->buffer_size - snd_pcm_capture_avail(runtime);
  569. }
  570. /**
  571. * snd_pcm_playback_ready - check whether the playback buffer is available
  572. * @substream: the pcm substream instance
  573. *
  574. * Checks whether enough free space is available on the playback buffer.
  575. *
  576. * Returns non-zero if available, or zero if not.
  577. */
  578. static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
  579. {
  580. struct snd_pcm_runtime *runtime = substream->runtime;
  581. return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
  582. }
  583. /**
  584. * snd_pcm_capture_ready - check whether the capture buffer is available
  585. * @substream: the pcm substream instance
  586. *
  587. * Checks whether enough capture data is available on the capture buffer.
  588. *
  589. * Returns non-zero if available, or zero if not.
  590. */
  591. static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
  592. {
  593. struct snd_pcm_runtime *runtime = substream->runtime;
  594. return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
  595. }
  596. /**
  597. * snd_pcm_playback_data - check whether any data exists on the playback buffer
  598. * @substream: the pcm substream instance
  599. *
  600. * Checks whether any data exists on the playback buffer. If stop_threshold
  601. * is bigger or equal to boundary, then this function returns always non-zero.
  602. *
  603. * Returns non-zero if exists, or zero if not.
  604. */
  605. static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
  606. {
  607. struct snd_pcm_runtime *runtime = substream->runtime;
  608. if (runtime->stop_threshold >= runtime->boundary)
  609. return 1;
  610. return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
  611. }
  612. /**
  613. * snd_pcm_playback_empty - check whether the playback buffer is empty
  614. * @substream: the pcm substream instance
  615. *
  616. * Checks whether the playback buffer is empty.
  617. *
  618. * Returns non-zero if empty, or zero if not.
  619. */
  620. static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
  621. {
  622. struct snd_pcm_runtime *runtime = substream->runtime;
  623. return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
  624. }
  625. /**
  626. * snd_pcm_capture_empty - check whether the capture buffer is empty
  627. * @substream: the pcm substream instance
  628. *
  629. * Checks whether the capture buffer is empty.
  630. *
  631. * Returns non-zero if empty, or zero if not.
  632. */
  633. static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
  634. {
  635. struct snd_pcm_runtime *runtime = substream->runtime;
  636. return snd_pcm_capture_avail(runtime) == 0;
  637. }
  638. static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
  639. struct snd_pcm_substream *master)
  640. {
  641. substream->runtime->trigger_master = master;
  642. }
  643. static inline int hw_is_mask(int var)
  644. {
  645. return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
  646. var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
  647. }
  648. static inline int hw_is_interval(int var)
  649. {
  650. return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
  651. var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
  652. }
  653. static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
  654. snd_pcm_hw_param_t var)
  655. {
  656. return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
  657. }
  658. static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
  659. snd_pcm_hw_param_t var)
  660. {
  661. return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
  662. }
  663. static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
  664. snd_pcm_hw_param_t var)
  665. {
  666. return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
  667. }
  668. static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
  669. snd_pcm_hw_param_t var)
  670. {
  671. return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
  672. }
  673. #define params_channels(p) \
  674. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
  675. #define params_rate(p) \
  676. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
  677. #define params_period_size(p) \
  678. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
  679. #define params_periods(p) \
  680. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
  681. #define params_buffer_size(p) \
  682. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
  683. #define params_buffer_bytes(p) \
  684. (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
  685. int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
  686. void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
  687. void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
  688. void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
  689. unsigned int k, struct snd_interval *c);
  690. void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
  691. const struct snd_interval *b, struct snd_interval *c);
  692. int snd_interval_list(struct snd_interval *i, unsigned int count,
  693. const unsigned int *list, unsigned int mask);
  694. int snd_interval_ratnum(struct snd_interval *i,
  695. unsigned int rats_count, struct snd_ratnum *rats,
  696. unsigned int *nump, unsigned int *denp);
  697. void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
  698. void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
  699. int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
  700. int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
  701. int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
  702. int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
  703. int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
  704. u_int32_t mask);
  705. int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
  706. u_int64_t mask);
  707. int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
  708. unsigned int min, unsigned int max);
  709. int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
  710. int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
  711. unsigned int cond,
  712. snd_pcm_hw_param_t var,
  713. const struct snd_pcm_hw_constraint_list *l);
  714. int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
  715. unsigned int cond,
  716. snd_pcm_hw_param_t var,
  717. struct snd_pcm_hw_constraint_ratnums *r);
  718. int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
  719. unsigned int cond,
  720. snd_pcm_hw_param_t var,
  721. struct snd_pcm_hw_constraint_ratdens *r);
  722. int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
  723. unsigned int cond,
  724. unsigned int width,
  725. unsigned int msbits);
  726. int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
  727. unsigned int cond,
  728. snd_pcm_hw_param_t var,
  729. unsigned long step);
  730. int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
  731. unsigned int cond,
  732. snd_pcm_hw_param_t var);
  733. int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
  734. unsigned int base_rate);
  735. int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
  736. unsigned int cond,
  737. int var,
  738. snd_pcm_hw_rule_func_t func, void *private,
  739. int dep, ...);
  740. int snd_pcm_format_signed(snd_pcm_format_t format);
  741. int snd_pcm_format_unsigned(snd_pcm_format_t format);
  742. int snd_pcm_format_linear(snd_pcm_format_t format);
  743. int snd_pcm_format_little_endian(snd_pcm_format_t format);
  744. int snd_pcm_format_big_endian(snd_pcm_format_t format);
  745. #if 0 /* just for DocBook */
  746. /**
  747. * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
  748. * @format: the format to check
  749. *
  750. * Returns 1 if the given PCM format is CPU-endian, 0 if
  751. * opposite, or a negative error code if endian not specified.
  752. */
  753. int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
  754. #endif /* DocBook */
  755. #ifdef SNDRV_LITTLE_ENDIAN
  756. #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
  757. #else
  758. #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
  759. #endif
  760. int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
  761. int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
  762. ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
  763. const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
  764. int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
  765. snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
  766. void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
  767. void snd_pcm_set_sync(struct snd_pcm_substream *substream);
  768. int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
  769. int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
  770. unsigned int cmd, void *arg);
  771. int snd_pcm_update_state(struct snd_pcm_substream *substream,
  772. struct snd_pcm_runtime *runtime);
  773. int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
  774. int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
  775. int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
  776. int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
  777. int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
  778. void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
  779. void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
  780. snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
  781. const void __user *buf,
  782. snd_pcm_uframes_t frames);
  783. snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
  784. void __user *buf, snd_pcm_uframes_t frames);
  785. snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
  786. void __user **bufs, snd_pcm_uframes_t frames);
  787. snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
  788. void __user **bufs, snd_pcm_uframes_t frames);
  789. extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
  790. int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
  791. unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
  792. unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
  793. static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
  794. struct snd_dma_buffer *bufp)
  795. {
  796. struct snd_pcm_runtime *runtime = substream->runtime;
  797. if (bufp) {
  798. runtime->dma_buffer_p = bufp;
  799. runtime->dma_area = bufp->area;
  800. runtime->dma_addr = bufp->addr;
  801. runtime->dma_bytes = bufp->bytes;
  802. } else {
  803. runtime->dma_buffer_p = NULL;
  804. runtime->dma_area = NULL;
  805. runtime->dma_addr = 0;
  806. runtime->dma_bytes = 0;
  807. }
  808. }
  809. /*
  810. * Timer interface
  811. */
  812. void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
  813. void snd_pcm_timer_init(struct snd_pcm_substream *substream);
  814. void snd_pcm_timer_done(struct snd_pcm_substream *substream);
  815. static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
  816. struct timespec *tv)
  817. {
  818. if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
  819. do_posix_clock_monotonic_gettime(tv);
  820. else
  821. getnstimeofday(tv);
  822. }
  823. /*
  824. * Memory
  825. */
  826. int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
  827. int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
  828. int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
  829. int type, struct device *data,
  830. size_t size, size_t max);
  831. int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
  832. int type, void *data,
  833. size_t size, size_t max);
  834. int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
  835. int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
  836. int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
  837. size_t size, gfp_t gfp_flags);
  838. int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
  839. struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
  840. unsigned long offset);
  841. #if 0 /* for kernel-doc */
  842. /**
  843. * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
  844. * @substream: the substream to allocate the buffer to
  845. * @size: the requested buffer size, in bytes
  846. *
  847. * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
  848. * contiguous in kernel virtual space, but not in physical memory. Use this
  849. * if the buffer is accessed by kernel code but not by device DMA.
  850. *
  851. * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
  852. * code.
  853. */
  854. static int snd_pcm_lib_alloc_vmalloc_buffer
  855. (struct snd_pcm_substream *substream, size_t size);
  856. /**
  857. * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
  858. * @substream: the substream to allocate the buffer to
  859. * @size: the requested buffer size, in bytes
  860. *
  861. * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
  862. * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
  863. */
  864. static int snd_pcm_lib_alloc_vmalloc_32_buffer
  865. (struct snd_pcm_substream *substream, size_t size);
  866. #endif
  867. #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
  868. _snd_pcm_lib_alloc_vmalloc_buffer \
  869. (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
  870. #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
  871. _snd_pcm_lib_alloc_vmalloc_buffer \
  872. (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
  873. #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
  874. #ifdef CONFIG_SND_DMA_SGBUF
  875. /*
  876. * SG-buffer handling
  877. */
  878. #define snd_pcm_substream_sgbuf(substream) \
  879. snd_pcm_get_dma_buf(substream)->private_data
  880. struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
  881. unsigned long offset);
  882. #else /* !SND_DMA_SGBUF */
  883. /*
  884. * fake using a continuous buffer
  885. */
  886. #define snd_pcm_sgbuf_ops_page NULL
  887. #endif /* SND_DMA_SGBUF */
  888. static inline dma_addr_t
  889. snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
  890. {
  891. return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
  892. }
  893. static inline void *
  894. snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
  895. {
  896. return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
  897. }
  898. static inline unsigned int
  899. snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
  900. unsigned int ofs, unsigned int size)
  901. {
  902. return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
  903. }
  904. /* handle mmap counter - PCM mmap callback should handle this counter properly */
  905. static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
  906. {
  907. struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
  908. atomic_inc(&substream->mmap_count);
  909. }
  910. static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
  911. {
  912. struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
  913. atomic_dec(&substream->mmap_count);
  914. }
  915. int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
  916. struct vm_area_struct *area);
  917. /* mmap for io-memory area */
  918. #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
  919. #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
  920. int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
  921. #else
  922. #define SNDRV_PCM_INFO_MMAP_IOMEM 0
  923. #define snd_pcm_lib_mmap_iomem NULL
  924. #endif
  925. #define snd_pcm_lib_mmap_vmalloc NULL
  926. static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
  927. {
  928. *max = dma < 4 ? 64 * 1024 : 128 * 1024;
  929. }
  930. /*
  931. * Misc
  932. */
  933. #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
  934. (IEC958_AES1_CON_ORIGINAL<<8)|\
  935. (IEC958_AES1_CON_PCM_CODER<<8)|\
  936. (IEC958_AES3_CON_FS_48000<<24))
  937. #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
  938. const char *snd_pcm_format_name(snd_pcm_format_t format);
  939. /**
  940. * snd_pcm_stream_str - Get a string naming the direction of a stream
  941. * @substream: the pcm substream instance
  942. */
  943. static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
  944. {
  945. if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
  946. return "Playback";
  947. else
  948. return "Capture";
  949. }
  950. /*
  951. * PCM channel-mapping control API
  952. */
  953. /* array element of channel maps */
  954. struct snd_pcm_chmap_elem {
  955. unsigned char channels;
  956. unsigned char map[15];
  957. };
  958. /* channel map information; retrieved via snd_kcontrol_chip() */
  959. struct snd_pcm_chmap {
  960. struct snd_pcm *pcm; /* assigned PCM instance */
  961. int stream; /* PLAYBACK or CAPTURE */
  962. struct snd_kcontrol *kctl;
  963. const struct snd_pcm_chmap_elem *chmap;
  964. unsigned int max_channels;
  965. unsigned int channel_mask; /* optional: active channels bitmask */
  966. void *private_data; /* optional: private data pointer */
  967. };
  968. /* get the PCM substream assigned to the given chmap info */
  969. static inline struct snd_pcm_substream *
  970. snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
  971. {
  972. struct snd_pcm_substream *s;
  973. for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
  974. if (s->number == idx)
  975. return s;
  976. return NULL;
  977. }
  978. /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
  979. extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
  980. /* Other world's standard channel maps (C/LFE prior to RL/RR) */
  981. extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
  982. /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
  983. #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
  984. #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
  985. #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
  986. int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
  987. const struct snd_pcm_chmap_elem *chmap,
  988. int max_channels,
  989. unsigned long private_value,
  990. struct snd_pcm_chmap **info_ret);
  991. #endif /* __SOUND_PCM_H */