1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef __SOUND_CORE_H
3 #define __SOUND_CORE_H
4 
5 /*
6  *  Main header file for the ALSA driver
7  *  Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
8  */
9 
10 #include <linux/device.h>
11 #include <linux/sched.h>		/* wake_up() */
12 #include <linux/mutex.h>		/* struct mutex */
13 #include <linux/rwsem.h>		/* struct rw_semaphore */
14 #include <linux/pm.h>			/* pm_message_t */
15 #include <linux/stringify.h>
16 #include <linux/printk.h>
17 
18 /* number of supported soundcards */
19 #ifdef CONFIG_SND_DYNAMIC_MINORS
20 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS
21 #else
22 #define SNDRV_CARDS 8		/* don't change - minor numbers */
23 #endif
24 
25 #define CONFIG_SND_MAJOR	116	/* standard configuration */
26 
27 /* forward declarations */
28 struct pci_dev;
29 struct module;
30 struct completion;
31 
32 /* device allocation stuff */
33 
34 /* type of the object used in snd_device_*()
35  * this also defines the calling order
36  */
37 enum snd_device_type {
38 	SNDRV_DEV_LOWLEVEL,
39 	SNDRV_DEV_INFO,
40 	SNDRV_DEV_BUS,
41 	SNDRV_DEV_CODEC,
42 	SNDRV_DEV_PCM,
43 	SNDRV_DEV_COMPRESS,
44 	SNDRV_DEV_RAWMIDI,
45 	SNDRV_DEV_TIMER,
46 	SNDRV_DEV_SEQUENCER,
47 	SNDRV_DEV_HWDEP,
48 	SNDRV_DEV_JACK,
49 	SNDRV_DEV_CONTROL,	/* NOTE: this must be the last one */
50 };
51 
52 enum snd_device_state {
53 	SNDRV_DEV_BUILD,
54 	SNDRV_DEV_REGISTERED,
55 	SNDRV_DEV_DISCONNECTED,
56 };
57 
58 struct snd_device;
59 
60 struct snd_device_ops {
61 	int (*dev_free)(struct snd_device *dev);
62 	int (*dev_register)(struct snd_device *dev);
63 	int (*dev_disconnect)(struct snd_device *dev);
64 };
65 
66 struct snd_device {
67 	struct list_head list;		/* list of registered devices */
68 	struct snd_card *card;		/* card which holds this device */
69 	enum snd_device_state state;	/* state of the device */
70 	enum snd_device_type type;	/* device type */
71 	void *device_data;		/* device structure */
72 	const struct snd_device_ops *ops;	/* operations */
73 };
74 
75 #define snd_device(n) list_entry(n, struct snd_device, list)
76 
77 /* main structure for soundcard */
78 
79 struct snd_card {
80 	int number;			/* number of soundcard (index to
81 								snd_cards) */
82 
83 	char id[16];			/* id string of this card */
84 	char driver[16];		/* driver name */
85 	char shortname[32];		/* short name of this soundcard */
86 	char longname[80];		/* name of this soundcard */
87 	char irq_descr[32];		/* Interrupt description */
88 	char mixername[80];		/* mixer name */
89 	char components[128];		/* card components delimited with
90 								space */
91 	struct module *module;		/* top-level module */
92 
93 	void *private_data;		/* private data for soundcard */
94 	void (*private_free) (struct snd_card *card); /* callback for freeing of
95 								private data */
96 	struct list_head devices;	/* devices */
97 
98 	struct device ctl_dev;		/* control device */
99 	unsigned int last_numid;	/* last used numeric ID */
100 	struct rw_semaphore controls_rwsem;	/* controls list lock */
101 	rwlock_t ctl_files_rwlock;	/* ctl_files list lock */
102 	int controls_count;		/* count of all controls */
103 	size_t user_ctl_alloc_size;	// current memory allocation by user controls.
104 	struct list_head controls;	/* all controls for this card */
105 	struct list_head ctl_files;	/* active control files */
106 
107 	struct snd_info_entry *proc_root;	/* root for soundcard specific files */
108 	struct proc_dir_entry *proc_root_link;	/* number link to real id */
109 
110 	struct list_head files_list;	/* all files associated to this card */
111 	struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
112 								state */
113 	spinlock_t files_lock;		/* lock the files for this card */
114 	int shutdown;			/* this card is going down */
115 	struct completion *release_completion;
116 	struct device *dev;		/* device assigned to this card */
117 	struct device card_dev;		/* cardX object for sysfs */
118 	const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
119 	bool registered;		/* card_dev is registered? */
120 	bool managed;			/* managed via devres */
121 	bool releasing;			/* during card free process */
122 	int sync_irq;			/* assigned irq, used for PCM sync */
123 	wait_queue_head_t remove_sleep;
124 
125 	size_t total_pcm_alloc_bytes;	/* total amount of allocated buffers */
126 	struct mutex memory_mutex;	/* protection for the above */
127 #ifdef CONFIG_SND_DEBUG
128 	struct dentry *debugfs_root;    /* debugfs root for card */
129 #endif
130 
131 #ifdef CONFIG_PM
132 	unsigned int power_state;	/* power state */
133 	atomic_t power_ref;
134 	wait_queue_head_t power_sleep;
135 	wait_queue_head_t power_ref_sleep;
136 #endif
137 
138 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
139 	struct snd_mixer_oss *mixer_oss;
140 	int mixer_oss_change_count;
141 #endif
142 };
143 
144 #define dev_to_snd_card(p)	container_of(p, struct snd_card, card_dev)
145 
146 #ifdef CONFIG_PM
snd_power_get_state(struct snd_card * card)147 static inline unsigned int snd_power_get_state(struct snd_card *card)
148 {
149 	return READ_ONCE(card->power_state);
150 }
151 
snd_power_change_state(struct snd_card * card,unsigned int state)152 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
153 {
154 	WRITE_ONCE(card->power_state, state);
155 	wake_up(&card->power_sleep);
156 }
157 
158 /**
159  * snd_power_ref - Take the reference count for power control
160  * @card: sound card object
161  *
162  * The power_ref reference of the card is used for managing to block
163  * the snd_power_sync_ref() operation.  This function increments the reference.
164  * The counterpart snd_power_unref() has to be called appropriately later.
165  */
snd_power_ref(struct snd_card * card)166 static inline void snd_power_ref(struct snd_card *card)
167 {
168 	atomic_inc(&card->power_ref);
169 }
170 
171 /**
172  * snd_power_unref - Release the reference count for power control
173  * @card: sound card object
174  */
snd_power_unref(struct snd_card * card)175 static inline void snd_power_unref(struct snd_card *card)
176 {
177 	if (atomic_dec_and_test(&card->power_ref))
178 		wake_up(&card->power_ref_sleep);
179 }
180 
181 /**
182  * snd_power_sync_ref - wait until the card power_ref is freed
183  * @card: sound card object
184  *
185  * This function is used to synchronize with the pending power_ref being
186  * released.
187  */
snd_power_sync_ref(struct snd_card * card)188 static inline void snd_power_sync_ref(struct snd_card *card)
189 {
190 	wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));
191 }
192 
193 /* init.c */
194 int snd_power_wait(struct snd_card *card);
195 int snd_power_ref_and_wait(struct snd_card *card);
196 
197 #else /* ! CONFIG_PM */
198 
snd_power_wait(struct snd_card * card)199 static inline int snd_power_wait(struct snd_card *card) { return 0; }
snd_power_ref(struct snd_card * card)200 static inline void snd_power_ref(struct snd_card *card) {}
snd_power_unref(struct snd_card * card)201 static inline void snd_power_unref(struct snd_card *card) {}
snd_power_ref_and_wait(struct snd_card * card)202 static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }
snd_power_sync_ref(struct snd_card * card)203 static inline void snd_power_sync_ref(struct snd_card *card) {}
204 #define snd_power_get_state(card)	({ (void)(card); SNDRV_CTL_POWER_D0; })
205 #define snd_power_change_state(card, state)	do { (void)(card); } while (0)
206 
207 #endif /* CONFIG_PM */
208 
209 struct snd_minor {
210 	int type;			/* SNDRV_DEVICE_TYPE_XXX */
211 	int card;			/* card number */
212 	int device;			/* device number */
213 	const struct file_operations *f_ops;	/* file operations */
214 	void *private_data;		/* private data for f_ops->open */
215 	struct device *dev;		/* device for sysfs */
216 	struct snd_card *card_ptr;	/* assigned card instance */
217 };
218 
219 /* return a device pointer linked to each sound device as a parent */
snd_card_get_device_link(struct snd_card * card)220 static inline struct device *snd_card_get_device_link(struct snd_card *card)
221 {
222 	return card ? &card->card_dev : NULL;
223 }
224 
225 /* sound.c */
226 
227 extern int snd_major;
228 extern int snd_ecards_limit;
229 extern struct class *sound_class;
230 #ifdef CONFIG_SND_DEBUG
231 extern struct dentry *sound_debugfs_root;
232 #endif
233 
234 void snd_request_card(int card);
235 
236 void snd_device_initialize(struct device *dev, struct snd_card *card);
237 
238 int snd_register_device(int type, struct snd_card *card, int dev,
239 			const struct file_operations *f_ops,
240 			void *private_data, struct device *device);
241 int snd_unregister_device(struct device *dev);
242 void *snd_lookup_minor_data(unsigned int minor, int type);
243 
244 #ifdef CONFIG_SND_OSSEMUL
245 int snd_register_oss_device(int type, struct snd_card *card, int dev,
246 			    const struct file_operations *f_ops, void *private_data);
247 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
248 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
249 #endif
250 
251 int snd_minor_info_init(void);
252 
253 /* sound_oss.c */
254 
255 #ifdef CONFIG_SND_OSSEMUL
256 int snd_minor_info_oss_init(void);
257 #else
snd_minor_info_oss_init(void)258 static inline int snd_minor_info_oss_init(void) { return 0; }
259 #endif
260 
261 /* memory.c */
262 
263 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
264 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
265 
266 /* init.c */
267 
268 int snd_card_locked(int card);
269 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
270 #define SND_MIXER_OSS_NOTIFY_REGISTER	0
271 #define SND_MIXER_OSS_NOTIFY_DISCONNECT	1
272 #define SND_MIXER_OSS_NOTIFY_FREE	2
273 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
274 #endif
275 
276 int snd_card_new(struct device *parent, int idx, const char *xid,
277 		 struct module *module, int extra_size,
278 		 struct snd_card **card_ret);
279 int snd_devm_card_new(struct device *parent, int idx, const char *xid,
280 		      struct module *module, size_t extra_size,
281 		      struct snd_card **card_ret);
282 
283 int snd_card_disconnect(struct snd_card *card);
284 void snd_card_disconnect_sync(struct snd_card *card);
285 int snd_card_free(struct snd_card *card);
286 int snd_card_free_when_closed(struct snd_card *card);
287 void snd_card_set_id(struct snd_card *card, const char *id);
288 int snd_card_register(struct snd_card *card);
289 int snd_card_info_init(void);
290 int snd_card_add_dev_attr(struct snd_card *card,
291 			  const struct attribute_group *group);
292 int snd_component_add(struct snd_card *card, const char *component);
293 int snd_card_file_add(struct snd_card *card, struct file *file);
294 int snd_card_file_remove(struct snd_card *card, struct file *file);
295 
296 struct snd_card *snd_card_ref(int card);
297 
298 /**
299  * snd_card_unref - Unreference the card object
300  * @card: the card object to unreference
301  *
302  * Call this function for the card object that was obtained via snd_card_ref()
303  * or snd_lookup_minor_data().
304  */
snd_card_unref(struct snd_card * card)305 static inline void snd_card_unref(struct snd_card *card)
306 {
307 	put_device(&card->card_dev);
308 }
309 
310 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
311 
312 /* device.c */
313 
314 int snd_device_new(struct snd_card *card, enum snd_device_type type,
315 		   void *device_data, const struct snd_device_ops *ops);
316 int snd_device_register(struct snd_card *card, void *device_data);
317 int snd_device_register_all(struct snd_card *card);
318 void snd_device_disconnect(struct snd_card *card, void *device_data);
319 void snd_device_disconnect_all(struct snd_card *card);
320 void snd_device_free(struct snd_card *card, void *device_data);
321 void snd_device_free_all(struct snd_card *card);
322 int snd_device_get_state(struct snd_card *card, void *device_data);
323 
324 /* isadma.c */
325 
326 #ifdef CONFIG_ISA_DMA_API
327 #define DMA_MODE_NO_ENABLE	0x0100
328 
329 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
330 void snd_dma_disable(unsigned long dma);
331 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
332 int snd_devm_request_dma(struct device *dev, int dma, const char *name);
333 #endif
334 
335 /* misc.c */
336 struct resource;
337 void release_and_free_resource(struct resource *res);
338 
339 /* --- */
340 
341 /* sound printk debug levels */
342 enum {
343 	SND_PR_ALWAYS,
344 	SND_PR_DEBUG,
345 	SND_PR_VERBOSE,
346 };
347 
348 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
349 __printf(4, 5)
350 void __snd_printk(unsigned int level, const char *file, int line,
351 		  const char *format, ...);
352 #else
353 #define __snd_printk(level, file, line, format, ...) \
354 	printk(format, ##__VA_ARGS__)
355 #endif
356 
357 /**
358  * snd_printk - printk wrapper
359  * @fmt: format string
360  *
361  * Works like printk() but prints the file and the line of the caller
362  * when configured with CONFIG_SND_VERBOSE_PRINTK.
363  */
364 #define snd_printk(fmt, ...) \
365 	__snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
366 
367 #ifdef CONFIG_SND_DEBUG
368 /**
369  * snd_printd - debug printk
370  * @fmt: format string
371  *
372  * Works like snd_printk() for debugging purposes.
373  * Ignored when CONFIG_SND_DEBUG is not set.
374  */
375 #define snd_printd(fmt, ...) \
376 	__snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
377 #define _snd_printd(level, fmt, ...) \
378 	__snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
379 
380 /**
381  * snd_BUG - give a BUG warning message and stack trace
382  *
383  * Calls WARN() if CONFIG_SND_DEBUG is set.
384  * Ignored when CONFIG_SND_DEBUG is not set.
385  */
386 #define snd_BUG()		WARN(1, "BUG?\n")
387 
388 /**
389  * snd_printd_ratelimit - Suppress high rates of output when
390  * 			  CONFIG_SND_DEBUG is enabled.
391  */
392 #define snd_printd_ratelimit() printk_ratelimit()
393 
394 /**
395  * snd_BUG_ON - debugging check macro
396  * @cond: condition to evaluate
397  *
398  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
399  * otherwise just evaluates the conditional and returns the value.
400  */
401 #define snd_BUG_ON(cond)	WARN_ON((cond))
402 
403 #else /* !CONFIG_SND_DEBUG */
404 
405 __printf(1, 2)
snd_printd(const char * format,...)406 static inline void snd_printd(const char *format, ...) {}
407 __printf(2, 3)
_snd_printd(int level,const char * format,...)408 static inline void _snd_printd(int level, const char *format, ...) {}
409 
410 #define snd_BUG()			do { } while (0)
411 
412 #define snd_BUG_ON(condition) ({ \
413 	int __ret_warn_on = !!(condition); \
414 	unlikely(__ret_warn_on); \
415 })
416 
snd_printd_ratelimit(void)417 static inline bool snd_printd_ratelimit(void) { return false; }
418 
419 #endif /* CONFIG_SND_DEBUG */
420 
421 #ifdef CONFIG_SND_DEBUG_VERBOSE
422 /**
423  * snd_printdd - debug printk
424  * @format: format string
425  *
426  * Works like snd_printk() for debugging purposes.
427  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
428  */
429 #define snd_printdd(format, ...) \
430 	__snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
431 #else
432 __printf(1, 2)
snd_printdd(const char * format,...)433 static inline void snd_printdd(const char *format, ...) {}
434 #endif
435 
436 
437 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))	/* 3.8.1a */
438 
439 /* for easier backward-porting */
440 #if IS_ENABLED(CONFIG_GAMEPORT)
441 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
442 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
443 #define gameport_get_port_data(gp) (gp)->port_data
444 #endif
445 
446 /* PCI quirk list helper */
447 struct snd_pci_quirk {
448 	unsigned short subvendor;	/* PCI subvendor ID */
449 	unsigned short subdevice;	/* PCI subdevice ID */
450 	unsigned short subdevice_mask;	/* bitmask to match */
451 	int value;			/* value */
452 #ifdef CONFIG_SND_DEBUG_VERBOSE
453 	const char *name;		/* name of the device (optional) */
454 #endif
455 };
456 
457 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev)	\
458 	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
459 #define _SND_PCI_QUIRK_ID(vend, dev) \
460 	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
461 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
462 #ifdef CONFIG_SND_DEBUG_VERBOSE
463 #define SND_PCI_QUIRK(vend,dev,xname,val) \
464 	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
465 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
466 	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
467 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
468 	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),			\
469 			.value = (val), .name = (xname)}
470 #define snd_pci_quirk_name(q)	((q)->name)
471 #else
472 #define SND_PCI_QUIRK(vend,dev,xname,val) \
473 	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
474 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
475 	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
476 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
477 	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
478 #define snd_pci_quirk_name(q)	""
479 #endif
480 
481 #ifdef CONFIG_PCI
482 const struct snd_pci_quirk *
483 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
484 
485 const struct snd_pci_quirk *
486 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
487 			const struct snd_pci_quirk *list);
488 #else
489 static inline const struct snd_pci_quirk *
snd_pci_quirk_lookup(struct pci_dev * pci,const struct snd_pci_quirk * list)490 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
491 {
492 	return NULL;
493 }
494 
495 static inline const struct snd_pci_quirk *
snd_pci_quirk_lookup_id(u16 vendor,u16 device,const struct snd_pci_quirk * list)496 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
497 			const struct snd_pci_quirk *list)
498 {
499 	return NULL;
500 }
501 #endif
502 
503 #endif /* __SOUND_CORE_H */
504