xref: /OK3568_Linux_fs/kernel/include/sound/seq_device.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun #ifndef __SOUND_SEQ_DEVICE_H
3*4882a593Smuzhiyun #define __SOUND_SEQ_DEVICE_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun /*
6*4882a593Smuzhiyun  *  ALSA sequencer device management
7*4882a593Smuzhiyun  *  Copyright (c) 1999 by Takashi Iwai <tiwai@suse.de>
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun /*
11*4882a593Smuzhiyun  * registered device information
12*4882a593Smuzhiyun  */
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun struct snd_seq_device {
15*4882a593Smuzhiyun 	/* device info */
16*4882a593Smuzhiyun 	struct snd_card *card;	/* sound card */
17*4882a593Smuzhiyun 	int device;		/* device number */
18*4882a593Smuzhiyun 	const char *id;		/* driver id */
19*4882a593Smuzhiyun 	char name[80];		/* device name */
20*4882a593Smuzhiyun 	int argsize;		/* size of the argument */
21*4882a593Smuzhiyun 	void *driver_data;	/* private data for driver */
22*4882a593Smuzhiyun 	void *private_data;	/* private data for the caller */
23*4882a593Smuzhiyun 	void (*private_free)(struct snd_seq_device *device);
24*4882a593Smuzhiyun 	struct device dev;
25*4882a593Smuzhiyun };
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #define to_seq_dev(_dev) \
28*4882a593Smuzhiyun 	container_of(_dev, struct snd_seq_device, dev)
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun /* sequencer driver */
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun /* driver operators
33*4882a593Smuzhiyun  * probe:
34*4882a593Smuzhiyun  *	Initialize the device with given parameters.
35*4882a593Smuzhiyun  *	Typically,
36*4882a593Smuzhiyun  *		1. call snd_hwdep_new
37*4882a593Smuzhiyun  *		2. allocate private data and initialize it
38*4882a593Smuzhiyun  *		3. call snd_hwdep_register
39*4882a593Smuzhiyun  *		4. store the instance to dev->driver_data pointer.
40*4882a593Smuzhiyun  *
41*4882a593Smuzhiyun  * remove:
42*4882a593Smuzhiyun  *	Release the private data.
43*4882a593Smuzhiyun  *	Typically, call snd_device_free(dev->card, dev->driver_data)
44*4882a593Smuzhiyun  */
45*4882a593Smuzhiyun struct snd_seq_driver {
46*4882a593Smuzhiyun 	struct device_driver driver;
47*4882a593Smuzhiyun 	char *id;
48*4882a593Smuzhiyun 	int argsize;
49*4882a593Smuzhiyun };
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun #define to_seq_drv(_drv) \
52*4882a593Smuzhiyun 	container_of(_drv, struct snd_seq_driver, driver)
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun /*
55*4882a593Smuzhiyun  * prototypes
56*4882a593Smuzhiyun  */
57*4882a593Smuzhiyun #ifdef CONFIG_MODULES
58*4882a593Smuzhiyun void snd_seq_device_load_drivers(void);
59*4882a593Smuzhiyun #else
60*4882a593Smuzhiyun #define snd_seq_device_load_drivers()
61*4882a593Smuzhiyun #endif
62*4882a593Smuzhiyun int snd_seq_device_new(struct snd_card *card, int device, const char *id,
63*4882a593Smuzhiyun 		       int argsize, struct snd_seq_device **result);
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #define SNDRV_SEQ_DEVICE_ARGPTR(dev) (void *)((char *)(dev) + sizeof(struct snd_seq_device))
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun int __must_check __snd_seq_driver_register(struct snd_seq_driver *drv,
68*4882a593Smuzhiyun 					   struct module *mod);
69*4882a593Smuzhiyun #define snd_seq_driver_register(drv) \
70*4882a593Smuzhiyun 	__snd_seq_driver_register(drv, THIS_MODULE)
71*4882a593Smuzhiyun void snd_seq_driver_unregister(struct snd_seq_driver *drv);
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #define module_snd_seq_driver(drv) \
74*4882a593Smuzhiyun 	module_driver(drv, snd_seq_driver_register, snd_seq_driver_unregister)
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun /*
77*4882a593Smuzhiyun  * id strings for generic devices
78*4882a593Smuzhiyun  */
79*4882a593Smuzhiyun #define SNDRV_SEQ_DEV_ID_MIDISYNTH	"seq-midi"
80*4882a593Smuzhiyun #define SNDRV_SEQ_DEV_ID_OPL3		"opl3-synth"
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun #endif /* __SOUND_SEQ_DEVICE_H */
83