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

#ifndef __SOUND_INFO_H
#define __SOUND_INFO_H

/*
 *  Header file for info interface
 *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
 *
 *
 *   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);
	long (*read) (struct snd_info_entry *entry, void *file_private_data,
		      struct file * file, char __user *buf,
		      unsigned long count, unsigned long pos);
	long (*write) (struct snd_info_entry *entry, void *file_private_data,
		       struct file * file, const char __user *buf,
		       unsigned long count, unsigned long pos);
	long long (*llseek) (struct snd_info_entry *entry, void *file_private_data,
			    struct file * file, long long 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;
	mode_t mode;
	long size;
	unsigned short content;
	unsigned short disconnected: 1;
	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;
};

#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;
#else
#define snd_oss_root NULL
#endif

int snd_iprintf(struct snd_info_buffer * buffer, char *fmt,...) __attribute__ ((format (printf, 2, 3)));
int snd_info_init(void);
int snd_info_done(void);

int snd_info_get_line(struct snd_info_buffer * buffer, char *line, int len);
char *snd_info_get_str(char *dest, 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);
int snd_info_register(struct snd_info_entry * entry);
int snd_info_unregister(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 int snd_info_register(struct snd_info_entry * entry) { return 0; }
static inline int snd_info_unregister(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
	6	* Copyright (c) by Jaroslav Kysela <perex@suse.cz>
	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 {
24c1f931 TI	43	void (read) (struct snd_info_entry entry, struct snd_info_buffer *buffer);
24c1f931 TI	44	void (write) (struct snd_info_entry entry, struct snd_info_buffer *buffer);
1da177e4 LT	45	};
	46
	47	struct snd_info_entry_ops {
24c1f931	48	int (open) (struct snd_info_entry entry,
1da177e4	49	unsigned short mode, void **file_private_data);
24c1f931	50	int (release) (struct snd_info_entry entry,
1da177e4	51	unsigned short mode, void *file_private_data);
24c1f931	52	long (read) (struct snd_info_entry entry, void *file_private_data,
1da177e4 LT	53	struct file * file, char __user *buf,
1da177e4 LT	54	unsigned long count, unsigned long pos);
24c1f931	55	long (write) (struct snd_info_entry entry, void *file_private_data,
1da177e4 LT	56	struct file * file, const char __user *buf,
1da177e4 LT	57	unsigned long count, unsigned long pos);
24c1f931	58	long long (llseek) (struct snd_info_entry entry, void *file_private_data,
1da177e4	59	struct file * file, long long offset, int orig);
24c1f931	60	unsigned int (poll) (struct snd_info_entry entry, void *file_private_data,
1da177e4	61	struct file * file, poll_table * wait);
24c1f931	62	int (ioctl) (struct snd_info_entry entry, void *file_private_data,
1da177e4	63	struct file * file, unsigned int cmd, unsigned long arg);
24c1f931	64	int (mmap) (struct snd_info_entry entry, void *file_private_data,
1da177e4 LT	65	struct inode * inode, struct file * file,
	66	struct vm_area_struct * vma);
	67	};
	68
	69	struct snd_info_entry {
	70	const char *name;
	71	mode_t mode;
	72	long size;
	73	unsigned short content;
	74	unsigned short disconnected: 1;
	75	union {
	76	struct snd_info_entry_text text;
	77	struct snd_info_entry_ops *ops;
	78	} c;
24c1f931 TI	79	struct snd_info_entry *parent;
24c1f931 TI	80	struct snd_card *card;
1da177e4 LT	81	struct module *module;
1da177e4 LT	82	void *private_data;
24c1f931	83	void (private_free)(struct snd_info_entry entry);
1da177e4	84	struct proc_dir_entry *p;
1a60d4c5	85	struct mutex access;
1da177e4 LT	86	};
1da177e4 LT	87
1da177e4	88	#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
24c1f931 TI	89	int snd_info_minor_register(void);
24c1f931 TI	90	int snd_info_minor_unregister(void);
1da177e4 LT	91	#else
	92	#define snd_info_minor_register() /* NOP */
	93	#define snd_info_minor_unregister() /* NOP */
	94	#endif
	95
	96
	97	#ifdef CONFIG_PROC_FS
	98
24c1f931	99	extern struct snd_info_entry *snd_seq_root;
1da177e4	100	#ifdef CONFIG_SND_OSSEMUL
24c1f931	101	extern struct snd_info_entry *snd_oss_root;
1da177e4 LT	102	#else
	103	#define snd_oss_root NULL
	104	#endif
	105
24c1f931	106	int snd_iprintf(struct snd_info_buffer * buffer, char *fmt,...) __attribute__ ((format (printf, 2, 3)));
1da177e4 LT	107	int snd_info_init(void);
	108	int snd_info_done(void);
	109
