[linux.git] / include / sound / info.h

#ifndef __SOUND_INFO_H
#define __SOUND_INFO_H

/*
 *  Header file for info interface
 *  Copyright (c) by Jaroslav Kysela <[email protected]>
 *
 *
 *   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
 *
 */

#include <linux/poll.h>

/* buffer for information */
struct snd_info_buffer {
	char *buffer;		/* pointer to begin of buffer */
	unsigned int curr;	/* current position in buffer */
	unsigned int size;	/* current size */
	unsigned int len;	/* total length of buffer */
	int stop;		/* stop flag */
	int error;		/* error code */
};

#define SNDRV_INFO_CONTENT_TEXT		0
#define SNDRV_INFO_CONTENT_DATA		1

struct snd_info_entry;

struct snd_info_entry_text {
	void (*read)(struct snd_info_entry *entry,
		     struct snd_info_buffer *buffer);
	void (*write)(struct snd_info_entry *entry,
		      struct snd_info_buffer *buffer);
};

struct snd_info_entry_ops {
	int (*open)(struct snd_info_entry *entry,
		    unsigned short mode, void **file_private_data);
	int (*release)(struct snd_info_entry *entry,
		       unsigned short mode, void *file_private_data);
	ssize_t (*read)(struct snd_info_entry *entry, void *file_private_data,
			struct file *file, char __user *buf,
			size_t count, loff_t pos);
	ssize_t (*write)(struct snd_info_entry *entry, void *file_private_data,
			 struct file *file, const char __user *buf,
			 size_t count, loff_t pos);
	loff_t (*llseek)(struct snd_info_entry *entry,
			 void *file_private_data, struct file *file,
			 loff_t offset, int orig);
	unsigned int (*poll)(struct snd_info_entry *entry,
			     void *file_private_data, struct file *file,
			     poll_table *wait);
	int (*ioctl)(struct snd_info_entry *entry, void *file_private_data,
		     struct file *file, unsigned int cmd, unsigned long arg);
	int (*mmap)(struct snd_info_entry *entry, void *file_private_data,
		    struct inode *inode, struct file *file,
		    struct vm_area_struct *vma);
};

struct snd_info_entry {
	const char *name;
	umode_t mode;
	long size;
	unsigned short content;
	union {
		struct snd_info_entry_text text;
		struct snd_info_entry_ops *ops;
	} c;
	struct snd_info_entry *parent;
	struct snd_card *card;
	struct module *module;
	void *private_data;
	void (*private_free)(struct snd_info_entry *entry);
	struct proc_dir_entry *p;
	struct mutex access;
	struct list_head children;
	struct list_head list;
};

#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
int snd_info_minor_register(void);
int snd_info_minor_unregister(void);
#else
#define snd_info_minor_register() /* NOP */
#define snd_info_minor_unregister() /* NOP */
#endif


#ifdef CONFIG_PROC_FS

extern struct snd_info_entry *snd_seq_root;
#ifdef CONFIG_SND_OSSEMUL
extern struct snd_info_entry *snd_oss_root;
void snd_card_info_read_oss(struct snd_info_buffer *buffer);
#else
#define snd_oss_root NULL
static inline void snd_card_info_read_oss(struct snd_info_buffer *buffer) {}
#endif

__printf(2, 3)
int snd_iprintf(struct snd_info_buffer *buffer, const char *fmt, ...);
int snd_info_init(void);
int snd_info_done(void);

int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len);
const char *snd_info_get_str(char *dest, const char *src, int len);
struct snd_info_entry *snd_info_create_module_entry(struct module *module,
					       const char *name,
					       struct snd_info_entry *parent);
struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
					     const char *name,
					     struct snd_info_entry *parent);
void snd_info_free_entry(struct snd_info_entry *entry);
int snd_info_store_text(struct snd_info_entry *entry);
int snd_info_restore_text(struct snd_info_entry *entry);

int snd_info_card_create(struct snd_card *card);
int snd_info_card_register(struct snd_card *card);
int snd_info_card_free(struct snd_card *card);
void snd_info_card_disconnect(struct snd_card *card);
void snd_info_card_id_change(struct snd_card *card);
int snd_info_register(struct snd_info_entry *entry);

