include/sound/core.h

   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         int sync_irq;                   /* assigned irq, used for PCM sync */
 121         wait_queue_head_t remove_sleep;
 122
 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 */
 127 #endif
 128
 129 #ifdef CONFIG_PM
 130         unsigned int power_state;       /* power state */
 131         atomic_t power_ref;
 132         wait_queue_head_t power_sleep;
 133         wait_queue_head_t power_ref_sleep;
 134 #endif
 135
 136 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 137         struct snd_mixer_oss *mixer_oss;
 138         int mixer_oss_change_count;
 139 #endif
 140 };
 141
 142 #define dev_to_snd_card(p)      container_of(p, struct snd_card, card_dev)
 143
 144 #ifdef CONFIG_PM
 145 static inline unsigned int snd_power_get_state(struct snd_card *card)
 146 {
 147         return READ_ONCE(card->power_state);
 148 }
 149
 150 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 151 {
 152         WRITE_ONCE(card->power_state, state);
 153         wake_up(&card->power_sleep);
 154 }
 155
 156 /**
 157  * snd_power_ref - Take the reference count for power control
 158  * @card: sound card object
 159  *
 160  * The power_ref reference of the card is used for managing to block
 161  * the snd_power_sync_ref() operation.  This function increments the reference.
 162  * The counterpart snd_power_unref() has to be called appropriately later.
 163  */
 164 static inline void snd_power_ref(struct snd_card *card)
 165 {
 166         atomic_inc(&card->power_ref);
 167 }
 168
 169 /**
 170  * snd_power_unref - Release the reference count for power control
 171  * @card: sound card object
 172  */
 173 static inline void snd_power_unref(struct snd_card *card)
 174 {
 175         if (atomic_dec_and_test(&card->power_ref))
 176                 wake_up(&card->power_ref_sleep);
 177 }
 178
 179 /**
 180  * snd_power_sync_ref - wait until the card power_ref is freed
 181  * @card: sound card object
 182  *
 183  * This function is used to synchronize with the pending power_ref being
 184  * released.
 185  */
 186 static inline void snd_power_sync_ref(struct snd_card *card)
 187 {
 188         wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));
 189 }
 190
 191 /* init.c */
 192 int snd_power_wait(struct snd_card *card);
 193 int snd_power_ref_and_wait(struct snd_card *card);
 194
 195 #else /* ! CONFIG_PM */
 196
 197 static inline int snd_power_wait(struct snd_card *card) { return 0; }
 198 static inline void snd_power_ref(struct snd_card *card) {}
 199 static inline void snd_power_unref(struct snd_card *card) {}
 200 static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }
 201 static inline void snd_power_sync_ref(struct snd_card *card) {}
 202 #define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
 203 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 204
 205 #endif /* CONFIG_PM */
 206
 207 struct snd_minor {
 208         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 209         int card;                       /* card number */
 210         int device;                     /* device number */
 211         const struct file_operations *f_ops;    /* file operations */
 212         void *private_data;             /* private data for f_ops->open */
 213         struct device *dev;             /* device for sysfs */
 214         struct snd_card *card_ptr;      /* assigned card instance */
 215 };
 216
 217 /* return a device pointer linked to each sound device as a parent */
 218 static inline struct device *snd_card_get_device_link(struct snd_card *card)
 219 {
 220         return card ? &card->card_dev : NULL;
 221 }
 222
 223 /* sound.c */
 224
 225 extern int snd_major;
 226 extern int snd_ecards_limit;
 227 extern struct class *sound_class;
 228 #ifdef CONFIG_SND_DEBUG
 229 extern struct dentry *sound_debugfs_root;
 230 #endif
 231
 232 void snd_request_card(int card);
 233
 234 void snd_device_initialize(struct device *dev, struct snd_card *card);
 235
 236 int snd_register_device(int type, struct snd_card *card, int dev,
 237                         const struct file_operations *f_ops,
 238                         void *private_data, struct device *device);
 239 int snd_unregister_device(struct device *dev);
 240 void *snd_lookup_minor_data(unsigned int minor, int type);
 241
 242 #ifdef CONFIG_SND_OSSEMUL
 243 int snd_register_oss_device(int type, struct snd_card *card, int dev,
 244                             const struct file_operations *f_ops, void *private_data);
 245 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 246 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 247 #endif
 248
 249 int snd_minor_info_init(void);
 250
 251 /* sound_oss.c */
 252
 253 #ifdef CONFIG_SND_OSSEMUL
 254 int snd_minor_info_oss_init(void);
 255 #else
 256 static inline int snd_minor_info_oss_init(void) { return 0; }
 257 #endif
 258
 259 /* memory.c */
 260
 261 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 262 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 263
 264 /* init.c */
 265
 266 int snd_card_locked(int card);
 267 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 268 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
 269 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 270 #define SND_MIXER_OSS_NOTIFY_FREE       2
 271 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 272 #endif
 273
 274 int snd_card_new(struct device *parent, int idx, const char *xid,
 275                  struct module *module, int extra_size,
 276                  struct snd_card **card_ret);
 277
 278 int snd_card_disconnect(struct snd_card *card);
 279 void snd_card_disconnect_sync(struct snd_card *card);
 280 int snd_card_free(struct snd_card *card);
 281 int snd_card_free_when_closed(struct snd_card *card);
 282 void snd_card_set_id(struct snd_card *card, const char *id);
 283 int snd_card_register(struct snd_card *card);
 284 int snd_card_info_init(void);
 285 int snd_card_add_dev_attr(struct snd_card *card,
 286                           const struct attribute_group *group);
 287 int snd_component_add(struct snd_card *card, const char *component);
 288 int snd_card_file_add(struct snd_card *card, struct file *file);
 289 int snd_card_file_remove(struct snd_card *card, struct file *file);
 290
 291 struct snd_card *snd_card_ref(int card);
 292
 293 /**
 294  * snd_card_unref - Unreference the card object
 295  * @card: the card object to unreference
 296  *
 297  * Call this function for the card object that was obtained via snd_card_ref()
 298  * or snd_lookup_minor_data().
 299  */
 300 static inline void snd_card_unref(struct snd_card *card)
 301 {
 302         put_device(&card->card_dev);
 303 }
 304
 305 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 306
 307 /* device.c */
 308
 309 int snd_device_new(struct snd_card *card, enum snd_device_type type,
 310                    void *device_data, const struct snd_device_ops *ops);
 311 int snd_device_register(struct snd_card *card, void *device_data);
 312 int snd_device_register_all(struct snd_card *card);
 313 void snd_device_disconnect(struct snd_card *card, void *device_data);
 314 void snd_device_disconnect_all(struct snd_card *card);
 315 void snd_device_free(struct snd_card *card, void *device_data);
 316 void snd_device_free_all(struct snd_card *card);
 317 int snd_device_get_state(struct snd_card *card, void *device_data);
 318
 319 /* isadma.c */
 320
 321 #ifdef CONFIG_ISA_DMA_API
 322 #define DMA_MODE_NO_ENABLE      0x0100
 323
 324 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 325 void snd_dma_disable(unsigned long dma);
 326 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 327 #endif
 328
 329 /* misc.c */
 330 struct resource;
 331 void release_and_free_resource(struct resource *res);
 332
 333 /* --- */
 334
 335 /* sound printk debug levels */
 336 enum {
 337         SND_PR_ALWAYS,
 338         SND_PR_DEBUG,
 339         SND_PR_VERBOSE,
 340 };
 341
 342 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 343 __printf(4, 5)
 344 void __snd_printk(unsigned int level, const char *file, int line,
 345                   const char *format, ...);
 346 #else
 347 #define __snd_printk(level, file, line, format, ...) \
 348         printk(format, ##__VA_ARGS__)
 349 #endif
 350
 351 /**
 352  * snd_printk - printk wrapper
 353  * @fmt: format string
 354  *
 355  * Works like printk() but prints the file and the line of the caller
 356  * when configured with CONFIG_SND_VERBOSE_PRINTK.
 357  */
 358 #define snd_printk(fmt, ...) \
 359         __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 360
 361 #ifdef CONFIG_SND_DEBUG
 362 /**
 363  * snd_printd - debug printk
 364  * @fmt: format string
 365  *
 366  * Works like snd_printk() for debugging purposes.
 367  * Ignored when CONFIG_SND_DEBUG is not set.
 368  */
 369 #define snd_printd(fmt, ...) \
 370         __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 371 #define _snd_printd(level, fmt, ...) \
 372         __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 373
 374 /**
 375  * snd_BUG - give a BUG warning message and stack trace
 376  *
 377  * Calls WARN() if CONFIG_SND_DEBUG is set.
 378  * Ignored when CONFIG_SND_DEBUG is not set.
 379  */
 380 #define snd_BUG()               WARN(1, "BUG?\n")
 381
 382 /**
 383  * snd_printd_ratelimit - Suppress high rates of output when
 384  *                        CONFIG_SND_DEBUG is enabled.
 385  */
 386 #define snd_printd_ratelimit() printk_ratelimit()
 387
 388 /**
 389  * snd_BUG_ON - debugging check macro
 390  * @cond: condition to evaluate
 391  *
 392  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
 393  * otherwise just evaluates the conditional and returns the value.
 394  */
 395 #define snd_BUG_ON(cond)        WARN_ON((cond))
 396
 397 #else /* !CONFIG_SND_DEBUG */
 398
 399 __printf(1, 2)
 400 static inline void snd_printd(const char *format, ...) {}
 401 __printf(2, 3)
 402 static inline void _snd_printd(int level, const char *format, ...) {}
 403
 404 #define snd_BUG()                       do { } while (0)
 405
 406 #define snd_BUG_ON(condition) ({ \
 407         int __ret_warn_on = !!(condition); \
 408         unlikely(__ret_warn_on); \
 409 })
 410
 411 static inline bool snd_printd_ratelimit(void) { return false; }
 412
 413 #endif /* CONFIG_SND_DEBUG */
 414
 415 #ifdef CONFIG_SND_DEBUG_VERBOSE
 416 /**
 417  * snd_printdd - debug printk
 418  * @format: format string
 419  *
 420  * Works like snd_printk() for debugging purposes.
 421  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 422  */
 423 #define snd_printdd(format, ...) \
 424         __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
 425 #else
 426 __printf(1, 2)
 427 static inline void snd_printdd(const char *format, ...) {}
 428 #endif
 429
 430
 431 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 432
 433 /* for easier backward-porting */
 434 #if IS_ENABLED(CONFIG_GAMEPORT)
 435 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 436 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 437 #define gameport_get_port_data(gp) (gp)->port_data
 438 #endif
 439
 440 /* PCI quirk list helper */
 441 struct snd_pci_quirk {
 442         unsigned short subvendor;       /* PCI subvendor ID */
 443         unsigned short subdevice;       /* PCI subdevice ID */
 444         unsigned short subdevice_mask;  /* bitmask to match */
 445         int value;                      /* value */
 446 #ifdef CONFIG_SND_DEBUG_VERBOSE
 447         const char *name;               /* name of the device (optional) */
 448 #endif
 449 };
 450
 451 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
 452         .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
 453 #define _SND_PCI_QUIRK_ID(vend, dev) \
 454         _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
 455 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 456 #ifdef CONFIG_SND_DEBUG_VERBOSE
 457 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 458         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 459 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 460         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
 461 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 462         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
 463                         .value = (val), .name = (xname)}
 464 #define snd_pci_quirk_name(q)   ((q)->name)
 465 #else
 466 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 467         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 468 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 469         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
 470 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 471         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 472 #define snd_pci_quirk_name(q)   ""
 473 #endif
 474
 475 #ifdef CONFIG_PCI
 476 const struct snd_pci_quirk *
 477 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 478
 479 const struct snd_pci_quirk *
 480 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 481                         const struct snd_pci_quirk *list);
 482 #else
 483 static inline const struct snd_pci_quirk *
 484 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
 485 {
 486         return NULL;
 487 }
 488
 489 static inline const struct snd_pci_quirk *
 490 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 491                         const struct snd_pci_quirk *list)
 492 {
 493         return NULL;
 494 }
 495 #endif
 496
 497 #endif /* __SOUND_CORE_H */