xref: /openbmc/linux/include/sound/seq_device.h (revision e3b9f1e8)
1 #ifndef __SOUND_SEQ_DEVICE_H
2 #define __SOUND_SEQ_DEVICE_H
3 
4 /*
5  *  ALSA sequencer device management
6  *  Copyright (c) 1999 by Takashi Iwai <tiwai@suse.de>
7  *
8  *   This program is free software; you can redistribute it and/or modify
9  *   it under the terms of the GNU General Public License as published by
10  *   the Free Software Foundation; either version 2 of the License, or
11  *   (at your option) any later version.
12  *
13  *   This program is distributed in the hope that it will be useful,
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *   GNU General Public License for more details.
17  *
18  *   You should have received a copy of the GNU General Public License
19  *   along with this program; if not, write to the Free Software
20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21  *
22  */
23 
24 /*
25  * registered device information
26  */
27 
28 struct snd_seq_device {
29 	/* device info */
30 	struct snd_card *card;	/* sound card */
31 	int device;		/* device number */
32 	const char *id;		/* driver id */
33 	char name[80];		/* device name */
34 	int argsize;		/* size of the argument */
35 	void *driver_data;	/* private data for driver */
36 	void *private_data;	/* private data for the caller */
37 	void (*private_free)(struct snd_seq_device *device);
38 	struct device dev;
39 };
40 
41 #define to_seq_dev(_dev) \
42 	container_of(_dev, struct snd_seq_device, dev)
43 
44 /* sequencer driver */
45 
46 /* driver operators
47  * probe:
48  *	Initialize the device with given parameters.
49  *	Typically,
50  *		1. call snd_hwdep_new
51  *		2. allocate private data and initialize it
52  *		3. call snd_hwdep_register
53  *		4. store the instance to dev->driver_data pointer.
54  *
55  * remove:
56  *	Release the private data.
57  *	Typically, call snd_device_free(dev->card, dev->driver_data)
58  */
59 struct snd_seq_driver {
60 	struct device_driver driver;
61 	char *id;
62 	int argsize;
63 };
64 
65 #define to_seq_drv(_drv) \
66 	container_of(_drv, struct snd_seq_driver, driver)
67 
68 /*
69  * prototypes
70  */
71 #ifdef CONFIG_MODULES
72 void snd_seq_device_load_drivers(void);
73 #else
74 #define snd_seq_device_load_drivers()
75 #endif
76 int snd_seq_device_new(struct snd_card *card, int device, const char *id,
77 		       int argsize, struct snd_seq_device **result);
78 
79 #define SNDRV_SEQ_DEVICE_ARGPTR(dev) (void *)((char *)(dev) + sizeof(struct snd_seq_device))
80 
81 int __must_check __snd_seq_driver_register(struct snd_seq_driver *drv,
82 					   struct module *mod);
83 #define snd_seq_driver_register(drv) \
84 	__snd_seq_driver_register(drv, THIS_MODULE)
85 void snd_seq_driver_unregister(struct snd_seq_driver *drv);
86 
87 #define module_snd_seq_driver(drv) \
88 	module_driver(drv, snd_seq_driver_register, snd_seq_driver_unregister)
89 
90 /*
91  * id strings for generic devices
92  */
93 #define SNDRV_SEQ_DEV_ID_MIDISYNTH	"seq-midi"
94 #define SNDRV_SEQ_DEV_ID_OPL3		"opl3-synth"
95 
96 #endif /* __SOUND_SEQ_DEVICE_H */
97