/* for card drivers */
int snd_card_proc_new(struct snd_card *card, const char *name,
		      struct snd_info_entry **entryp);

static inline void snd_info_set_text_ops(struct snd_info_entry *entry, 
	void *private_data,
	void (*read)(struct snd_info_entry *, struct snd_info_buffer *))
{
	entry->private_data = private_data;
	entry->c.text.read = read;
}

int snd_info_check_reserved_words(const char *str);

#else

#define snd_seq_root NULL
#define snd_oss_root NULL

static inline int snd_iprintf(struct snd_info_buffer *buffer, char *fmt, ...) { return 0; }
static inline int snd_info_init(void) { return 0; }
static inline int snd_info_done(void) { return 0; }

static inline int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len) { return 0; }
static inline char *snd_info_get_str(char *dest, char *src, int len) { return NULL; }
static inline struct snd_info_entry *snd_info_create_module_entry(struct module *module, const char *name, struct snd_info_entry *parent) { return NULL; }
static inline struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card, const char *name, struct snd_info_entry *parent) { return NULL; }
static inline void snd_info_free_entry(struct snd_info_entry *entry) { ; }

static inline int snd_info_card_create(struct snd_card *card) { return 0; }
static inline int snd_info_card_register(struct snd_card *card) { return 0; }
static inline int snd_info_card_free(struct snd_card *card) { return 0; }
static inline void snd_info_card_disconnect(struct snd_card *card) { }
static inline void snd_info_card_id_change(struct snd_card *card) { }
static inline int snd_info_register(struct snd_info_entry *entry) { return 0; }

static inline int snd_card_proc_new(struct snd_card *card, const char *name,
				    struct snd_info_entry **entryp) { return -EINVAL; }
static inline void snd_info_set_text_ops(struct snd_info_entry *entry __attribute__((unused)),
					 void *private_data,
					 void (*read)(struct snd_info_entry *, struct snd_info_buffer *)) {}

static inline int snd_info_check_reserved_words(const char *str) { return 1; }

#endif

/*
 * OSS info part
 */

#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)

#define SNDRV_OSS_INFO_DEV_AUDIO	0
#define SNDRV_OSS_INFO_DEV_SYNTH	1
#define SNDRV_OSS_INFO_DEV_MIDI		2
#define SNDRV_OSS_INFO_DEV_TIMERS	4
#define SNDRV_OSS_INFO_DEV_MIXERS	5

#define SNDRV_OSS_INFO_DEV_COUNT	6

int snd_oss_info_register(int dev, int num, char *string);
#define snd_oss_info_unregister(dev, num) snd_oss_info_register(dev, num, NULL)

#endif /* CONFIG_SND_OSSEMUL && CONFIG_PROC_FS */

#endif /* __SOUND_INFO_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_INFO_H
	2	#define __SOUND_INFO_H
	3
	4	/*
	5	* Header file for info interface
c1017a4c	6	* Copyright (c) by Jaroslav Kysela <[email protected]>
1da177e4 LT	7	*
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*
	23	*/
	24
	25	#include <linux/poll.h>
	26
	27	/* buffer for information */
	28	struct snd_info_buffer {
	29	char buffer; / pointer to begin of buffer */
7e4eeec8 TI	30	unsigned int curr; /* current position in buffer */
	31	unsigned int size; /* current size */
	32	unsigned int len; /* total length of buffer */
1da177e4 LT	33	int stop; /* stop flag */
	34	int error; /* error code */
	35	};
	36
