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