Home | History | Annotate | Line # | Download | only in ic
ac97var.h revision 1.9 
      1 /*	$NetBSD: ac97var.h,v 1.9 2004/08/23 23:17:54 thorpej Exp $	*/
      2 /*	$OpenBSD: ac97.h,v 1.4 2000/07/19 09:01:35 csapuntz Exp $	*/
      3 
      4 /*
      5  * Copyright (c) 1999 Constantine Sapuntzakis
      6  *
      7  * Author:        Constantine Sapuntzakis <csapuntz (at) stanford.edu>
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY CONSTANTINE SAPUNTZAKIS AND CONTRIBUTORS
     19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
     22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     28  * POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef _DEV_IC_AC97VAR_H_
     32 #define	_DEV_IC_AC97VAR_H_
     33 
     34 struct ac97_codec_if;
     35 
     36 /*
     37  * This is the interface used to attach the AC97 compliant CODEC.
     38  */
     39 enum ac97_host_flags {
     40 	AC97_HOST_DONT_READ = 0x1,
     41 	AC97_HOST_SWAPPED_CHANNELS = 0x2	/* l/r is reversed */
     42 };
     43 
     44 struct ac97_host_if {
     45 	void  *arg;
     46 
     47 	int (*attach)(void *, struct ac97_codec_if *);
     48 	int (*read)(void *, u_int8_t, u_int16_t *);
     49 	int (*write)(void *, u_int8_t, u_int16_t);
     50 	void (*reset)(void *);
     51 
     52 	enum ac97_host_flags (*flags)(void *);
     53 };
     54 
     55 /*
     56  * This is the interface exported by the AC97 compliant CODEC
     57  */
     58 struct ac97_codec_if_vtbl {
     59 	int (*mixer_get_port)(struct ac97_codec_if *, mixer_ctrl_t *);
     60 	int (*mixer_set_port)(struct ac97_codec_if *, mixer_ctrl_t *);
     61 	int (*query_devinfo)(struct ac97_codec_if *, mixer_devinfo_t *);
     62 	int (*get_portnum_by_name)(struct ac97_codec_if *, const char *,
     63 	    const char *, const char *);
     64 	/*
     65 	 * The AC97 codec driver records the various port settings.  This
     66 	 * function can be used to restore the port settings, e.g. after
     67 	 * resume from a laptop suspend to disk.
     68 	 */
     69 	void (*restore_ports)(struct ac97_codec_if *);
     70 
     71 	u_int16_t (*get_extcaps)(struct ac97_codec_if *);
     72 	int (*set_rate)(struct ac97_codec_if *, int, u_long *);
     73 	void (*set_clock)(struct ac97_codec_if *, unsigned int);
     74 };
     75 
     76 struct ac97_codec_if {
     77 	struct ac97_codec_if_vtbl *vtbl;
     78 };
     79 
     80 int ac97_attach __P((struct ac97_host_if *));
     81 
     82 #endif /* _DEV_IC_AC97VAR_H_ */
     83