1da177e4 LT	37	#define SNDRV_INFO_CONTENT_TEXT 0
	38	#define SNDRV_INFO_CONTENT_DATA 1
	39
	40	struct snd_info_entry;
	41
	42	struct snd_info_entry_text {
fd64138c JK	43	void (read)(struct snd_info_entry entry,
	44	struct snd_info_buffer *buffer);
	45	void (write)(struct snd_info_entry entry,
	46	struct snd_info_buffer *buffer);
1da177e4 LT	47	};
	48
	49	struct snd_info_entry_ops {
fd64138c JK	50	int (open)(struct snd_info_entry entry,
	51	unsigned short mode, void **file_private_data);
	52	int (release)(struct snd_info_entry entry,
	53	unsigned short mode, void *file_private_data);
24e4a121 TI	54	ssize_t (read)(struct snd_info_entry entry, void *file_private_data,
	55	struct file file, char __user buf,
	56	size_t count, loff_t pos);
	57	ssize_t (write)(struct snd_info_entry entry, void *file_private_data,
	58	struct file file, const char __user buf,
	59	size_t count, loff_t pos);
	60	loff_t (llseek)(struct snd_info_entry entry,
	61	void file_private_data, struct file file,
	62	loff_t offset, int orig);
	63	unsigned int (poll)(struct snd_info_entry entry,
	64	void file_private_data, struct file file,
	65	poll_table *wait);
fd64138c JK	66	int (ioctl)(struct snd_info_entry entry, void *file_private_data,
	67	struct file *file, unsigned int cmd, unsigned long arg);
	68	int (mmap)(struct snd_info_entry entry, void *file_private_data,
	69	struct inode inode, struct file file,
	70	struct vm_area_struct *vma);
1da177e4 LT	71	};
	72
	73	struct snd_info_entry {
	74	const char *name;
d161a13f	75	umode_t mode;
1da177e4 LT	76	long size;
1da177e4 LT	77	unsigned short content;
1da177e4 LT	78	union {
	79	struct snd_info_entry_text text;
	80	struct snd_info_entry_ops *ops;
	81	} c;
24c1f931 TI	82	struct snd_info_entry *parent;
24c1f931 TI	83	struct snd_card *card;
1da177e4 LT	84	struct module *module;
1da177e4 LT	85	void *private_data;
24c1f931	86	void (private_free)(struct snd_info_entry entry);
1da177e4	87	struct proc_dir_entry *p;
1a60d4c5	88	struct mutex access;
746d4a02 TI	89	struct list_head children;
746d4a02 TI	90	struct list_head list;
1da177e4 LT	91	};
1da177e4 LT	92
1da177e4	93	#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
24c1f931 TI	94	int snd_info_minor_register(void);
24c1f931 TI	95	int snd_info_minor_unregister(void);
1da177e4 LT	96	#else
	97	#define snd_info_minor_register() /* NOP */
	98	#define snd_info_minor_unregister() /* NOP */
	99	#endif
	100
	101
	102	#ifdef CONFIG_PROC_FS
	103
24c1f931	104	extern struct snd_info_entry *snd_seq_root;
1da177e4	105	#ifdef CONFIG_SND_OSSEMUL
24c1f931	106	extern struct snd_info_entry *snd_oss_root;
36b9cdfe	107	void snd_card_info_read_oss(struct snd_info_buffer *buffer);
1da177e4 LT	108	#else
1da177e4 LT	109	#define snd_oss_root NULL
36b9cdfe	110	static inline void snd_card_info_read_oss(struct snd_info_buffer *buffer) {}
1da177e4 LT	111	#endif
1da177e4 LT	112
b9075fa9 JP	113	__printf(2, 3)
b9075fa9 JP	114	int snd_iprintf(struct snd_info_buffer buffer, const char fmt, ...);
1da177e4 LT	115	int snd_info_init(void);
	116	int snd_info_done(void);
	117
fd64138c	118	int snd_info_get_line(struct snd_info_buffer buffer, char line, int len);
4f7454a9	119	const char snd_info_get_str(char dest, const char *src, int len);
fd64138c	120	struct snd_info_entry snd_info_create_module_entry(struct module module,
1da177e4	121	const char *name,
fd64138c JK	122	struct snd_info_entry *parent);
fd64138c JK	123	struct snd_info_entry snd_info_create_card_entry(struct snd_card card,
1da177e4	124	const char *name,
fd64138c JK	125	struct snd_info_entry *parent);
	126	void snd_info_free_entry(struct snd_info_entry *entry);
	127	int snd_info_store_text(struct snd_info_entry *entry);
	128	int snd_info_restore_text(struct snd_info_entry *entry);
	129
	130	int snd_info_card_create(struct snd_card *card);
	131	int snd_info_card_register(struct snd_card *card);
	132	int snd_info_card_free(struct snd_card *card);
	133	void snd_info_card_disconnect(struct snd_card *card);
	134	void snd_info_card_id_change(struct snd_card *card);
	135	int snd_info_register(struct snd_info_entry *entry);
