1/**
2 * \file include/hwdep.h
3 * \brief Application interface library for the ALSA driver
4 * \author Jaroslav Kysela <perex@perex.cz>
5 * \author Abramo Bagnara <abramo@alsa-project.org>
6 * \author Takashi Iwai <tiwai@suse.de>
7 * \date 1998-2001
8 *
9 * Application interface library for the ALSA driver
10 */
11/*
12 * This library is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License as
14 * published by the Free Software Foundation; either version 2.1 of
15 * the License, or (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Lesser General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 */
27
28#ifndef __ALSA_HWDEP_H
29#define __ALSA_HWDEP_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35/**
36 * \defgroup HwDep Hardware Dependant Interface
37 * The Hardware Dependant Interface.
38 * \{
39 */
40
41/** dlsym version for interface entry callback */
42#define SND_HWDEP_DLSYM_VERSION _dlsym_hwdep_001
43
44/** HwDep information container */
45typedef struct _snd_hwdep_info snd_hwdep_info_t;
46
47/** HwDep DSP status container */
48typedef struct _snd_hwdep_dsp_status snd_hwdep_dsp_status_t;
49
50/** HwDep DSP image container */
51typedef struct _snd_hwdep_dsp_image snd_hwdep_dsp_image_t;
52
53/** HwDep interface */
54typedef enum _snd_hwdep_iface {
55 SND_HWDEP_IFACE_OPL2 = 0, /**< OPL2 raw driver */
56 SND_HWDEP_IFACE_OPL3, /**< OPL3 raw driver */
57 SND_HWDEP_IFACE_OPL4, /**< OPL4 raw driver */
58 SND_HWDEP_IFACE_SB16CSP, /**< SB16CSP driver */
59 SND_HWDEP_IFACE_EMU10K1, /**< EMU10K1 driver */
60 SND_HWDEP_IFACE_YSS225, /**< YSS225 driver */
61 SND_HWDEP_IFACE_ICS2115, /**< ICS2115 driver */
62 SND_HWDEP_IFACE_SSCAPE, /**< Ensoniq SoundScape ISA card (MC68EC000) */
63 SND_HWDEP_IFACE_VX, /**< Digigram VX cards */
64 SND_HWDEP_IFACE_MIXART, /**< Digigram miXart cards */
65 SND_HWDEP_IFACE_USX2Y, /**< Tascam US122, US224 & US428 usb */
66 SND_HWDEP_IFACE_EMUX_WAVETABLE, /**< EmuX wavetable */
67 SND_HWDEP_IFACE_BLUETOOTH, /**< Bluetooth audio */
68 SND_HWDEP_IFACE_USX2Y_PCM, /**< Tascam US122, US224 & US428 raw USB PCM */
69 SND_HWDEP_IFACE_PCXHR, /**< Digigram PCXHR */
70 SND_HWDEP_IFACE_SB_RC, /**< SB Extigy/Audigy2NX remote control */
71 SND_HWDEP_IFACE_HDA, /**< HD-audio */
72 SND_HWDEP_IFACE_USB_STREAM, /**< direct access to usb stream */
73 SND_HWDEP_IFACE_FW_DICE, /**< TC DICE FireWire device */
74 SND_HWDEP_IFACE_FW_FIREWORKS, /**< Echo Audio Fireworks based device */
75 SND_HWDEP_IFACE_FW_BEBOB, /**< BridgeCo BeBoB based device */
76 SND_HWDEP_IFACE_FW_OXFW, /**< Oxford OXFW970/971 based device */
77 SND_HWDEP_IFACE_FW_DIGI00X, /* Digidesign Digi 002/003 family */
78 SND_HWDEP_IFACE_FW_TASCAM, /* TASCAM FireWire series */
79
80 SND_HWDEP_IFACE_LAST = SND_HWDEP_IFACE_FW_TASCAM /**< last known hwdep interface */
81} snd_hwdep_iface_t;
82
83/** open for reading */
84#define SND_HWDEP_OPEN_READ (O_RDONLY)
85/** open for writing */
86#define SND_HWDEP_OPEN_WRITE (O_WRONLY)
87/** open for reading and writing */
88#define SND_HWDEP_OPEN_DUPLEX (O_RDWR)
89/** open mode flag: open in nonblock mode */
90#define SND_HWDEP_OPEN_NONBLOCK (O_NONBLOCK)
91
92/** HwDep handle type */
93typedef enum _snd_hwdep_type {
94 /** Kernel level HwDep */
95 SND_HWDEP_TYPE_HW,
96 /** Shared memory client HwDep (not yet implemented) */
97 SND_HWDEP_TYPE_SHM,
98 /** INET client HwDep (not yet implemented) */
99 SND_HWDEP_TYPE_INET
100} snd_hwdep_type_t;
101
102/** HwDep handle */
103typedef struct _snd_hwdep snd_hwdep_t;
104
105int snd_hwdep_open(snd_hwdep_t **hwdep, const char *name, int mode);
106int snd_hwdep_close(snd_hwdep_t *hwdep);
107int snd_hwdep_poll_descriptors(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int space);
108int snd_hwdep_poll_descriptors_count(snd_hwdep_t *hwdep);
109int snd_hwdep_poll_descriptors_revents(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
110int snd_hwdep_nonblock(snd_hwdep_t *hwdep, int nonblock);
111int snd_hwdep_info(snd_hwdep_t *hwdep, snd_hwdep_info_t * info);
112int snd_hwdep_dsp_status(snd_hwdep_t *hwdep, snd_hwdep_dsp_status_t *status);
113int snd_hwdep_dsp_load(snd_hwdep_t *hwdep, snd_hwdep_dsp_image_t *block);
114int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void * arg);
115ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size);
116ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size);
117
118size_t snd_hwdep_info_sizeof(void);
119/** allocate #snd_hwdep_info_t container on stack */
120#define snd_hwdep_info_alloca(ptr) __snd_alloca(ptr, snd_hwdep_info)
121int snd_hwdep_info_malloc(snd_hwdep_info_t **ptr);
122void snd_hwdep_info_free(snd_hwdep_info_t *obj);
123void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src);
124
125unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *obj);
126int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj);
127const char *snd_hwdep_info_get_id(const snd_hwdep_info_t *obj);
128const char *snd_hwdep_info_get_name(const snd_hwdep_info_t *obj);
129snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj);
130void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val);
131
132size_t snd_hwdep_dsp_status_sizeof(void);
133/** allocate #snd_hwdep_dsp_status_t container on stack */
134#define snd_hwdep_dsp_status_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_status)
135int snd_hwdep_dsp_status_malloc(snd_hwdep_dsp_status_t **ptr);
136void snd_hwdep_dsp_status_free(snd_hwdep_dsp_status_t *obj);
137void snd_hwdep_dsp_status_copy(snd_hwdep_dsp_status_t *dst, const snd_hwdep_dsp_status_t *src);
138
139unsigned int snd_hwdep_dsp_status_get_version(const snd_hwdep_dsp_status_t *obj);
140const char *snd_hwdep_dsp_status_get_id(const snd_hwdep_dsp_status_t *obj);
141unsigned int snd_hwdep_dsp_status_get_num_dsps(const snd_hwdep_dsp_status_t *obj);
142unsigned int snd_hwdep_dsp_status_get_dsp_loaded(const snd_hwdep_dsp_status_t *obj);
143unsigned int snd_hwdep_dsp_status_get_chip_ready(const snd_hwdep_dsp_status_t *obj);
144
145size_t snd_hwdep_dsp_image_sizeof(void);
146/** allocate #snd_hwdep_dsp_image_t container on stack */
147#define snd_hwdep_dsp_image_alloca(ptr) __snd_alloca(ptr, snd_hwdep_dsp_image)
148int snd_hwdep_dsp_image_malloc(snd_hwdep_dsp_image_t **ptr);
149void snd_hwdep_dsp_image_free(snd_hwdep_dsp_image_t *obj);
150void snd_hwdep_dsp_image_copy(snd_hwdep_dsp_image_t *dst, const snd_hwdep_dsp_image_t *src);
151
152unsigned int snd_hwdep_dsp_image_get_index(const snd_hwdep_dsp_image_t *obj);
153const char *snd_hwdep_dsp_image_get_name(const snd_hwdep_dsp_image_t *obj);
154const void *snd_hwdep_dsp_image_get_image(const snd_hwdep_dsp_image_t *obj);
155size_t snd_hwdep_dsp_image_get_length(const snd_hwdep_dsp_image_t *obj);
156
157void snd_hwdep_dsp_image_set_index(snd_hwdep_dsp_image_t *obj, unsigned int _index);
158void snd_hwdep_dsp_image_set_name(snd_hwdep_dsp_image_t *obj, const char *name);
159void snd_hwdep_dsp_image_set_image(snd_hwdep_dsp_image_t *obj, void *buffer);
160void snd_hwdep_dsp_image_set_length(snd_hwdep_dsp_image_t *obj, size_t length);
161
162/** \} */
163
164#ifdef __cplusplus
165}
166#endif
167
168#endif /* __ALSA_HWDEP_H */
169
170