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@suse.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 30 /* forward declarations */ 31 #ifdef CONFIG_PCI 32 struct pci_dev; 33 #endif 34 #ifdef CONFIG_SBUS 35 struct sbus_dev; 36 #endif 37 38 /* device allocation stuff */ 39 40 #define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000 41 42 typedef int __bitwise snd_device_type_t; 43 #define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0) 44 #define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1) 45 #define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2) 46 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000) 47 #define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001) 48 #define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002) 49 #define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003) 50 #define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004) 51 #define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005) 52 #define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006) 53 #define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007) 54 #define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008) 55 #define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000) 56 57 typedef int __bitwise snd_device_state_t; 58 #define SNDRV_DEV_BUILD ((__force snd_device_state_t) 0) 59 #define SNDRV_DEV_REGISTERED ((__force snd_device_state_t) 1) 60 #define SNDRV_DEV_DISCONNECTED ((__force snd_device_state_t) 2) 61 62 typedef int __bitwise snd_device_cmd_t; 63 #define SNDRV_DEV_CMD_PRE ((__force snd_device_cmd_t) 0) 64 #define SNDRV_DEV_CMD_NORMAL ((__force snd_device_cmd_t) 1) 65 #define SNDRV_DEV_CMD_POST ((__force snd_device_cmd_t) 2) 66 67 struct snd_device; 68 69 struct snd_device_ops { 70 int (*dev_free)(struct snd_device *dev); 71 int (*dev_register)(struct snd_device *dev); 72 int (*dev_disconnect)(struct snd_device *dev); 73 }; 74 75 struct snd_device { 76 struct list_head list; /* list of registered devices */ 77 struct snd_card *card; /* card which holds this device */ 78 snd_device_state_t state; /* state of the device */ 79 snd_device_type_t type; /* device type */ 80 void *device_data; /* device structure */ 81 struct snd_device_ops *ops; /* operations */ 82 }; 83 84 #define snd_device(n) list_entry(n, struct snd_device, list) 85 86 /* monitor files for graceful shutdown (hotplug) */ 87 88 struct snd_monitor_file { 89 struct file *file; 90 struct snd_monitor_file *next; 91 }; 92 93 struct snd_shutdown_f_ops; /* define it later in init.c */ 94 95 /* main structure for soundcard */ 96 97 struct snd_card { 98 int number; /* number of soundcard (index to 99 snd_cards) */ 100 101 char id[16]; /* id string of this card */ 102 char driver[16]; /* driver name */ 103 char shortname[32]; /* short name of this soundcard */ 104 char longname[80]; /* name of this soundcard */ 105 char mixername[80]; /* mixer name */ 106 char components[80]; /* card components delimited with 107 space */ 108 struct module *module; /* top-level module */ 109 110 void *private_data; /* private data for soundcard */ 111 void (*private_free) (struct snd_card *card); /* callback for freeing of 112 private data */ 113 struct list_head devices; /* devices */ 114 115 unsigned int last_numid; /* last used numeric ID */ 116 struct rw_semaphore controls_rwsem; /* controls list lock */ 117 rwlock_t ctl_files_rwlock; /* ctl_files list lock */ 118 int controls_count; /* count of all controls */ 119 int user_ctl_count; /* count of all user controls */ 120 struct list_head controls; /* all controls for this card */ 121 struct list_head ctl_files; /* active control files */ 122 123 struct snd_info_entry *proc_root; /* root for soundcard specific files */ 124 struct snd_info_entry *proc_id; /* the card id */ 125 struct proc_dir_entry *proc_root_link; /* number link to real id */ 126 127 struct snd_monitor_file *files; /* all files associated to this card */ 128 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown 129 state */ 130 spinlock_t files_lock; /* lock the files for this card */ 131 int shutdown; /* this card is going down */ 132 int free_on_last_close; /* free in context of file_release */ 133 wait_queue_head_t shutdown_sleep; 134 struct device *dev; 135 136 #ifdef CONFIG_PM 137 unsigned int power_state; /* power state */ 138 struct mutex power_lock; /* power lock */ 139 wait_queue_head_t power_sleep; 140 #endif 141 142 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE) 143 struct snd_mixer_oss *mixer_oss; 144 int mixer_oss_change_count; 145 #endif 146 }; 147 148 #ifdef CONFIG_PM 149 static inline void snd_power_lock(struct snd_card *card) 150 { 151 mutex_lock(&card->power_lock); 152 } 153 154 static inline void snd_power_unlock(struct snd_card *card) 155 { 156 mutex_unlock(&card->power_lock); 157 } 158 159 static inline unsigned int snd_power_get_state(struct snd_card *card) 160 { 161 return card->power_state; 162 } 163 164 static inline void snd_power_change_state(struct snd_card *card, unsigned int state) 165 { 166 card->power_state = state; 167 wake_up(&card->power_sleep); 168 } 169 170 /* init.c */ 171 int snd_power_wait(struct snd_card *card, unsigned int power_state); 172 173 #else /* ! CONFIG_PM */ 174 175 #define snd_power_lock(card) do { (void)(card); } while (0) 176 #define snd_power_unlock(card) do { (void)(card); } while (0) 177 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; } 178 #define snd_power_get_state(card) SNDRV_CTL_POWER_D0 179 #define snd_power_change_state(card, state) do { (void)(card); } while (0) 180 181 #endif /* CONFIG_PM */ 182 183 struct snd_minor { 184 int type; /* SNDRV_DEVICE_TYPE_XXX */ 185 int card; /* card number */ 186 int device; /* device number */ 187 const struct file_operations *f_ops; /* file operations */ 188 void *private_data; /* private data for f_ops->open */ 189 }; 190 191 /* sound.c */ 192 193 extern int snd_major; 194 extern int snd_ecards_limit; 195 196 void snd_request_card(int card); 197 198 int snd_register_device(int type, struct snd_card *card, int dev, 199 const struct file_operations *f_ops, void *private_data, 200 const char *name); 201 int snd_unregister_device(int type, struct snd_card *card, int dev); 202 void *snd_lookup_minor_data(unsigned int minor, int type); 203 204 #ifdef CONFIG_SND_OSSEMUL 205 int snd_register_oss_device(int type, struct snd_card *card, int dev, 206 const struct file_operations *f_ops, void *private_data, 207 const char *name); 208 int snd_unregister_oss_device(int type, struct snd_card *card, int dev); 209 void *snd_lookup_oss_minor_data(unsigned int minor, int type); 210 #endif 211 212 int snd_minor_info_init(void); 213 int snd_minor_info_done(void); 214 215 /* sound_oss.c */ 216 217 #ifdef CONFIG_SND_OSSEMUL 218 int snd_minor_info_oss_init(void); 219 int snd_minor_info_oss_done(void); 220 #else 221 #define snd_minor_info_oss_init() /*NOP*/ 222 #define snd_minor_info_oss_done() /*NOP*/ 223 #endif 224 225 /* memory.c */ 226 227 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count); 228 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count); 229 230 /* init.c */ 231 232 extern struct snd_card *snd_cards[SNDRV_CARDS]; 233 int snd_card_locked(int card); 234 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE) 235 #define SND_MIXER_OSS_NOTIFY_REGISTER 0 236 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1 237 #define SND_MIXER_OSS_NOTIFY_FREE 2 238 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd); 239 #endif 240 241 struct snd_card *snd_card_new(int idx, const char *id, 242 struct module *module, int extra_size); 243 int snd_card_disconnect(struct snd_card *card); 244 int snd_card_free(struct snd_card *card); 245 int snd_card_free_when_closed(struct snd_card *card); 246 int snd_card_register(struct snd_card *card); 247 int snd_card_info_init(void); 248 int snd_card_info_done(void); 249 int snd_component_add(struct snd_card *card, const char *component); 250 int snd_card_file_add(struct snd_card *card, struct file *file); 251 int snd_card_file_remove(struct snd_card *card, struct file *file); 252 253 #ifndef snd_card_set_dev 254 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr)) 255 #endif 256 257 /* device.c */ 258 259 int snd_device_new(struct snd_card *card, snd_device_type_t type, 260 void *device_data, struct snd_device_ops *ops); 261 int snd_device_register(struct snd_card *card, void *device_data); 262 int snd_device_register_all(struct snd_card *card); 263 int snd_device_disconnect(struct snd_card *card, void *device_data); 264 int snd_device_disconnect_all(struct snd_card *card); 265 int snd_device_free(struct snd_card *card, void *device_data); 266 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd); 267 268 /* isadma.c */ 269 270 #ifdef CONFIG_ISA_DMA_API 271 #define DMA_MODE_NO_ENABLE 0x0100 272 273 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode); 274 void snd_dma_disable(unsigned long dma); 275 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size); 276 #endif 277 278 /* misc.c */ 279 struct resource; 280 void release_and_free_resource(struct resource *res); 281 282 #ifdef CONFIG_SND_VERBOSE_PRINTK 283 void snd_verbose_printk(const char *file, int line, const char *format, ...) 284 __attribute__ ((format (printf, 3, 4))); 285 #endif 286 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK) 287 void snd_verbose_printd(const char *file, int line, const char *format, ...) 288 __attribute__ ((format (printf, 3, 4))); 289 #endif 290 291 /* --- */ 292 293 #ifdef CONFIG_SND_VERBOSE_PRINTK 294 /** 295 * snd_printk - printk wrapper 296 * @fmt: format string 297 * 298 * Works like print() but prints the file and the line of the caller 299 * when configured with CONFIG_SND_VERBOSE_PRINTK. 300 */ 301 #define snd_printk(fmt, args...) \ 302 snd_verbose_printk(__FILE__, __LINE__, fmt ,##args) 303 #else 304 #define snd_printk(fmt, args...) \ 305 printk(fmt ,##args) 306 #endif 307 308 #ifdef CONFIG_SND_DEBUG 309 310 #define __ASTRING__(x) #x 311 312 #ifdef CONFIG_SND_VERBOSE_PRINTK 313 /** 314 * snd_printd - debug printk 315 * @fmt: format string 316 * 317 * Compiled only when Works like snd_printk() for debugging purpose. 318 * Ignored when CONFIG_SND_DEBUG is not set. 319 */ 320 #define snd_printd(fmt, args...) \ 321 snd_verbose_printd(__FILE__, __LINE__, fmt ,##args) 322 #else 323 #define snd_printd(fmt, args...) \ 324 printk(fmt ,##args) 325 #endif 326 /** 327 * snd_assert - run-time assertion macro 328 * @expr: expression 329 * 330 * This macro checks the expression in run-time and invokes the commands 331 * given in the rest arguments if the assertion is failed. 332 * When CONFIG_SND_DEBUG is not set, the expression is executed but 333 * not checked. 334 */ 335 #define snd_assert(expr, args...) do { \ 336 if (unlikely(!(expr))) { \ 337 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr)); \ 338 dump_stack(); \ 339 args; \ 340 } \ 341 } while (0) 342 343 #define snd_BUG() do { \ 344 snd_printk(KERN_ERR "BUG?\n"); \ 345 dump_stack(); \ 346 } while (0) 347 348 #else /* !CONFIG_SND_DEBUG */ 349 350 #define snd_printd(fmt, args...) /* nothing */ 351 #define snd_assert(expr, args...) (void)(expr) 352 #define snd_BUG() /* nothing */ 353 354 #endif /* CONFIG_SND_DEBUG */ 355 356 #ifdef CONFIG_SND_DEBUG_DETECT 357 /** 358 * snd_printdd - debug printk 359 * @format: format string 360 * 361 * Compiled only when Works like snd_printk() for debugging purpose. 362 * Ignored when CONFIG_SND_DEBUG_DETECT is not set. 363 */ 364 #define snd_printdd(format, args...) snd_printk(format, ##args) 365 #else 366 #define snd_printdd(format, args...) /* nothing */ 367 #endif 368 369 370 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */ 371 372 /* for easier backward-porting */ 373 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE) 374 #ifndef gameport_set_dev_parent 375 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev)) 376 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r)) 377 #define gameport_get_port_data(gp) (gp)->port_data 378 #endif 379 #endif 380 381 #include "typedefs.h" 382 383 #endif /* __SOUND_CORE_H */ 384