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