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