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