1da177e4 LT	136
1da177e4 LT	137	/* for card drivers */
fd64138c JK	138	int snd_card_proc_new(struct snd_card card, const char name,
fd64138c JK	139	struct snd_info_entry **entryp);
1da177e4	140
24c1f931	141	static inline void snd_info_set_text_ops(struct snd_info_entry *entry,
fd64138c JK	142	void *private_data,
fd64138c JK	143	void (read)(struct snd_info_entry , struct snd_info_buffer *))
1da177e4 LT	144	{
1da177e4 LT	145	entry->private_data = private_data;
1da177e4 LT	146	entry->c.text.read = read;
	147	}
	148
e28563cc	149	int snd_info_check_reserved_words(const char *str);
1da177e4 LT	150
	151	#else
	152
	153	#define snd_seq_root NULL
	154	#define snd_oss_root NULL
	155
fd64138c	156	static inline int snd_iprintf(struct snd_info_buffer buffer, char fmt, ...) { return 0; }
1da177e4 LT	157	static inline int snd_info_init(void) { return 0; }
	158	static inline int snd_info_done(void) { return 0; }
	159
fd64138c	160	static inline int snd_info_get_line(struct snd_info_buffer buffer, char line, int len) { return 0; }
1da177e4	161	static inline char snd_info_get_str(char dest, char *src, int len) { return NULL; }
fd64138c JK	162	static inline struct snd_info_entry snd_info_create_module_entry(struct module module, const char name, struct snd_info_entry parent) { return NULL; }
	163	static inline struct snd_info_entry snd_info_create_card_entry(struct snd_card card, const char name, struct snd_info_entry parent) { return NULL; }
	164	static inline void snd_info_free_entry(struct snd_info_entry *entry) { ; }
	165
	166	static inline int snd_info_card_create(struct snd_card *card) { return 0; }
	167	static inline int snd_info_card_register(struct snd_card *card) { return 0; }
	168	static inline int snd_info_card_free(struct snd_card *card) { return 0; }
	169	static inline void snd_info_card_disconnect(struct snd_card *card) { }
	170	static inline void snd_info_card_id_change(struct snd_card *card) { }
	171	static inline int snd_info_register(struct snd_info_entry *entry) { return 0; }
1da177e4	172
e28563cc TI	173	static inline int snd_card_proc_new(struct snd_card card, const char name,
	174	struct snd_info_entry **entryp) { return -EINVAL; }
	175	static inline void snd_info_set_text_ops(struct snd_info_entry *entry __attribute__((unused)),
	176	void *private_data,
e28563cc TI	177	void (read)(struct snd_info_entry , struct snd_info_buffer *)) {}
	178
	179	static inline int snd_info_check_reserved_words(const char *str) { return 1; }
1da177e4 LT	180
	181	#endif
	182
	183	/*
	184	* OSS info part
	185	*/
	186
	187	#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
	188
	189	#define SNDRV_OSS_INFO_DEV_AUDIO 0
	190	#define SNDRV_OSS_INFO_DEV_SYNTH 1
	191	#define SNDRV_OSS_INFO_DEV_MIDI 2
	192	#define SNDRV_OSS_INFO_DEV_TIMERS 4
	193	#define SNDRV_OSS_INFO_DEV_MIXERS 5
	194
	195	#define SNDRV_OSS_INFO_DEV_COUNT 6
	196
24c1f931	197	int snd_oss_info_register(int dev, int num, char *string);
1da177e4 LT	198	#define snd_oss_info_unregister(dev, num) snd_oss_info_register(dev, num, NULL)
	199
	200	#endif /* CONFIG_SND_OSSEMUL && CONFIG_PROC_FS */
	201
	202	#endif /* __SOUND_INFO_H */