1 /* SPDX-License-Identifier: GPL-2.0-or-later */
6 * Main header file for the ALSA driver
7 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
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>
18 /* number of supported soundcards */
19 #ifdef CONFIG_SND_DYNAMIC_MINORS
20 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS
22 #define SNDRV_CARDS 8 /* don't change - minor numbers */
25 #define CONFIG_SND_MAJOR 116 /* standard configuration */
27 /* forward declarations */
32 /* device allocation stuff */
34 /* type of the object used in snd_device_*()
35 * this also defines the calling order
37 enum snd_device_type
{
49 SNDRV_DEV_CONTROL
, /* NOTE: this must be the last one */
52 enum snd_device_state
{
55 SNDRV_DEV_DISCONNECTED
,
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
);
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 */
75 #define snd_device(n) list_entry(n, struct snd_device, list)
77 /* main structure for soundcard */
80 int number
; /* number of soundcard (index to
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
91 struct module
*module
; /* top-level module */
93 void *private_data
; /* private data for soundcard */
94 void (*private_free
) (struct snd_card
*card
); /* callback for freeing of
96 struct list_head devices
; /* devices */
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 */
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 */
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
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 int sync_irq
; /* assigned irq, used for PCM sync */
121 wait_queue_head_t remove_sleep
;
123 size_t total_pcm_alloc_bytes
; /* total amount of allocated buffers */
124 struct mutex memory_mutex
; /* protection for the above */
125 #ifdef CONFIG_SND_DEBUG
126 struct dentry
*debugfs_root
; /* debugfs root for card */
130 unsigned int power_state
; /* power state */
131 wait_queue_head_t power_sleep
;
134 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
135 struct snd_mixer_oss
*mixer_oss
;
136 int mixer_oss_change_count
;
140 #define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
143 static inline unsigned int snd_power_get_state(struct snd_card
*card
)
145 return card
->power_state
;
148 static inline void snd_power_change_state(struct snd_card
*card
, unsigned int state
)
150 card
->power_state
= state
;
151 wake_up(&card
->power_sleep
);
155 int snd_power_wait(struct snd_card
*card
, unsigned int power_state
);
157 #else /* ! CONFIG_PM */
159 static inline int snd_power_wait(struct snd_card
*card
, unsigned int state
) { return 0; }
160 #define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
161 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
163 #endif /* CONFIG_PM */
166 int type
; /* SNDRV_DEVICE_TYPE_XXX */
167 int card
; /* card number */
168 int device
; /* device number */
169 const struct file_operations
*f_ops
; /* file operations */
170 void *private_data
; /* private data for f_ops->open */
171 struct device
*dev
; /* device for sysfs */
172 struct snd_card
*card_ptr
; /* assigned card instance */
175 /* return a device pointer linked to each sound device as a parent */
176 static inline struct device
*snd_card_get_device_link(struct snd_card
*card
)
178 return card
? &card
->card_dev
: NULL
;
183 extern int snd_major
;
184 extern int snd_ecards_limit
;
185 extern struct class *sound_class
;
186 #ifdef CONFIG_SND_DEBUG
187 extern struct dentry
*sound_debugfs_root
;
190 void snd_request_card(int card
);
192 void snd_device_initialize(struct device
*dev
, struct snd_card
*card
);
194 int snd_register_device(int type
, struct snd_card
*card
, int dev
,
195 const struct file_operations
*f_ops
,
196 void *private_data
, struct device
*device
);
197 int snd_unregister_device(struct device
*dev
);
198 void *snd_lookup_minor_data(unsigned int minor
, int type
);
200 #ifdef CONFIG_SND_OSSEMUL
201 int snd_register_oss_device(int type
, struct snd_card
*card
, int dev
,
202 const struct file_operations
*f_ops
, void *private_data
);
203 int snd_unregister_oss_device(int type
, struct snd_card
*card
, int dev
);
204 void *snd_lookup_oss_minor_data(unsigned int minor
, int type
);
207 int snd_minor_info_init(void);
211 #ifdef CONFIG_SND_OSSEMUL
212 int snd_minor_info_oss_init(void);
214 static inline int snd_minor_info_oss_init(void) { return 0; }
219 int copy_to_user_fromio(void __user
*dst
, const volatile void __iomem
*src
, size_t count
);
220 int copy_from_user_toio(volatile void __iomem
*dst
, const void __user
*src
, size_t count
);
224 int snd_card_locked(int card
);
225 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
226 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
227 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
228 #define SND_MIXER_OSS_NOTIFY_FREE 2
229 extern int (*snd_mixer_oss_notify_callback
)(struct snd_card
*card
, int cmd
);
232 int snd_card_new(struct device
*parent
, int idx
, const char *xid
,
233 struct module
*module
, int extra_size
,
234 struct snd_card
**card_ret
);
236 int snd_card_disconnect(struct snd_card
*card
);
237 void snd_card_disconnect_sync(struct snd_card
*card
);
238 int snd_card_free(struct snd_card
*card
);
239 int snd_card_free_when_closed(struct snd_card
*card
);
240 void snd_card_set_id(struct snd_card
*card
, const char *id
);
241 int snd_card_register(struct snd_card
*card
);
242 int snd_card_info_init(void);
243 int snd_card_add_dev_attr(struct snd_card
*card
,
244 const struct attribute_group
*group
);
245 int snd_component_add(struct snd_card
*card
, const char *component
);
246 int snd_card_file_add(struct snd_card
*card
, struct file
*file
);
247 int snd_card_file_remove(struct snd_card
*card
, struct file
*file
);
249 struct snd_card
*snd_card_ref(int card
);
252 * snd_card_unref - Unreference the card object
253 * @card: the card object to unreference
255 * Call this function for the card object that was obtained via snd_card_ref()
256 * or snd_lookup_minor_data().
258 static inline void snd_card_unref(struct snd_card
*card
)
260 put_device(&card
->card_dev
);
263 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
267 int snd_device_new(struct snd_card
*card
, enum snd_device_type type
,
268 void *device_data
, const struct snd_device_ops
*ops
);
269 int snd_device_register(struct snd_card
*card
, void *device_data
);
270 int snd_device_register_all(struct snd_card
*card
);
271 void snd_device_disconnect(struct snd_card
*card
, void *device_data
);
272 void snd_device_disconnect_all(struct snd_card
*card
);
273 void snd_device_free(struct snd_card
*card
, void *device_data
);
274 void snd_device_free_all(struct snd_card
*card
);
275 int snd_device_get_state(struct snd_card
*card
, void *device_data
);
279 #ifdef CONFIG_ISA_DMA_API
280 #define DMA_MODE_NO_ENABLE 0x0100
282 void snd_dma_program(unsigned long dma
, unsigned long addr
, unsigned int size
, unsigned short mode
);
283 void snd_dma_disable(unsigned long dma
);
284 unsigned int snd_dma_pointer(unsigned long dma
, unsigned int size
);
289 void release_and_free_resource(struct resource
*res
);
293 /* sound printk debug levels */
300 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
302 void __snd_printk(unsigned int level
, const char *file
, int line
,
303 const char *format
, ...);
305 #define __snd_printk(level, file, line, format, ...) \
306 printk(format, ##__VA_ARGS__)
310 * snd_printk - printk wrapper
311 * @fmt: format string
313 * Works like printk() but prints the file and the line of the caller
314 * when configured with CONFIG_SND_VERBOSE_PRINTK.
316 #define snd_printk(fmt, ...) \
317 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
319 #ifdef CONFIG_SND_DEBUG
321 * snd_printd - debug printk
322 * @fmt: format string
324 * Works like snd_printk() for debugging purposes.
325 * Ignored when CONFIG_SND_DEBUG is not set.
327 #define snd_printd(fmt, ...) \
328 __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
329 #define _snd_printd(level, fmt, ...) \
330 __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
333 * snd_BUG - give a BUG warning message and stack trace
335 * Calls WARN() if CONFIG_SND_DEBUG is set.
336 * Ignored when CONFIG_SND_DEBUG is not set.
338 #define snd_BUG() WARN(1, "BUG?\n")
341 * snd_printd_ratelimit - Suppress high rates of output when
342 * CONFIG_SND_DEBUG is enabled.
344 #define snd_printd_ratelimit() printk_ratelimit()
347 * snd_BUG_ON - debugging check macro
348 * @cond: condition to evaluate
350 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
351 * otherwise just evaluates the conditional and returns the value.
353 #define snd_BUG_ON(cond) WARN_ON((cond))
355 #else /* !CONFIG_SND_DEBUG */
358 static inline void snd_printd(const char *format
, ...) {}
360 static inline void _snd_printd(int level
, const char *format
, ...) {}
362 #define snd_BUG() do { } while (0)
364 #define snd_BUG_ON(condition) ({ \
365 int __ret_warn_on = !!(condition); \
366 unlikely(__ret_warn_on); \
369 static inline bool snd_printd_ratelimit(void) { return false; }
371 #endif /* CONFIG_SND_DEBUG */
373 #ifdef CONFIG_SND_DEBUG_VERBOSE
375 * snd_printdd - debug printk
376 * @format: format string
378 * Works like snd_printk() for debugging purposes.
379 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
381 #define snd_printdd(format, ...) \
382 __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
385 static inline void snd_printdd(const char *format
, ...) {}
389 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
391 /* for easier backward-porting */
392 #if IS_ENABLED(CONFIG_GAMEPORT)
393 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
394 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
395 #define gameport_get_port_data(gp) (gp)->port_data
398 /* PCI quirk list helper */
399 struct snd_pci_quirk
{
400 unsigned short subvendor
; /* PCI subvendor ID */
401 unsigned short subdevice
; /* PCI subdevice ID */
402 unsigned short subdevice_mask
; /* bitmask to match */
403 int value
; /* value */
404 #ifdef CONFIG_SND_DEBUG_VERBOSE
405 const char *name
; /* name of the device (optional) */
409 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
410 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
411 #define _SND_PCI_QUIRK_ID(vend, dev) \
412 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
413 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
414 #ifdef CONFIG_SND_DEBUG_VERBOSE
415 #define SND_PCI_QUIRK(vend,dev,xname,val) \
416 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
417 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
418 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
419 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
420 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
421 .value = (val), .name = (xname)}
422 #define snd_pci_quirk_name(q) ((q)->name)
424 #define SND_PCI_QUIRK(vend,dev,xname,val) \
425 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
426 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
427 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
428 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
429 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
430 #define snd_pci_quirk_name(q) ""
434 const struct snd_pci_quirk
*
435 snd_pci_quirk_lookup(struct pci_dev
*pci
, const struct snd_pci_quirk
*list
);
437 const struct snd_pci_quirk
*
438 snd_pci_quirk_lookup_id(u16 vendor
, u16 device
,
439 const struct snd_pci_quirk
*list
);
441 static inline const struct snd_pci_quirk
*
442 snd_pci_quirk_lookup(struct pci_dev
*pci
, const struct snd_pci_quirk
*list
)
447 static inline const struct snd_pci_quirk
*
448 snd_pci_quirk_lookup_id(u16 vendor
, u16 device
,
449 const struct snd_pci_quirk
*list
)
455 #endif /* __SOUND_CORE_H */