xref: /netbsd/sys/dev/ic/ac97var.h (revision c4a72b64)
1 /*	$NetBSD: ac97var.h,v 1.7 2002/10/14 08:48:15 kent 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@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 struct ac97_codec_if;
32 
33 /*
34  * This is the interface used to attach the AC97 compliant CODEC.
35  */
36 enum ac97_host_flags {
37 	AC97_HOST_DONT_READ = 0x1,
38 	AC97_HOST_SWAPPED_CHANNELS = 0x2	/* l/r is reversed */
39 };
40 
41 struct ac97_host_if {
42 	void  *arg;
43 
44 	int (*attach)(void *arg, struct ac97_codec_if *codecif);
45 	int (*read)(void *arg, u_int8_t reg, u_int16_t *val);
46 	int (*write)(void *arg, u_int8_t reg, u_int16_t val);
47 	void (*reset)(void *arg);
48 
49 	enum ac97_host_flags (*flags)(void *arg);
50 };
51 
52 /*
53  * This is the interface exported by the AC97 compliant CODEC
54  */
55 struct ac97_codec_if_vtbl {
56 	int (*mixer_get_port)(struct ac97_codec_if *addr, mixer_ctrl_t *cp);
57 	int (*mixer_set_port)(struct ac97_codec_if *addr, mixer_ctrl_t *cp);
58 	int (*query_devinfo)(struct ac97_codec_if *addr, mixer_devinfo_t *cp);
59 	int (*get_portnum_by_name)(struct ac97_codec_if *addr,
60 				   const char *class, const char *device,
61 				   const char *qualifier);
62 	/*
63 	 * The AC97 codec driver records the various port settings.  This
64 	 * function can be used to restore the port settings, e.g. after
65 	 * resume from a laptop suspend to disk.
66 	 */
67 	void (*restore_ports)(struct ac97_codec_if *addr);
68 
69 	u_int16_t (*get_extcaps)(struct ac97_codec_if *codec_if);
70 	int (*set_rate)(struct ac97_codec_if *codec_if,
71 			int target, u_long *rate);
72 	void (*set_clock)(struct ac97_codec_if *codec_if, unsigned int clock);
73 };
74 
75 struct ac97_codec_if {
76 	struct ac97_codec_if_vtbl *vtbl;
77 };
78 
79 int ac97_attach __P((struct ac97_host_if *));
80