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