[mirror_ubuntu-bionic-kernel.git] / include / sound / seq_device.h

#ifndef __SOUND_SEQ_DEVICE_H
#define __SOUND_SEQ_DEVICE_H

/*
 *  ALSA sequencer device management
 *  Copyright (c) 1999 by Takashi Iwai <tiwai@suse.de>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

/*
 * 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
1da177e4 LT	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
1da177e4 LT	24	/*
	25	* registered device information
	26	*/
	27
1da177e4 LT	28	struct snd_seq_device {
1da177e4 LT	29	/* device info */
c7e0b5bf	30	struct snd_card card; / sound card */
1da177e4	31	int device; /* device number */
af03c243	32	const char id; / driver id */
1da177e4 LT	33	char name[80]; /* device name */
	34	int argsize; /* size of the argument */
	35	void driver_data; / private data for driver */
1da177e4	36	void private_data; / private data for the caller */
c7e0b5bf	37	void (private_free)(struct snd_seq_device device);
7c37ae5c	38	struct device dev;
1da177e4 LT	39	};
1da177e4 LT	40
7c37ae5c TI	41	#define to_seq_dev(_dev) \
7c37ae5c TI	42	container_of(_dev, struct snd_seq_device, dev)
1da177e4	43
05662205 TI	44	/* sequencer driver */
05662205 TI	45
1da177e4	46	/* driver operators
05662205	47	* probe:
1da177e4 LT	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	*
05662205	55	* remove:
1da177e4 LT	56	* Release the private data.
	57	* Typically, call snd_device_free(dev->card, dev->driver_data)
	58	*/
05662205 TI	59	struct snd_seq_driver {
	60	struct device_driver driver;
	61	char *id;
	62	int argsize;
1da177e4 LT	63	};
1da177e4 LT	64
05662205 TI	65	#define to_seq_drv(_drv) \
	66	container_of(_drv, struct snd_seq_driver, driver)
	67
1da177e4 LT	68	/*
	69	* prototypes
	70	*/
72496edc	71	#ifdef CONFIG_MODULES
1da177e4	72	void snd_seq_device_load_drivers(void);
72496edc TI	73	#else
	74	#define snd_seq_device_load_drivers()
	75	#endif
af03c243 TI	76	int snd_seq_device_new(struct snd_card card, int device, const char id,
af03c243 TI	77	int argsize, struct snd_seq_device **result);
1da177e4	78
c7e0b5bf	79	#define SNDRV_SEQ_DEVICE_ARGPTR(dev) (void )((char )(dev) + sizeof(struct snd_seq_device))
1da177e4	80
05662205 TI	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)
1da177e4 LT	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
1da177e4	96	#endif /* __SOUND_SEQ_DEVICE_H */