NetBSD/sys/dev/ic/ac97var.h
kent 23b5d91433 merge kent-audio1 branch, which introduces audio filter pipeline to the MI
audio framework


Summary of changes:

* struct audio_params
  - remove sw_code, factor, factor_denom, hw_sample_rate,
hw_encoding ,hw_precision, and hw_channels.  Conversion information
is conveyed by stream_filter_list_t.
  - change the type of sample_rate: u_long -> u_int
  - add `validbits,' which represents the valid data size in
precision bits.  It is required in order to distinguish 24/32bit
from 24/24bit or 32/32bit.

* audio_hw_if
 - add two parameters to set_params()
	stream_filter_list_t *pfil, stream_filter_list *rfil
   A HW driver should set filter recipes for requested formats
 - constify audio_params parameters of trigger_output() and
trigger_input().  They represent audio formats for the hardware.
 - make open() and close() optional
 - add int (AUMODE_PLAY or AUMODE_RECORD) and audio_params_t parameters
 to round_blocksize()

* sw_code is replaced with stream_filter_t.
  stream_filer_t converts audio data in an input buffer and writes
into another output buffer unlike sw_code, which converts data in
single buffer.
  converters in dev/auconv.c, dev/mulaw.c, dev/aurateconv.c,
dev/tc/bba.c, dev/ic/msm6258.c, and arch/arm/iomd/vidcaudio.c are
reimplemented as stream_filter_t

* MI audio
 - audiosetinfo() builds filter pipelines from stream_filter_list_t
filled by audio_hw_if::set_params()
 - audiosetinfo() returns with EINVAL if mmapped and set_params()
requests filters
 - audio_write(), audio_pint(), and audio_rint() invoke a filter
pipeline.
 - ioctl() for FIONREAD, AUDIO_WSEEK, AUDIO_GETIOFFS,
AUDIO_GETOOFFS, and audio_prinfo::{seek,samples} for
AUDIO_GETINFO handle values for a buffer nearest to userland.

* add `struct device *' parameter to ac97_attach()

* all of audio HW drivers follow audio_hw_if and ac97 changes
2005-01-10 22:01:36 +00:00

96 lines
3.5 KiB
C

/* $NetBSD: ac97var.h,v 1.14 2005/01/10 22:01:37 kent Exp $ */
/* $OpenBSD: ac97.h,v 1.4 2000/07/19 09:01:35 csapuntz Exp $ */
/*
* Copyright (c) 1999 Constantine Sapuntzakis
*
* Author: Constantine Sapuntzakis <csapuntz@stanford.edu>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY CONSTANTINE SAPUNTZAKIS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _DEV_IC_AC97VAR_H_
#define _DEV_IC_AC97VAR_H_
#include <sys/types.h>
struct ac97_codec_if;
/*
* This is the interface used to attach the AC97 compliant CODEC.
*/
enum ac97_host_flags {
AC97_HOST_DONT_READ = 0x1,
AC97_HOST_SWAPPED_CHANNELS = 0x2 /* l/r is reversed */
};
struct ac97_host_if {
void *arg;
int (*attach)(void *, struct ac97_codec_if *);
int (*read)(void *, uint8_t, uint16_t *);
int (*write)(void *, uint8_t, uint16_t);
int (*reset)(void *);
enum ac97_host_flags (*flags)(void *);
};
/*
* This is the interface exported by the AC97 compliant CODEC
*/
struct ac97_codec_if_vtbl {
int (*mixer_get_port)(struct ac97_codec_if *, mixer_ctrl_t *);
int (*mixer_set_port)(struct ac97_codec_if *, mixer_ctrl_t *);
int (*query_devinfo)(struct ac97_codec_if *, mixer_devinfo_t *);
int (*get_portnum_by_name)(struct ac97_codec_if *, const char *,
const char *, const char *);
/*
* The AC97 codec driver records the various port settings. This
* function can be used to restore the port settings, e.g. after
* resume from a laptop suspend to disk.
*/
void (*restore_ports)(struct ac97_codec_if *);
u_int16_t (*get_extcaps)(struct ac97_codec_if *);
int (*set_rate)(struct ac97_codec_if *, int, u_int *);
void (*set_clock)(struct ac97_codec_if *, unsigned int);
void (*detach)(struct ac97_codec_if *);
};
struct ac97_codec_if {
struct ac97_codec_if_vtbl *vtbl;
};
struct device;
int ac97_attach(struct ac97_host_if *, struct device *);
#define AC97_IS_FIXED_RATE(codec) \
!((codec)->vtbl->get_extcaps(codec) & AC97_EXT_AUDIO_VRA)
#define AC97_IS_4CH(codec) \
((codec)->vtbl->get_extcaps(codec) & AC97_EXT_AUDIO_SDAC)
#define AC97_IS_6CH(codec) \
(((codec)->vtbl->get_extcaps(codec) \
& (AC97_EXT_AUDIO_SDAC | AC97_EXT_AUDIO_CDAC | AC97_EXT_AUDIO_LDAC)) \
== (AC97_EXT_AUDIO_SDAC | AC97_EXT_AUDIO_CDAC | AC97_EXT_AUDIO_LDAC))
#define AC97_HAS_SPDIF(codec) \
((codec)->vtbl->get_extcaps(codec) & AC97_EXT_AUDIO_SPDIF)
#endif /* _DEV_IC_AC97VAR_H_ */