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

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

/*
 *  Header file for info interface
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 */

#include <linux/poll.h>
#include <linux/seq_file.h>
#include <sound/core.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);
	__poll_t (*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 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_SND_PROC_FS)
int snd_info_minor_register(void);
#else
#define snd_info_minor_register()	0
#endif


#ifdef CONFIG_SND_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

/**
 * snd_iprintf - printf on the procfs buffer
 * @buf: the procfs buffer
 * @fmt: the printf format
 *
 * Outputs the string on the procfs buffer just like printf().
 *
 * Return: zero for success, or a negative error code.
 */
#define snd_iprintf(buf, fmt, args...) \
	seq_printf((struct seq_file *)(buf)->buffer, fmt, ##args)

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 */
static inline int snd_card_proc_new(struct snd_card *card, const char *name,
				    struct snd_info_entry **entryp)
{
	*entryp = snd_info_create_card_entry(card, name, card->proc_root);
	return *entryp ? 0 : -ENOMEM;
}

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_card_rw_proc_new(struct snd_card *card, const char *name,
			 void *private_data,
			 void (*read)(struct snd_info_entry *,
				      struct snd_info_buffer *),
			 void (*write)(struct snd_info_entry *entry,
				       struct snd_info_buffer *buffer));

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_card_rw_proc_new(struct snd_card *card, const char *name,
				       void *private_data,
				       void (*read)(struct snd_info_entry *,
						    struct snd_info_buffer *),
				       void (*write)(struct snd_info_entry *entry,
						     struct snd_info_buffer *buffer))
{
	return 0;
}
static inline int snd_info_check_reserved_words(const char *str) { return 1; }

#endif

/**
 * snd_card_ro_proc_new - Create a read-only text proc file entry for the card
 * @card: the card instance
 * @name: the file name
 * @private_data: the arbitrary private data
 * @read: the read callback
 *
 * This proc file entry will be registered via snd_card_register() call, and
 * it will be removed automatically at the card removal, too.
 */
static inline int
snd_card_ro_proc_new(struct snd_card *card, const char *name,
		     void *private_data,
		     void (*read)(struct snd_info_entry *,
				  struct snd_info_buffer *))
{
	return snd_card_rw_proc_new(card, name, private_data, read, NULL);
}

/*
 * OSS info part
 */

#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_SND_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_SND_PROC_FS */

#endif /* __SOUND_INFO_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	#ifndef __SOUND_INFO_H
	3	#define __SOUND_INFO_H
	4
	5	/*
	6	* Header file for info interface
c1017a4c	7	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	8	*/
	9
	10	#include <linux/poll.h>
4adb7bcb	11	#include <linux/seq_file.h>
c560a679	12	#include <sound/core.h>
1da177e4 LT	13
	14	/* buffer for information */
	15	struct snd_info_buffer {
	16	char buffer; / pointer to begin of buffer */
7e4eeec8 TI	17	unsigned int curr; /* current position in buffer */
	18	unsigned int size; /* current size */
	19	unsigned int len; /* total length of buffer */
1da177e4 LT	20	int stop; /* stop flag */
	21	int error; /* error code */
	22	};
	23
1da177e4 LT	24	#define SNDRV_INFO_CONTENT_TEXT 0
	25	#define SNDRV_INFO_CONTENT_DATA 1
	26
	27	struct snd_info_entry;
	28
	29	struct snd_info_entry_text {
fd64138c JK	30	void (read)(struct snd_info_entry entry,
	31	struct snd_info_buffer *buffer);
	32	void (write)(struct snd_info_entry entry,
	33	struct snd_info_buffer *buffer);
1da177e4 LT	34	};
	35
	36	struct snd_info_entry_ops {
fd64138c JK	37	int (open)(struct snd_info_entry entry,
	38	unsigned short mode, void **file_private_data);
	39	int (release)(struct snd_info_entry entry,
	40	unsigned short mode, void *file_private_data);
24e4a121 TI	41	ssize_t (read)(struct snd_info_entry entry, void *file_private_data,
	42	struct file file, char __user buf,
	43	size_t count, loff_t pos);
	44	ssize_t (write)(struct snd_info_entry entry, void *file_private_data,
	45	struct file file, const char __user buf,
	46	size_t count, loff_t pos);
	47	loff_t (llseek)(struct snd_info_entry entry,
	48	void file_private_data, struct file file,
	49	loff_t offset, int orig);
a3f8683b	50	__poll_t (poll)(struct snd_info_entry entry,
24e4a121 TI	51	void file_private_data, struct file file,
24e4a121 TI	52	poll_table *wait);
fd64138c JK	53	int (ioctl)(struct snd_info_entry entry, void *file_private_data,
	54	struct file *file, unsigned int cmd, unsigned long arg);
	55	int (mmap)(struct snd_info_entry entry, void *file_private_data,
	56	struct inode inode, struct file file,
	57	struct vm_area_struct *vma);
1da177e4 LT	58	};
	59
	60	struct snd_info_entry {
	61	const char *name;
d161a13f	62	umode_t mode;
1da177e4 LT	63	long size;
1da177e4 LT	64	unsigned short content;
1da177e4 LT	65	union {
	66	struct snd_info_entry_text text;
	67	struct snd_info_entry_ops *ops;
	68	} c;
24c1f931	69	struct snd_info_entry *parent;
1da177e4 LT	70	struct module *module;
1da177e4 LT	71	void *private_data;
24c1f931	72	void (private_free)(struct snd_info_entry entry);
1da177e4	73	struct proc_dir_entry *p;
1a60d4c5	74	struct mutex access;
746d4a02 TI	75	struct list_head children;
746d4a02 TI	76	struct list_head list;
1da177e4 LT	77	};
1da177e4 LT	78
cd6a6503	79	#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_SND_PROC_FS)
24c1f931	80	int snd_info_minor_register(void);
1da177e4	81	#else
a0dca822	82	#define snd_info_minor_register() 0
1da177e4 LT	83	#endif
	84
	85
cd6a6503	86	#ifdef CONFIG_SND_PROC_FS
1da177e4	87
24c1f931	88	extern struct snd_info_entry *snd_seq_root;
1da177e4	89	#ifdef CONFIG_SND_OSSEMUL
24c1f931	90	extern struct snd_info_entry *snd_oss_root;
36b9cdfe	91	void snd_card_info_read_oss(struct snd_info_buffer *buffer);
1da177e4 LT	92	#else
1da177e4 LT	93	#define snd_oss_root NULL
36b9cdfe	94	static inline void snd_card_info_read_oss(struct snd_info_buffer *buffer) {}
1da177e4 LT	95	#endif
1da177e4 LT	96
4adb7bcb TI	97	/**
	98	* snd_iprintf - printf on the procfs buffer
	99	* @buf: the procfs buffer
	100	* @fmt: the printf format
	101	*
	102	* Outputs the string on the procfs buffer just like printf().
	103	*
	104	* Return: zero for success, or a negative error code.
	105	*/
	106	#define snd_iprintf(buf, fmt, args...) \
	107	seq_printf((struct seq_file *)(buf)->buffer, fmt, ##args)
	108
1da177e4 LT	109	int snd_info_init(void);
	110	int snd_info_done(void);
	111
fd64138c	112	int snd_info_get_line(struct snd_info_buffer buffer, char line, int len);
4f7454a9	113	const char snd_info_get_str(char dest, const char *src, int len);
fd64138c	114	struct snd_info_entry snd_info_create_module_entry(struct module module,
1da177e4	115	const char *name,
fd64138c JK	116	struct snd_info_entry *parent);
fd64138c JK	117	struct snd_info_entry snd_info_create_card_entry(struct snd_card card,
1da177e4	118	const char *name,
fd64138c JK	119	struct snd_info_entry *parent);
	120	void snd_info_free_entry(struct snd_info_entry *entry);
	121	int snd_info_store_text(struct snd_info_entry *entry);
	122	int snd_info_restore_text(struct snd_info_entry *entry);
	123
	124	int snd_info_card_create(struct snd_card *card);
	125	int snd_info_card_register(struct snd_card *card);
	126	int snd_info_card_free(struct snd_card *card);
	127	void snd_info_card_disconnect(struct snd_card *card);
	128	void snd_info_card_id_change(struct snd_card *card);
	129	int snd_info_register(struct snd_info_entry *entry);
1da177e4 LT	130
1da177e4 LT	131	/* for card drivers */
c560a679 TI	132	static inline int snd_card_proc_new(struct snd_card card, const char name,
	133	struct snd_info_entry **entryp)
	134	{
	135	*entryp = snd_info_create_card_entry(card, name, card->proc_root);
	136	return *entryp ? 0 : -ENOMEM;
	137	}
1da177e4	138
24c1f931	139	static inline void snd_info_set_text_ops(struct snd_info_entry *entry,
fd64138c JK	140	void *private_data,
fd64138c JK	141	void (read)(struct snd_info_entry , struct snd_info_buffer *))
1da177e4 LT	142	{
1da177e4 LT	143	entry->private_data = private_data;
1da177e4 LT	144	entry->c.text.read = read;
	145	}
	146
7453e1da TI	147	int snd_card_rw_proc_new(struct snd_card card, const char name,
	148	void *private_data,
	149	void (read)(struct snd_info_entry ,
	150	struct snd_info_buffer *),
	151	void (write)(struct snd_info_entry entry,
	152	struct snd_info_buffer *buffer));
	153
e28563cc	154	int snd_info_check_reserved_words(const char *str);
1da177e4 LT	155
	156	#else
	157
	158	#define snd_seq_root NULL
	159	#define snd_oss_root NULL
	160
fd64138c	161	static inline int snd_iprintf(struct snd_info_buffer buffer, char fmt, ...) { return 0; }
1da177e4 LT	162	static inline int snd_info_init(void) { return 0; }
	163	static inline int snd_info_done(void) { return 0; }
	164
fd64138c	165	static inline int snd_info_get_line(struct snd_info_buffer buffer, char line, int len) { return 0; }
1da177e4	166	static inline char snd_info_get_str(char dest, char *src, int len) { return NULL; }
fd64138c JK	167	static inline struct snd_info_entry snd_info_create_module_entry(struct module module, const char name, struct snd_info_entry parent) { return NULL; }
	168	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; }
	169	static inline void snd_info_free_entry(struct snd_info_entry *entry) { ; }
	170
	171	static inline int snd_info_card_create(struct snd_card *card) { return 0; }
	172	static inline int snd_info_card_register(struct snd_card *card) { return 0; }
	173	static inline int snd_info_card_free(struct snd_card *card) { return 0; }
	174	static inline void snd_info_card_disconnect(struct snd_card *card) { }
	175	static inline void snd_info_card_id_change(struct snd_card *card) { }
	176	static inline int snd_info_register(struct snd_info_entry *entry) { return 0; }
1da177e4	177
e28563cc TI	178	static inline int snd_card_proc_new(struct snd_card card, const char name,
	179	struct snd_info_entry **entryp) { return -EINVAL; }
	180	static inline void snd_info_set_text_ops(struct snd_info_entry *entry __attribute__((unused)),
	181	void *private_data,
e28563cc	182	void (read)(struct snd_info_entry , struct snd_info_buffer *)) {}
7453e1da TI	183	static inline int snd_card_rw_proc_new(struct snd_card card, const char name,
	184	void *private_data,
	185	void (read)(struct snd_info_entry ,
	186	struct snd_info_buffer *),
	187	void (write)(struct snd_info_entry entry,
	188	struct snd_info_buffer *buffer))
	189	{
	190	return 0;
	191	}
e28563cc	192	static inline int snd_info_check_reserved_words(const char *str) { return 1; }
1da177e4 LT	193
	194	#endif
	195
7453e1da TI	196	/**
	197	* snd_card_ro_proc_new - Create a read-only text proc file entry for the card
	198	* @card: the card instance
	199	* @name: the file name
	200	* @private_data: the arbitrary private data
	201	* @read: the read callback
	202	*
	203	* This proc file entry will be registered via snd_card_register() call, and
	204	* it will be removed automatically at the card removal, too.
	205	*/
	206	static inline int
	207	snd_card_ro_proc_new(struct snd_card card, const char name,
	208	void *private_data,
	209	void (read)(struct snd_info_entry ,
	210	struct snd_info_buffer *))
	211	{
	212	return snd_card_rw_proc_new(card, name, private_data, read, NULL);
	213	}
	214
1da177e4 LT	215	/*
	216	* OSS info part
	217	*/
	218
cd6a6503	219	#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_SND_PROC_FS)
1da177e4 LT	220
	221	#define SNDRV_OSS_INFO_DEV_AUDIO 0
	222	#define SNDRV_OSS_INFO_DEV_SYNTH 1
	223	#define SNDRV_OSS_INFO_DEV_MIDI 2
	224	#define SNDRV_OSS_INFO_DEV_TIMERS 4
	225	#define SNDRV_OSS_INFO_DEV_MIXERS 5
	226
	227	#define SNDRV_OSS_INFO_DEV_COUNT 6
	228
24c1f931	229	int snd_oss_info_register(int dev, int num, char *string);
1da177e4 LT	230	#define snd_oss_info_unregister(dev, num) snd_oss_info_register(dev, num, NULL)
1da177e4 LT	231
cd6a6503	232	#endif /* CONFIG_SND_OSSEMUL && CONFIG_SND_PROC_FS */
1da177e4 LT	233
1da177e4 LT	234	#endif /* __SOUND_INFO_H */