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/device.h> 30 #include <linux/stringify.h> 31 32 /* number of supported soundcards */ 33 #ifdef CONFIG_SND_DYNAMIC_MINORS 34 #define SNDRV_CARDS 32 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 #ifdef CONFIG_PCI 43 struct pci_dev; 44 #endif 45 struct module; 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 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 }; 194 195 /* return a device pointer linked to each sound device as a parent */ 196 static inline struct device *snd_card_get_device_link(struct snd_card *card) 197 { 198 return card ? card->card_dev : NULL; 199 } 200 201 /* sound.c */ 202 203 extern int snd_major; 204 extern int snd_ecards_limit; 205 extern struct class *sound_class; 206 207 void snd_request_card(int card); 208 209 int snd_register_device_for_dev(int type, struct snd_card *card, 210 int dev, 211 const struct file_operations *f_ops, 212 void *private_data, 213 const char *name, 214 struct device *device); 215 216 /** 217 * snd_register_device - Register the ALSA device file for the card 218 * @type: the device type, SNDRV_DEVICE_TYPE_XXX 219 * @card: the card instance 220 * @dev: the device index 221 * @f_ops: the file operations 222 * @private_data: user pointer for f_ops->open() 223 * @name: the device file name 224 * 225 * Registers an ALSA device file for the given card. 226 * The operators have to be set in reg parameter. 227 * 228 * This function uses the card's device pointer to link to the 229 * correct &struct device. 230 * 231 * Returns zero if successful, or a negative error code on failure. 232 */ 233 static inline int snd_register_device(int type, struct snd_card *card, int dev, 234 const struct file_operations *f_ops, 235 void *private_data, 236 const char *name) 237 { 238 return snd_register_device_for_dev(type, card, dev, f_ops, 239 private_data, name, 240 snd_card_get_device_link(card)); 241 } 242 243 int snd_unregister_device(int type, struct snd_card *card, int dev); 244 void *snd_lookup_minor_data(unsigned int minor, int type); 245 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev, 246 struct device_attribute *attr); 247 248 #ifdef CONFIG_SND_OSSEMUL 249 int snd_register_oss_device(int type, struct snd_card *card, int dev, 250 const struct file_operations *f_ops, void *private_data, 251 const char *name); 252 int snd_unregister_oss_device(int type, struct snd_card *card, int dev); 253 void *snd_lookup_oss_minor_data(unsigned int minor, int type); 254 #endif 255 256 int snd_minor_info_init(void); 257 int snd_minor_info_done(void); 258 259 /* sound_oss.c */ 260 261 #ifdef CONFIG_SND_OSSEMUL 262 int snd_minor_info_oss_init(void); 263 int snd_minor_info_oss_done(void); 264 #else 265 static inline int snd_minor_info_oss_init(void) { return 0; } 266 static inline int snd_minor_info_oss_done(void) { return 0; } 267 #endif 268 269 /* memory.c */ 270 271 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count); 272 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count); 273 274 /* init.c */ 275 276 extern struct snd_card *snd_cards[SNDRV_CARDS]; 277 int snd_card_locked(int card); 278 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE) 279 #define SND_MIXER_OSS_NOTIFY_REGISTER 0 280 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1 281 #define SND_MIXER_OSS_NOTIFY_FREE 2 282 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd); 283 #endif 284 285 int snd_card_create(int idx, const char *id, 286 struct module *module, int extra_size, 287 struct snd_card **card_ret); 288 289 int snd_card_disconnect(struct snd_card *card); 290 int snd_card_free(struct snd_card *card); 291 int snd_card_free_when_closed(struct snd_card *card); 292 void snd_card_set_id(struct snd_card *card, const char *id); 293 int snd_card_register(struct snd_card *card); 294 int snd_card_info_init(void); 295 int snd_card_info_done(void); 296 int snd_component_add(struct snd_card *card, const char *component); 297 int snd_card_file_add(struct snd_card *card, struct file *file); 298 int snd_card_file_remove(struct snd_card *card, struct file *file); 299 300 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr)) 301 302 /* device.c */ 303 304 int snd_device_new(struct snd_card *card, snd_device_type_t type, 305 void *device_data, struct snd_device_ops *ops); 306 int snd_device_register(struct snd_card *card, void *device_data); 307 int snd_device_register_all(struct snd_card *card); 308 int snd_device_disconnect(struct snd_card *card, void *device_data); 309 int snd_device_disconnect_all(struct snd_card *card); 310 int snd_device_free(struct snd_card *card, void *device_data); 311 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd); 312 313 /* isadma.c */ 314 315 #ifdef CONFIG_ISA_DMA_API 316 #define DMA_MODE_NO_ENABLE 0x0100 317 318 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode); 319 void snd_dma_disable(unsigned long dma); 320 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size); 321 #endif 322 323 /* misc.c */ 324 struct resource; 325 void release_and_free_resource(struct resource *res); 326 327 /* --- */ 328 329 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK) 330 __printf(4, 5) 331 void __snd_printk(unsigned int level, const char *file, int line, 332 const char *format, ...); 333 #else 334 #define __snd_printk(level, file, line, format, args...) \ 335 printk(format, ##args) 336 #endif 337 338 /** 339 * snd_printk - printk wrapper 340 * @fmt: format string 341 * 342 * Works like printk() but prints the file and the line of the caller 343 * when configured with CONFIG_SND_VERBOSE_PRINTK. 344 */ 345 #define snd_printk(fmt, args...) \ 346 __snd_printk(0, __FILE__, __LINE__, fmt, ##args) 347 348 #ifdef CONFIG_SND_DEBUG 349 /** 350 * snd_printd - debug printk 351 * @fmt: format string 352 * 353 * Works like snd_printk() for debugging purposes. 354 * Ignored when CONFIG_SND_DEBUG is not set. 355 */ 356 #define snd_printd(fmt, args...) \ 357 __snd_printk(1, __FILE__, __LINE__, fmt, ##args) 358 359 /** 360 * snd_BUG - give a BUG warning message and stack trace 361 * 362 * Calls WARN() if CONFIG_SND_DEBUG is set. 363 * Ignored when CONFIG_SND_DEBUG is not set. 364 */ 365 #define snd_BUG() WARN(1, "BUG?\n") 366 367 /** 368 * snd_BUG_ON - debugging check macro 369 * @cond: condition to evaluate 370 * 371 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition, 372 * and call WARN() and returns the value if it's non-zero. 373 * 374 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given 375 * condition is ignored. 376 * 377 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n. 378 * Thus, don't put any statement that influences on the code behavior, 379 * such as pre/post increment, to the argument of this macro. 380 * If you want to evaluate and give a warning, use standard WARN_ON(). 381 */ 382 #define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond)) 383 384 #else /* !CONFIG_SND_DEBUG */ 385 386 #define snd_printd(fmt, args...) do { } while (0) 387 #define snd_BUG() do { } while (0) 388 static inline int __snd_bug_on(int cond) 389 { 390 return 0; 391 } 392 #define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */ 393 394 #endif /* CONFIG_SND_DEBUG */ 395 396 #ifdef CONFIG_SND_DEBUG_VERBOSE 397 /** 398 * snd_printdd - debug printk 399 * @format: format string 400 * 401 * Works like snd_printk() for debugging purposes. 402 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set. 403 */ 404 #define snd_printdd(format, args...) \ 405 __snd_printk(2, __FILE__, __LINE__, format, ##args) 406 #else 407 #define snd_printdd(format, args...) do { } while (0) 408 #endif 409 410 411 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */ 412 413 /* for easier backward-porting */ 414 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE) 415 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev)) 416 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r)) 417 #define gameport_get_port_data(gp) (gp)->port_data 418 #endif 419 420 #ifdef CONFIG_PCI 421 /* PCI quirk list helper */ 422 struct snd_pci_quirk { 423 unsigned short subvendor; /* PCI subvendor ID */ 424 unsigned short subdevice; /* PCI subdevice ID */ 425 unsigned short subdevice_mask; /* bitmask to match */ 426 int value; /* value */ 427 #ifdef CONFIG_SND_DEBUG_VERBOSE 428 const char *name; /* name of the device (optional) */ 429 #endif 430 }; 431 432 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \ 433 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask) 434 #define _SND_PCI_QUIRK_ID(vend, dev) \ 435 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev) 436 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)} 437 #ifdef CONFIG_SND_DEBUG_VERBOSE 438 #define SND_PCI_QUIRK(vend,dev,xname,val) \ 439 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)} 440 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \ 441 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)} 442 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \ 443 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \ 444 .value = (val), .name = (xname)} 445 #else 446 #define SND_PCI_QUIRK(vend,dev,xname,val) \ 447 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)} 448 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \ 449 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)} 450 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \ 451 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)} 452 #endif 453 454 const struct snd_pci_quirk * 455 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list); 456 457 const struct snd_pci_quirk * 458 snd_pci_quirk_lookup_id(u16 vendor, u16 device, 459 const struct snd_pci_quirk *list); 460 #endif 461 462 #endif /* __SOUND_CORE_H */ 463