[linux-2.6-block.git] / include / sound / seq_device.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __SOUND_SEQ_DEVICE_H
#define __SOUND_SEQ_DEVICE_H

/*
 *  ALSA sequencer device management
 *  Copyright (c) 1999 by Takashi Iwai <tiwai@suse.de>
 */

/*
 * registered device information
 */

struct snd_seq_device {
	/* device info */
	struct snd_card *card;	/* sound card */
	int device;		/* device number */
	const char *id;		/* driver id */
	char name[80];		/* device name */
	int argsize;		/* size of the argument */
	void *driver_data;	/* private data for driver */
	void *private_data;	/* private data for the caller */
	void (*private_free)(struct snd_seq_device *device);
	struct device dev;
};

#define to_seq_dev(_dev) \
	container_of(_dev, struct snd_seq_device, dev)

/* sequencer driver */

/* driver operators
 * probe:
 *	Initialize the device with given parameters.
 *	Typically,
 *		1. call snd_hwdep_new
 *		2. allocate private data and initialize it
 *		3. call snd_hwdep_register
 *		4. store the instance to dev->driver_data pointer.
 *		
 * remove:
 *	Release the private data.
 *	Typically, call snd_device_free(dev->card, dev->driver_data)
 */
struct snd_seq_driver {
	struct device_driver driver;
	char *id;
	int argsize;
};

#define to_seq_drv(_drv) \
	container_of(_drv, struct snd_seq_driver, driver)

/*
 * prototypes
 */
#ifdef CONFIG_MODULES
void snd_seq_device_load_drivers(void);
#else
#define snd_seq_device_load_drivers()
#endif
int snd_seq_device_new(struct snd_card *card, int device, const char *id,
		       int argsize, struct snd_seq_device **result);

#define SNDRV_SEQ_DEVICE_ARGPTR(dev) (void *)((char *)(dev) + sizeof(struct snd_seq_device))

int __must_check __snd_seq_driver_register(struct snd_seq_driver *drv,
					   struct module *mod);
#define snd_seq_driver_register(drv) \
	__snd_seq_driver_register(drv, THIS_MODULE)
void snd_seq_driver_unregister(struct snd_seq_driver *drv);

#define module_snd_seq_driver(drv) \
	module_driver(drv, snd_seq_driver_register, snd_seq_driver_unregister)

/*
 * id strings for generic devices
 */
#define SNDRV_SEQ_DEV_ID_MIDISYNTH	"seq-midi"
#define SNDRV_SEQ_DEV_ID_OPL3		"opl3-synth"

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