1 /* $OpenBSD: audio_if.h,v 1.28 2013/05/15 08:29:24 ratchov Exp $ */ 2 /* $NetBSD: audio_if.h,v 1.24 1998/01/10 14:07:25 tv Exp $ */ 3 4 /* 5 * Copyright (c) 1994 Havard Eidnes. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the Computer Systems 19 * Engineering Group at Lawrence Berkeley Laboratory. 20 * 4. Neither the name of the University nor of the Laboratory may be used 21 * to endorse or promote products derived from this software without 22 * specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 */ 37 38 #ifndef _SYS_DEV_AUDIO_IF_H_ 39 #define _SYS_DEV_AUDIO_IF_H_ 40 41 #include <sys/mutex.h> 42 43 #define AUDIO_BPS(bits) (bits) <= 8 ? 1 : ((bits) <= 16 ? 2 : 4) 44 45 /* 46 * Generic interface to hardware driver. 47 */ 48 49 struct audio_softc; 50 struct audio_device; 51 struct audio_encoding; 52 struct mixer_devinfo; 53 struct mixer_ctrl; 54 55 struct audio_params { 56 u_long sample_rate; /* sample rate */ 57 u_int encoding; /* mu-law, linear, etc */ 58 u_int precision; /* bits/sample */ 59 u_int bps; /* bytes/sample */ 60 u_int msb; /* data alignment */ 61 u_int channels; /* mono(1), stereo(2) */ 62 /* Software en/decode functions, set if SW coding required by HW */ 63 void (*sw_code)(void *, u_char *, int); 64 int factor; /* coding space change */ 65 }; 66 67 /* The default audio mode: 8 kHz mono mu-law */ 68 extern struct audio_params audio_default; 69 70 struct audio_hw_if { 71 int (*open)(void *, int); /* open hardware */ 72 void (*close)(void *); /* close hardware */ 73 int (*drain)(void *); /* Optional: drain buffers */ 74 75 /* Encoding. */ 76 /* XXX should we have separate in/out? */ 77 int (*query_encoding)(void *, struct audio_encoding *); 78 79 /* Set the audio encoding parameters (record and play). 80 * Return 0 on success, or an error code if the 81 * requested parameters are impossible. 82 * The values in the params struct may be changed (e.g. rounding 83 * to the nearest sample rate.) 84 */ 85 int (*set_params)(void *, int, int, struct audio_params *, 86 struct audio_params *); 87 88 /* Hardware may have some say in the blocksize to choose */ 89 int (*round_blocksize)(void *, int); 90 91 /* 92 * Changing settings may require taking device out of "data mode", 93 * which can be quite expensive. Also, audiosetinfo() may 94 * change several settings in quick succession. To avoid 95 * having to take the device in/out of "data mode", we provide 96 * this function which indicates completion of settings 97 * adjustment. 98 */ 99 int (*commit_settings)(void *); 100 101 /* Start input/output routines. These usually control DMA. */ 102 int (*init_output)(void *, void *, int); 103 int (*init_input)(void *, void *, int); 104 int (*start_output)(void *, void *, int, void (*)(void *), void *); 105 int (*start_input)(void *, void *, int, void (*)(void *), void *); 106 int (*halt_output)(void *); 107 int (*halt_input)(void *); 108 109 int (*speaker_ctl)(void *, int); 110 #define SPKR_ON 1 111 #define SPKR_OFF 0 112 113 int (*getdev)(void *, struct audio_device *); 114 int (*setfd)(void *, int); 115 116 /* Mixer (in/out ports) */ 117 int (*set_port)(void *, struct mixer_ctrl *); 118 int (*get_port)(void *, struct mixer_ctrl *); 119 120 int (*query_devinfo)(void *, struct mixer_devinfo *); 121 122 /* Allocate/free memory for the ring buffer. Usually malloc/free. */ 123 /* The _old interfaces have been deprecated and will not be 124 called in newer kernels if the new interfaces are present */ 125 void *(*allocm)(void *, int, size_t, int, int); 126 void (*freem)(void *, void *, int); 127 size_t (*round_buffersize)(void *, int, size_t); 128 paddr_t (*mappage)(void *, void *, off_t, int); 129 130 int (*get_props)(void *); /* device properties */ 131 132 int (*trigger_output)(void *, void *, void *, int, 133 void (*)(void *), void *, struct audio_params *); 134 int (*trigger_input)(void *, void *, void *, int, 135 void (*)(void *), void *, struct audio_params *); 136 void (*get_default_params)(void *, int, struct audio_params *); 137 }; 138 139 struct audio_attach_args { 140 int type; 141 void *hwif; /* either audio_hw_if * or midi_hw_if * */ 142 void *hdl; 143 }; 144 #define AUDIODEV_TYPE_AUDIO 0 145 #define AUDIODEV_TYPE_MIDI 1 146 #define AUDIODEV_TYPE_OPL 2 147 #define AUDIODEV_TYPE_MPU 3 148 #define AUDIODEV_TYPE_RADIO 4 149 150 /* Attach the MI driver(s) to the MD driver. */ 151 struct device *audio_attach_mi(struct audio_hw_if *, void *, struct device *); 152 int audioprint(void *, const char *); 153 154 /* Device identity flags */ 155 #define SOUND_DEVICE 0 156 #define AUDIO_DEVICE 0x80 157 #define AUDIOCTL_DEVICE 0xc0 158 #define MIXER_DEVICE 0x10 159 160 #define AUDIOUNIT(x) (minor(x)&0x0f) 161 #define AUDIODEV(x) (minor(x)&0xf0) 162 163 #define ISDEVSOUND(x) (AUDIODEV((x)) == SOUND_DEVICE) 164 #define ISDEVAUDIO(x) (AUDIODEV((x)) == AUDIO_DEVICE) 165 #define ISDEVAUDIOCTL(x) (AUDIODEV((x)) == AUDIOCTL_DEVICE) 166 #define ISDEVMIXER(x) (AUDIODEV((x)) == MIXER_DEVICE) 167 168 /* 169 * USB Audio specification defines 12 channels: 170 * L R C LFE Ls Rs Lc Rc S Sl Sr T 171 */ 172 #define AUDIO_MAX_CHANNELS 12 173 174 extern struct mutex audio_lock; 175 176 #endif /* _SYS_DEV_AUDIO_IF_H_ */ 177 178