24c1f931	110	int snd_info_get_line(struct snd_info_buffer * buffer, char *line, int len);
1da177e4	111	char snd_info_get_str(char dest, char *src, int len);
24c1f931	112	struct snd_info_entry snd_info_create_module_entry(struct module module,
1da177e4	113	const char *name,
24c1f931 TI	114	struct snd_info_entry * parent);
24c1f931 TI	115	struct snd_info_entry snd_info_create_card_entry(struct snd_card card,
1da177e4	116	const char *name,
24c1f931 TI	117	struct snd_info_entry * parent);
	118	void snd_info_free_entry(struct snd_info_entry * entry);
	119	int snd_info_store_text(struct snd_info_entry * entry);
	120	int snd_info_restore_text(struct snd_info_entry * entry);
1da177e4	121
24c1f931 TI	122	int snd_info_card_create(struct snd_card * card);
	123	int snd_info_card_register(struct snd_card * card);
	124	int snd_info_card_free(struct snd_card * card);
	125	int snd_info_register(struct snd_info_entry * entry);
	126	int snd_info_unregister(struct snd_info_entry * entry);
1da177e4 LT	127
1da177e4 LT	128	/* for card drivers */
24c1f931	129	int snd_card_proc_new(struct snd_card card, const char name, struct snd_info_entry **entryp);
1da177e4	130
24c1f931	131	static inline void snd_info_set_text_ops(struct snd_info_entry *entry,
1da177e4	132	void *private_data,
24c1f931	133	void (read)(struct snd_info_entry , struct snd_info_buffer *))
1da177e4 LT	134	{
1da177e4 LT	135	entry->private_data = private_data;
1da177e4 LT	136	entry->c.text.read = read;
	137	}
	138
e28563cc	139	int snd_info_check_reserved_words(const char *str);
1da177e4 LT	140
	141	#else
	142
	143	#define snd_seq_root NULL
	144	#define snd_oss_root NULL
	145
24c1f931	146	static inline int snd_iprintf(struct snd_info_buffer * buffer, char *fmt,...) { return 0; }
1da177e4 LT	147	static inline int snd_info_init(void) { return 0; }
	148	static inline int snd_info_done(void) { return 0; }
	149
24c1f931	150	static inline int snd_info_get_line(struct snd_info_buffer * buffer, char *line, int len) { return 0; }
1da177e4	151	static inline char snd_info_get_str(char dest, char *src, int len) { return NULL; }
24c1f931 TI	152	static inline struct snd_info_entry snd_info_create_module_entry(struct module module, const char name, struct snd_info_entry parent) { return NULL; }
	153	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; }
	154	static inline void snd_info_free_entry(struct snd_info_entry * entry) { ; }
1da177e4	155
24c1f931 TI	156	static inline int snd_info_card_create(struct snd_card * card) { return 0; }
	157	static inline int snd_info_card_register(struct snd_card * card) { return 0; }
	158	static inline int snd_info_card_free(struct snd_card * card) { return 0; }
	159	static inline int snd_info_register(struct snd_info_entry * entry) { return 0; }
	160	static inline int snd_info_unregister(struct snd_info_entry * entry) { return 0; }
1da177e4	161
e28563cc TI	162	static inline int snd_card_proc_new(struct snd_card card, const char name,
	163	struct snd_info_entry **entryp) { return -EINVAL; }
	164	static inline void snd_info_set_text_ops(struct snd_info_entry *entry __attribute__((unused)),
	165	void *private_data,
e28563cc TI	166	void (read)(struct snd_info_entry , struct snd_info_buffer *)) {}
	167
	168	static inline int snd_info_check_reserved_words(const char *str) { return 1; }
1da177e4 LT	169
	170	#endif
	171
	172	/*
	173	* OSS info part
	174	*/
	175
	176	#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
	177
	178	#define SNDRV_OSS_INFO_DEV_AUDIO 0
	179	#define SNDRV_OSS_INFO_DEV_SYNTH 1
	180	#define SNDRV_OSS_INFO_DEV_MIDI 2
	181	#define SNDRV_OSS_INFO_DEV_TIMERS 4
	182	#define SNDRV_OSS_INFO_DEV_MIXERS 5
	183
	184	#define SNDRV_OSS_INFO_DEV_COUNT 6
	185
24c1f931	186	int snd_oss_info_register(int dev, int num, char *string);
1da177e4 LT	187	#define snd_oss_info_unregister(dev, num) snd_oss_info_register(dev, num, NULL)
	188
	189	#endif /* CONFIG_SND_OSSEMUL && CONFIG_PROC_FS */
	190
	191	#endif /* __SOUND_INFO_H */