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