452 lines · c
1/* SPDX-License-Identifier: GPL-2.0-or-later */2#ifndef __SOUND_CORE_H3#define __SOUND_CORE_H4 5/*6 * Main header file for the ALSA driver7 * 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#include <linux/xarray.h>18 19/* number of supported soundcards */20#ifdef CONFIG_SND_DYNAMIC_MINORS21#define SNDRV_CARDS CONFIG_SND_MAX_CARDS22#else23#define SNDRV_CARDS 8 /* don't change - minor numbers */24#endif25 26#define CONFIG_SND_MAJOR 116 /* standard configuration */27 28/* forward declarations */29struct pci_dev;30struct module;31struct completion;32 33/* device allocation stuff */34 35/* type of the object used in snd_device_*()36 * this also defines the calling order37 */38enum snd_device_type {39 SNDRV_DEV_LOWLEVEL,40 SNDRV_DEV_INFO,41 SNDRV_DEV_BUS,42 SNDRV_DEV_CODEC,43 SNDRV_DEV_PCM,44 SNDRV_DEV_COMPRESS,45 SNDRV_DEV_RAWMIDI,46 SNDRV_DEV_TIMER,47 SNDRV_DEV_SEQUENCER,48 SNDRV_DEV_HWDEP,49 SNDRV_DEV_JACK,50 SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */51};52 53enum snd_device_state {54 SNDRV_DEV_BUILD,55 SNDRV_DEV_REGISTERED,56 SNDRV_DEV_DISCONNECTED,57};58 59struct snd_device;60 61struct snd_device_ops {62 int (*dev_free)(struct snd_device *dev);63 int (*dev_register)(struct snd_device *dev);64 int (*dev_disconnect)(struct snd_device *dev);65};66 67struct snd_device {68 struct list_head list; /* list of registered devices */69 struct snd_card *card; /* card which holds this device */70 enum snd_device_state state; /* state of the device */71 enum snd_device_type type; /* device type */72 void *device_data; /* device structure */73 const struct snd_device_ops *ops; /* operations */74};75 76#define snd_device(n) list_entry(n, struct snd_device, list)77 78/* main structure for soundcard */79 80struct snd_card {81 int number; /* number of soundcard (index to82 snd_cards) */83 84 char id[16]; /* id string of this card */85 char driver[16]; /* driver name */86 char shortname[32]; /* short name of this soundcard */87 char longname[80]; /* name of this soundcard */88 char irq_descr[32]; /* Interrupt description */89 char mixername[80]; /* mixer name */90 char components[128]; /* card components delimited with91 space */92 struct module *module; /* top-level module */93 94 void *private_data; /* private data for soundcard */95 void (*private_free) (struct snd_card *card); /* callback for freeing of96 private data */97 struct list_head devices; /* devices */98 99 struct device *ctl_dev; /* control device */100 unsigned int last_numid; /* last used numeric ID */101 struct rw_semaphore controls_rwsem; /* controls lock (list and values) */102 rwlock_t controls_rwlock; /* lock for lookup and ctl_files list */103 int controls_count; /* count of all controls */104 size_t user_ctl_alloc_size; // current memory allocation by user controls.105 struct list_head controls; /* all controls for this card */106 struct list_head ctl_files; /* active control files */107#ifdef CONFIG_SND_CTL_FAST_LOOKUP108 struct xarray ctl_numids; /* hash table for numids */109 struct xarray ctl_hash; /* hash table for ctl id matching */110 bool ctl_hash_collision; /* ctl_hash collision seen? */111#endif112 113 struct snd_info_entry *proc_root; /* root for soundcard specific files */114 struct proc_dir_entry *proc_root_link; /* number link to real id */115 116 struct list_head files_list; /* all files associated to this card */117 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown118 state */119 spinlock_t files_lock; /* lock the files for this card */120 int shutdown; /* this card is going down */121 struct completion *release_completion;122 struct device *dev; /* device assigned to this card */123 struct device card_dev; /* cardX object for sysfs */124 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */125 bool registered; /* card_dev is registered? */126 bool managed; /* managed via devres */127 bool releasing; /* during card free process */128 int sync_irq; /* assigned irq, used for PCM sync */129 wait_queue_head_t remove_sleep;130 131 size_t total_pcm_alloc_bytes; /* total amount of allocated buffers */132 struct mutex memory_mutex; /* protection for the above */133#ifdef CONFIG_SND_DEBUG134 struct dentry *debugfs_root; /* debugfs root for card */135#endif136 137#ifdef CONFIG_PM138 unsigned int power_state; /* power state */139 atomic_t power_ref;140 wait_queue_head_t power_sleep;141 wait_queue_head_t power_ref_sleep;142#endif143 144#if IS_ENABLED(CONFIG_SND_MIXER_OSS)145 struct snd_mixer_oss *mixer_oss;146 int mixer_oss_change_count;147#endif148};149 150#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)151 152#ifdef CONFIG_PM153static inline unsigned int snd_power_get_state(struct snd_card *card)154{155 return READ_ONCE(card->power_state);156}157 158static inline void snd_power_change_state(struct snd_card *card, unsigned int state)159{160 WRITE_ONCE(card->power_state, state);161 wake_up(&card->power_sleep);162}163 164/**165 * snd_power_ref - Take the reference count for power control166 * @card: sound card object167 *168 * The power_ref reference of the card is used for managing to block169 * the snd_power_sync_ref() operation. This function increments the reference.170 * The counterpart snd_power_unref() has to be called appropriately later.171 */172static inline void snd_power_ref(struct snd_card *card)173{174 atomic_inc(&card->power_ref);175}176 177/**178 * snd_power_unref - Release the reference count for power control179 * @card: sound card object180 */181static inline void snd_power_unref(struct snd_card *card)182{183 if (atomic_dec_and_test(&card->power_ref))184 wake_up(&card->power_ref_sleep);185}186 187/**188 * snd_power_sync_ref - wait until the card power_ref is freed189 * @card: sound card object190 *191 * This function is used to synchronize with the pending power_ref being192 * released.193 */194static inline void snd_power_sync_ref(struct snd_card *card)195{196 wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));197}198 199/* init.c */200int snd_power_wait(struct snd_card *card);201int snd_power_ref_and_wait(struct snd_card *card);202 203#else /* ! CONFIG_PM */204 205static inline int snd_power_wait(struct snd_card *card) { return 0; }206static inline void snd_power_ref(struct snd_card *card) {}207static inline void snd_power_unref(struct snd_card *card) {}208static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }209static inline void snd_power_sync_ref(struct snd_card *card) {}210#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })211#define snd_power_change_state(card, state) do { (void)(card); } while (0)212 213#endif /* CONFIG_PM */214 215struct snd_minor {216 int type; /* SNDRV_DEVICE_TYPE_XXX */217 int card; /* card number */218 int device; /* device number */219 const struct file_operations *f_ops; /* file operations */220 void *private_data; /* private data for f_ops->open */221 struct device *dev; /* device for sysfs */222 struct snd_card *card_ptr; /* assigned card instance */223};224 225/* return a device pointer linked to each sound device as a parent */226static inline struct device *snd_card_get_device_link(struct snd_card *card)227{228 return card ? &card->card_dev : NULL;229}230 231/* sound.c */232 233extern int snd_major;234extern int snd_ecards_limit;235extern const struct class sound_class;236#ifdef CONFIG_SND_DEBUG237extern struct dentry *sound_debugfs_root;238#endif239 240void snd_request_card(int card);241 242int snd_device_alloc(struct device **dev_p, struct snd_card *card);243 244int snd_register_device(int type, struct snd_card *card, int dev,245 const struct file_operations *f_ops,246 void *private_data, struct device *device);247int snd_unregister_device(struct device *dev);248void *snd_lookup_minor_data(unsigned int minor, int type);249 250#ifdef CONFIG_SND_OSSEMUL251int snd_register_oss_device(int type, struct snd_card *card, int dev,252 const struct file_operations *f_ops, void *private_data);253int snd_unregister_oss_device(int type, struct snd_card *card, int dev);254void *snd_lookup_oss_minor_data(unsigned int minor, int type);255#endif256 257int snd_minor_info_init(void);258 259/* sound_oss.c */260 261#ifdef CONFIG_SND_OSSEMUL262int snd_minor_info_oss_init(void);263#else264static inline int snd_minor_info_oss_init(void) { return 0; }265#endif266 267/* memory.c */268 269int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);270int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);271 272/* init.c */273 274int snd_card_locked(int card);275#if IS_ENABLED(CONFIG_SND_MIXER_OSS)276#define SND_MIXER_OSS_NOTIFY_REGISTER 0277#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1278#define SND_MIXER_OSS_NOTIFY_FREE 2279extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);280#endif281 282int snd_card_new(struct device *parent, int idx, const char *xid,283 struct module *module, int extra_size,284 struct snd_card **card_ret);285int snd_devm_card_new(struct device *parent, int idx, const char *xid,286 struct module *module, size_t extra_size,287 struct snd_card **card_ret);288 289void snd_card_disconnect(struct snd_card *card);290void snd_card_disconnect_sync(struct snd_card *card);291void snd_card_free(struct snd_card *card);292void snd_card_free_when_closed(struct snd_card *card);293int snd_card_free_on_error(struct device *dev, int ret);294void snd_card_set_id(struct snd_card *card, const char *id);295int snd_card_register(struct snd_card *card);296int snd_card_info_init(void);297int snd_card_add_dev_attr(struct snd_card *card,298 const struct attribute_group *group);299int snd_component_add(struct snd_card *card, const char *component);300int snd_card_file_add(struct snd_card *card, struct file *file);301int snd_card_file_remove(struct snd_card *card, struct file *file);302 303struct snd_card *snd_card_ref(int card);304 305/**306 * snd_card_unref - Unreference the card object307 * @card: the card object to unreference308 *309 * Call this function for the card object that was obtained via snd_card_ref()310 * or snd_lookup_minor_data().311 */312static inline void snd_card_unref(struct snd_card *card)313{314 put_device(&card->card_dev);315}316 317#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))318 319/* device.c */320 321int snd_device_new(struct snd_card *card, enum snd_device_type type,322 void *device_data, const struct snd_device_ops *ops);323int snd_device_register(struct snd_card *card, void *device_data);324int snd_device_register_all(struct snd_card *card);325void snd_device_disconnect(struct snd_card *card, void *device_data);326void snd_device_disconnect_all(struct snd_card *card);327void snd_device_free(struct snd_card *card, void *device_data);328void snd_device_free_all(struct snd_card *card);329int snd_device_get_state(struct snd_card *card, void *device_data);330 331/* isadma.c */332 333#ifdef CONFIG_ISA_DMA_API334#define DMA_MODE_NO_ENABLE 0x0100335 336void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);337void snd_dma_disable(unsigned long dma);338unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);339int snd_devm_request_dma(struct device *dev, int dma, const char *name);340#endif341 342/* misc.c */343struct resource;344void release_and_free_resource(struct resource *res);345 346/* --- */347 348#ifdef CONFIG_SND_DEBUG349/**350 * snd_BUG - give a BUG warning message and stack trace351 *352 * Calls WARN() if CONFIG_SND_DEBUG is set.353 * Ignored when CONFIG_SND_DEBUG is not set.354 */355#define snd_BUG() WARN(1, "BUG?\n")356 357/**358 * snd_BUG_ON - debugging check macro359 * @cond: condition to evaluate360 *361 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,362 * otherwise just evaluates the conditional and returns the value.363 */364#define snd_BUG_ON(cond) WARN_ON((cond))365 366#else /* !CONFIG_SND_DEBUG */367 368#define snd_BUG() do { } while (0)369 370#define snd_BUG_ON(condition) ({ \371 int __ret_warn_on = !!(condition); \372 unlikely(__ret_warn_on); \373})374 375#endif /* CONFIG_SND_DEBUG */376 377#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */378 379/* for easier backward-porting */380#if IS_ENABLED(CONFIG_GAMEPORT)381#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))382#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))383#define gameport_get_port_data(gp) (gp)->port_data384#endif385 386/* PCI quirk list helper */387struct snd_pci_quirk {388 unsigned short subvendor; /* PCI subvendor ID */389 unsigned short subdevice; /* PCI subdevice ID */390 unsigned short subdevice_mask; /* bitmask to match */391 int value; /* value */392#ifdef CONFIG_SND_DEBUG_VERBOSE393 const char *name; /* name of the device (optional) */394#endif395};396 397#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \398 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)399#define _SND_PCI_QUIRK_ID(vend, dev) \400 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)401#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}402#ifdef CONFIG_SND_DEBUG_VERBOSE403#define SND_PCI_QUIRK(vend,dev,xname,val) \404 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}405#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \406 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}407#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \408 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \409 .value = (val), .name = (xname)}410#define snd_pci_quirk_name(q) ((q)->name)411#else412#define SND_PCI_QUIRK(vend,dev,xname,val) \413 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}414#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \415 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}416#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \417 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}418#define snd_pci_quirk_name(q) ""419#endif420 421#ifdef CONFIG_PCI422const struct snd_pci_quirk *423snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);424 425const struct snd_pci_quirk *426snd_pci_quirk_lookup_id(u16 vendor, u16 device,427 const struct snd_pci_quirk *list);428#else429static inline const struct snd_pci_quirk *430snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)431{432 return NULL;433}434 435static inline const struct snd_pci_quirk *436snd_pci_quirk_lookup_id(u16 vendor, u16 device,437 const struct snd_pci_quirk *list)438{439 return NULL;440}441#endif442 443/* async signal helpers */444struct snd_fasync;445 446int snd_fasync_helper(int fd, struct file *file, int on,447 struct snd_fasync **fasyncp);448void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll);449void snd_fasync_free(struct snd_fasync *fasync);450 451#endif /* __SOUND_CORE_H */452