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/sched.h> /* wake_up() */ 26 #include <linux/mutex.h> /* struct mutex */ 27 #include <linux/rwsem.h> /* struct rw_semaphore */ 28 #include <linux/pm.h> /* pm_message_t */ 29 #include <linux/stringify.h> 30 #include <linux/printk.h> 31 32 /* number of supported soundcards */ 33 #ifdef CONFIG_SND_DYNAMIC_MINORS 34 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS 35 #else 36 #define SNDRV_CARDS 8 /* don't change - minor numbers */ 37 #endif 38 39 #define CONFIG_SND_MAJOR 116 /* standard configuration */ 40 41 /* forward declarations */ 42 struct pci_dev; 43 struct module; 44 struct device; 45 struct device_attribute; 46 47 /* device allocation stuff */ 48 49 #define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000 50 51 typedef int __bitwise snd_device_type_t; 52 #define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0) 53 #define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1) 54 #define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2) 55 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000) 56 #define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001) 57 #define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002) 58 #define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003) 59 #define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004) 60 #define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005) 61 #define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006) 62 #define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007) 63 #define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008) 64 #define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009) 65 #define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A) 66 #define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000) 67 68 typedef int __bitwise snd_device_state_t; 69 #define SNDRV_DEV_BUILD ((__force snd_device_state_t) 0) 70 #define SNDRV_DEV_REGISTERED ((__force snd_device_state_t) 1) 71 #define SNDRV_DEV_DISCONNECTED ((__force snd_device_state_t) 2) 72 73 typedef int __bitwise snd_device_cmd_t; 74 #define SNDRV_DEV_CMD_PRE ((__force snd_device_cmd_t) 0) 75 #define SNDRV_DEV_CMD_NORMAL ((__force snd_device_cmd_t) 1) 76 #define SNDRV_DEV_CMD_POST ((__force snd_device_cmd_t) 2) 77 78 struct snd_device; 79 80 struct snd_device_ops { 81 int (*dev_free)(struct snd_device *dev); 82 int (*dev_register)(struct snd_device *dev); 83 int (*dev_disconnect)(struct snd_device *dev); 84 }; 85 86 struct snd_device { 87 struct list_head list; /* list of registered devices */ 88 struct snd_card *card; /* card which holds this device */ 89 snd_device_state_t state; /* state of the device */ 90 snd_device_type_t type; /* device type */ 91 void *device_data; /* device structure */ 92 struct snd_device_ops *ops; /* operations */ 93 }; 94 95 #define snd_device(n) list_entry(n, struct snd_device, list) 96 97 /* main structure for soundcard */ 98 99 struct snd_card { 100 int number; /* number of soundcard (index to 101 snd_cards) */ 102 103 char id[16]; /* id string of this card */ 104 char driver[16]; /* driver name */ 105 char shortname[32]; /* short name of this soundcard */ 106 char longname[80]; /* name of this soundcard */ 107 char mixername[80]; /* mixer name */ 108 char components[128]; /* card components delimited with 109 space */ 110 struct module *module; /* top-level module */ 111 112 void *private_data; /* private data for soundcard */ 113 void (*private_free) (struct snd_card *card); /* callback for freeing of 114 private data */ 115 struct list_head devices; /* devices */ 116 117 unsigned int last_numid; /* last used numeric ID */ 118 struct rw_semaphore controls_rwsem; /* controls list lock */ 119 rwlock_t ctl_files_rwlock; /* ctl_files list lock */ 120 int controls_count; /* count of all controls */ 121 int user_ctl_count; /* count of all user controls */ 122 struct list_head controls; /* all controls for this card */ 123 struct list_head ctl_files; /* active control files */ 124 125 struct snd_info_entry *proc_root; /* root for soundcard specific files */ 126 struct snd_info_entry *proc_id; /* the card id */ 127 struct proc_dir_entry *proc_root_link; /* number link to real id */ 128 129 struct list_head files_list; /* all files associated to this card */ 130 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown 131 state */ 132 spinlock_t files_lock; /* lock the files for this card */ 133 int shutdown; /* this card is going down */ 134 int free_on_last_close; /* free in context of file_release */ 135 wait_queue_head_t shutdown_sleep; 136 atomic_t refcount; /* refcount for disconnection */ 137 struct device *dev; /* device assigned to this card */ 138 struct device *card_dev; /* cardX object for sysfs */ 139 140 #ifdef CONFIG_PM 141 unsigned int power_state; /* power state */ 142 struct mutex power_lock; /* power lock */ 143 wait_queue_head_t power_sleep; 144 #endif 145 146 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE) 147 struct snd_mixer_oss *mixer_oss; 148 int mixer_oss_change_count; 149 #endif 150 }; 151 152 #ifdef CONFIG_PM 153 static inline void snd_power_lock(struct snd_card *card) 154 { 155 mutex_lock(&card->power_lock); 156 } 157 158 static inline void snd_power_unlock(struct snd_card *card) 159 { 160 mutex_unlock(&card->power_lock); 161 } 162 163 static inline unsigned int snd_power_get_state(struct snd_card *card) 164 { 165 return card->power_state; 166 } 167 168 static inline void snd_power_change_state(struct snd_card *card, unsigned int state) 169 { 170 card->power_state = state; 171 wake_up(&card->power_sleep); 172 } 173 174 /* init.c */ 175 int snd_power_wait(struct snd_card *card, unsigned int power_state); 176 177 #else /* ! CONFIG_PM */ 178 179 #define snd_power_lock(card) do { (void)(card); } while (0) 180 #define snd_power_unlock(card) do { (void)(card); } while (0) 181 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; } 182 #define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; }) 183 #define snd_power_change_state(card, state) do { (void)(card); } while (0) 184 185 #endif /* CONFIG_PM */ 186 187 struct snd_minor { 188 int type; /* SNDRV_DEVICE_TYPE_XXX */ 189 int card; /* card number */ 190 int device; /* device number */ 191 const struct file_operations *f_ops; /* file operations */ 192 void *private_data; /* private data for f_ops->open */ 193 struct device *dev; /* device for sysfs */ 194 struct snd_card *card_ptr; /* assigned card instance */ 195 }; 196 197 /* return a device pointer linked to each sound device as a parent */ 198 static inline struct device *snd_card_get_device_link(struct snd_card *card) 199 { 200 return card ? card->card_dev : NULL; 201 } 202 203 /* sound.c */ 204 205 extern int snd_major; 206 extern int snd_ecards_limit; 207 extern struct class *sound_class; 208 209 void snd_request_card(int card); 210 211 int snd_register_device_for_dev(int type, struct snd_card *card, 212 int dev, 213 const struct file_operations *f_ops, 214 void *private_data, 215 const char *name, 216 struct device *device); 217 218 /** 219 * snd_register_device - Register the ALSA device file for the card 220 * @type: the device type, SNDRV_DEVICE_TYPE_XXX 221 * @card: the card instance 222 * @dev: the device index 223 * @f_ops: the file operations 224 * @private_data: user pointer for f_ops->open() 225 * @name: the device file name 226 * 227 * Registers an ALSA device file for the given card. 228 * The operators have to be set in reg parameter. 229 * 230 * This function uses the card's device pointer to link to the 231 * correct &struct device. 232 * 233 * Return: Zero if successful, or a negative error code on failure. 234 */ 235 static inline int snd_register_device(int type, struct snd_card *card, int dev, 236 const struct file_operations *f_ops, 237 void *private_data, 238 const char *name) 239 { 240 return snd_register_device_for_dev(type, card, dev, f_ops, 241 private_data, name, 242 snd_card_get_device_link(card)); 243 } 244 245 int snd_unregister_device(int type, struct snd_card *card, int dev); 246 void *snd_lookup_minor_data(unsigned int minor, int type); 247 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev, 248 struct device_attribute *attr); 249 250 #ifdef CONFIG_SND_OSSEMUL 251 int snd_register_oss_device(int type, struct snd_card *card, int dev, 252 const struct file_operations *f_ops, void *private_data); 253 int snd_unregister_oss_device(int type, struct snd_card *card, int dev); 254 void *snd_lookup_oss_minor_data(unsigned int minor, int type); 255 #endif 256 257 int snd_minor_info_init(void); 258 int snd_minor_info_done(void); 259 260 /* sound_oss.c */ 261 262 #ifdef CONFIG_SND_OSSEMUL 263 int snd_minor_info_oss_init(void); 264 int snd_minor_info_oss_done(void); 265 #else 266 static inline int snd_minor_info_oss_init(void) { return 0; } 267 static inline int snd_minor_info_oss_done(void) { return 0; } 268 #endif 269 270 /* memory.c */ 271 272 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count); 273 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count); 274 275 /* init.c */ 276 277 extern struct snd_card *snd_cards[SNDRV_CARDS]; 278 int snd_card_locked(int card); 279 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE) 280 #define SND_MIXER_OSS_NOTIFY_REGISTER 0 281 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1 282 #define SND_MIXER_OSS_NOTIFY_FREE 2 283 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd); 284 #endif 285 286 int snd_card_new(struct device *parent, int idx, const char *xid, 287 struct module *module, int extra_size, 288 struct snd_card **card_ret); 289 290 static inline int __deprecated 291 snd_card_create(int idx, const char *id, struct module *module, int extra_size, 292 struct snd_card **ret) 293 { 294 return snd_card_new(NULL, idx, id, module, extra_size, ret); 295 } 296 297 int snd_card_disconnect(struct snd_card *card); 298 int snd_card_free(struct snd_card *card); 299 int snd_card_free_when_closed(struct snd_card *card); 300 void snd_card_set_id(struct snd_card *card, const char *id); 301 int snd_card_register(struct snd_card *card); 302 int snd_card_info_init(void); 303 int snd_card_info_done(void); 304 int snd_component_add(struct snd_card *card, const char *component); 305 int snd_card_file_add(struct snd_card *card, struct file *file); 306 int snd_card_file_remove(struct snd_card *card, struct file *file); 307 void snd_card_unref(struct snd_card *card); 308 309 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr)) 310 311 /* device.c */ 312 313 int snd_device_new(struct snd_card *card, snd_device_type_t type, 314 void *device_data, struct snd_device_ops *ops); 315 int snd_device_register(struct snd_card *card, void *device_data); 316 int snd_device_register_all(struct snd_card *card); 317 int snd_device_disconnect(struct snd_card *card, void *device_data); 318 int snd_device_disconnect_all(struct snd_card *card); 319 int snd_device_free(struct snd_card *card, void *device_data); 320 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd); 321 322 /* isadma.c */ 323 324 #ifdef CONFIG_ISA_DMA_API 325 #define DMA_MODE_NO_ENABLE 0x0100 326 327 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode); 328 void snd_dma_disable(unsigned long dma); 329 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size); 330 #endif 331 332 /* misc.c */ 333 struct resource; 334 void release_and_free_resource(struct resource *res); 335 336 /* --- */ 337 338 /* sound printk debug levels */ 339 enum { 340 SND_PR_ALWAYS, 341 SND_PR_DEBUG, 342 SND_PR_VERBOSE, 343 }; 344 345 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK) 346 __printf(4, 5) 347 void __snd_printk(unsigned int level, const char *file, int line, 348 const char *format, ...); 349 #else 350 #define __snd_printk(level, file, line, format, args...) \ 351 printk(format, ##args) 352 #endif 353 354 /** 355 * snd_printk - printk wrapper 356 * @fmt: format string 357 * 358 * Works like printk() but prints the file and the line of the caller 359 * when configured with CONFIG_SND_VERBOSE_PRINTK. 360 */ 361 #define snd_printk(fmt, args...) \ 362 __snd_printk(0, __FILE__, __LINE__, fmt, ##args) 363 364 #ifdef CONFIG_SND_DEBUG 365 /** 366 * snd_printd - debug printk 367 * @fmt: format string 368 * 369 * Works like snd_printk() for debugging purposes. 370 * Ignored when CONFIG_SND_DEBUG is not set. 371 */ 372 #define snd_printd(fmt, args...) \ 373 __snd_printk(1, __FILE__, __LINE__, fmt, ##args) 374 #define _snd_printd(level, fmt, args...) \ 375 __snd_printk(level, __FILE__, __LINE__, fmt, ##args) 376 377 /** 378 * snd_BUG - give a BUG warning message and stack trace 379 * 380 * Calls WARN() if CONFIG_SND_DEBUG is set. 381 * Ignored when CONFIG_SND_DEBUG is not set. 382 */ 383 #define snd_BUG() WARN(1, "BUG?\n") 384 385 /** 386 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled. 387 */ 388 #define snd_printd_ratelimit() printk_ratelimit() 389 390 /** 391 * snd_BUG_ON - debugging check macro 392 * @cond: condition to evaluate 393 * 394 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set, 395 * otherwise just evaluates the conditional and returns the value. 396 */ 397 #define snd_BUG_ON(cond) WARN_ON((cond)) 398 399 #else /* !CONFIG_SND_DEBUG */ 400 401 __printf(1, 2) 402 static inline void snd_printd(const char *format, ...) {} 403 __printf(2, 3) 404 static inline void _snd_printd(int level, const char *format, ...) {} 405 406 #define snd_BUG() do { } while (0) 407 408 #define snd_BUG_ON(condition) ({ \ 409 int __ret_warn_on = !!(condition); \ 410 unlikely(__ret_warn_on); \ 411 }) 412 413 static inline bool snd_printd_ratelimit(void) { return false; } 414 415 #endif /* CONFIG_SND_DEBUG */ 416 417 #ifdef CONFIG_SND_DEBUG_VERBOSE 418 /** 419 * snd_printdd - debug printk 420 * @format: format string 421 * 422 * Works like snd_printk() for debugging purposes. 423 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set. 424 */ 425 #define snd_printdd(format, args...) \ 426 __snd_printk(2, __FILE__, __LINE__, format, ##args) 427 #else 428 __printf(1, 2) 429 static inline void snd_printdd(const char *format, ...) {} 430 #endif 431 432 433 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */ 434 435 /* for easier backward-porting */ 436 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE) 437 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev)) 438 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r)) 439 #define gameport_get_port_data(gp) (gp)->port_data 440 #endif 441 442 #ifdef CONFIG_PCI 443 /* PCI quirk list helper */ 444 struct snd_pci_quirk { 445 unsigned short subvendor; /* PCI subvendor ID */ 446 unsigned short subdevice; /* PCI subdevice ID */ 447 unsigned short subdevice_mask; /* bitmask to match */ 448 int value; /* value */ 449 #ifdef CONFIG_SND_DEBUG_VERBOSE 450 const char *name; /* name of the device (optional) */ 451 #endif 452 }; 453 454 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \ 455 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask) 456 #define _SND_PCI_QUIRK_ID(vend, dev) \ 457 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev) 458 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)} 459 #ifdef CONFIG_SND_DEBUG_VERBOSE 460 #define SND_PCI_QUIRK(vend,dev,xname,val) \ 461 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)} 462 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \ 463 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)} 464 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \ 465 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \ 466 .value = (val), .name = (xname)} 467 #define snd_pci_quirk_name(q) ((q)->name) 468 #else 469 #define SND_PCI_QUIRK(vend,dev,xname,val) \ 470 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)} 471 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \ 472 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)} 473 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \ 474 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)} 475 #define snd_pci_quirk_name(q) "" 476 #endif 477 478 const struct snd_pci_quirk * 479 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list); 480 481 const struct snd_pci_quirk * 482 snd_pci_quirk_lookup_id(u16 vendor, u16 device, 483 const struct snd_pci_quirk *list); 484 #endif 485 486 #endif /* __SOUND_CORE_H */ 487