[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
 */

#define ID_LEN	32

/* status flag */
#define SNDRV_SEQ_DEVICE_FREE		0
#define SNDRV_SEQ_DEVICE_REGISTERED	1

struct snd_seq_device {
	/* device info */
	struct snd_card *card;	/* sound card */
	int device;		/* device number */
	char id[ID_LEN];	/* driver id */
	char name[80];		/* device name */
	int argsize;		/* size of the argument */
	void *driver_data;	/* private data for driver */
	int status;		/* flag - read only */
	void *private_data;	/* private data for the caller */
	void (*private_free)(struct snd_seq_device *device);
	struct list_head list;	/* link to next device */
	struct device dev;
};

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

/* driver operators
 * init_device:
 *	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.
 *		
 * free_device:
 *	Release the private data.
 *	Typically, call snd_device_free(dev->card, dev->driver_data)
 */
struct snd_seq_dev_ops {
	int (*init_device)(struct snd_seq_device *dev);
	int (*free_device)(struct snd_seq_device *dev);
};

/*
 * 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, char *id, int argsize, struct snd_seq_device **result);
int snd_seq_device_register_driver(char *id, struct snd_seq_dev_ops *entry, int argsize);
int snd_seq_device_unregister_driver(char *id);

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


/*
 * 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
	28	#define ID_LEN 32
	29
	30	/* status flag */
	31	#define SNDRV_SEQ_DEVICE_FREE 0
	32	#define SNDRV_SEQ_DEVICE_REGISTERED 1
	33
	34	struct snd_seq_device {
	35	/* device info */
c7e0b5bf	36	struct snd_card card; / sound card */
1da177e4 LT	37	int device; /* device number */
	38	char id[ID_LEN]; /* driver id */
	39	char name[80]; /* device name */
	40	int argsize; /* size of the argument */
	41	void driver_data; / private data for driver */
	42	int status; /* flag - read only */
	43	void private_data; / private data for the caller */
c7e0b5bf	44	void (private_free)(struct snd_seq_device device);
1da177e4	45	struct list_head list; /* link to next device */
7c37ae5c	46	struct device dev;
1da177e4 LT	47	};
1da177e4 LT	48
7c37ae5c TI	49	#define to_seq_dev(_dev) \
7c37ae5c TI	50	container_of(_dev, struct snd_seq_device, dev)
1da177e4 LT	51
	52	/* driver operators
	53	* init_device:
	54	* Initialize the device with given parameters.
	55	* Typically,
	56	* 1. call snd_hwdep_new
	57	* 2. allocate private data and initialize it
	58	* 3. call snd_hwdep_register
	59	* 4. store the instance to dev->driver_data pointer.
	60	*
	61	* free_device:
	62	* Release the private data.
	63	* Typically, call snd_device_free(dev->card, dev->driver_data)
	64	*/
	65	struct snd_seq_dev_ops {
c7e0b5bf TI	66	int (init_device)(struct snd_seq_device dev);
c7e0b5bf TI	67	int (free_device)(struct snd_seq_device dev);
1da177e4 LT	68	};
	69
	70	/*
	71	* prototypes
	72	*/
72496edc	73	#ifdef CONFIG_MODULES
1da177e4	74	void snd_seq_device_load_drivers(void);
72496edc TI	75	#else
	76	#define snd_seq_device_load_drivers()
	77	#endif
c7e0b5bf TI	78	int snd_seq_device_new(struct snd_card card, int device, char id, int argsize, struct snd_seq_device **result);
c7e0b5bf TI	79	int snd_seq_device_register_driver(char id, struct snd_seq_dev_ops entry, int argsize);
1da177e4 LT	80	int snd_seq_device_unregister_driver(char *id);
1da177e4 LT	81
c7e0b5bf	82	#define SNDRV_SEQ_DEVICE_ARGPTR(dev) (void )((char )(dev) + sizeof(struct snd_seq_device))
1da177e4 LT	83
	84
	85	/*
	86	* id strings for generic devices
	87	*/
	88	#define SNDRV_SEQ_DEV_ID_MIDISYNTH "seq-midi"
	89	#define SNDRV_SEQ_DEV_ID_OPL3 "opl3-synth"
	90
1da177e4	91	#endif /* __SOUND_SEQ_DEVICE_H */