aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/cpu-freq/user-guide.txt6
-rw-r--r--Documentation/sh/kgdb.txt179
-rw-r--r--Documentation/sound/alsa/ALSA-Configuration.txt330
-rw-r--r--Documentation/sound/alsa/HD-Audio-Models.txt348
-rw-r--r--Documentation/sound/alsa/HD-Audio.txt577
-rw-r--r--Documentation/sound/alsa/Procfile.txt10
-rw-r--r--Documentation/sound/alsa/soc/machine.txt8
7 files changed, 957 insertions, 501 deletions
diff --git a/Documentation/cpu-freq/user-guide.txt b/Documentation/cpu-freq/user-guide.txt
index 4f3f3840320e..e3443ddcfb89 100644
--- a/Documentation/cpu-freq/user-guide.txt
+++ b/Documentation/cpu-freq/user-guide.txt
@@ -93,10 +93,8 @@ Several "PowerBook" and "iBook2" notebooks are supported.
931.5 SuperH 931.5 SuperH
94---------- 94----------
95 95
96The following SuperH processors are supported by cpufreq: 96All SuperH processors supporting rate rounding through the clock
97 97framework are supported by cpufreq.
98SH-3
99SH-4
100 98
1011.6 Blackfin 991.6 Blackfin
102------------ 100------------
diff --git a/Documentation/sh/kgdb.txt b/Documentation/sh/kgdb.txt
deleted file mode 100644
index 05b4ba89d28c..000000000000
--- a/Documentation/sh/kgdb.txt
+++ /dev/null
@@ -1,179 +0,0 @@
1
2This file describes the configuration and behavior of KGDB for the SH
3kernel. Based on a description from Henry Bell <henry.bell@st.com>, it
4has been modified to account for quirks in the current implementation.
5
6Version
7=======
8
9This version of KGDB was written for 2.4.xx kernels for the SH architecture.
10Further documentation is available from the linux-sh project website.
11
12
13Debugging Setup: Host
14======================
15
16The two machines will be connected together via a serial line - this
17should be a null modem cable i.e. with a twist.
18
19On your DEVELOPMENT machine, go to your kernel source directory and
20build the kernel, enabling KGDB support in the "kernel hacking" section.
21This includes the KGDB code, and also makes the kernel be compiled with
22the "-g" option set -- necessary for debugging.
23
24To install this new kernel, use the following installation procedure.
25
26Decide on which tty port you want the machines to communicate, then
27cable them up back-to-back using the null modem. On the DEVELOPMENT
28machine, you may wish to create an initialization file called .gdbinit
29(in the kernel source directory or in your home directory) to execute
30commonly-used commands at startup.
31
32A minimal .gdbinit might look like this:
33
34 file vmlinux
35 set remotebaud 115200
36 target remote /dev/ttyS0
37
38Change the "target" definition so that it specifies the tty port that
39you intend to use. Change the "remotebaud" definition to match the
40data rate that you are going to use for the com line (115200 is the
41default).
42
43Debugging Setup: Target
44========================
45
46By default, the KGDB stub will communicate with the host GDB using
47ttySC1 at 115200 baud, 8 databits, no parity; these defaults can be
48changed in the kernel configuration. As the kernel starts up, KGDB will
49initialize so that breakpoints, kernel segfaults, and so forth will
50generally enter the debugger.
51
52This behavior can be modified by including the "kgdb" option in the
53kernel command line; this option has the general form:
54
55 kgdb=<ttyspec>,<action>
56
57The <ttyspec> indicates the port to use, and can optionally specify
58baud, parity and databits -- e.g. "ttySC0,9600N8" or "ttySC1,19200".
59
60The <action> can be "halt" or "disabled". The "halt" action enters the
61debugger via a breakpoint as soon as kgdb is initialized; the "disabled"
62action causes kgdb to ignore kernel segfaults and such until explicitly
63entered by a breakpoint in the code or by external action (sysrq or NMI).
64
65(Both <ttyspec> and <action> can appear alone, w/o the separating comma.)
66
67For example, if you wish to debug early in kernel startup code, you
68might specify the halt option:
69
70 kgdb=halt
71
72Boot the TARGET machine, which will appear to hang.
73
74On your DEVELOPMENT machine, cd to the source directory and run the gdb
75program. (This is likely to be a cross GDB which runs on your host but
76is built for an SH target.) If everything is working correctly you
77should see gdb print out a few lines indicating that a breakpoint has
78been taken. It will actually show a line of code in the target kernel
79inside the gdbstub activation code.
80
81NOTE: BE SURE TO TERMINATE OR SUSPEND any other host application which
82may be using the same serial port (for example, a terminal emulator you
83have been using to connect to the target boot code.) Otherwise, data
84from the target may not all get to GDB!
85
86You can now use whatever gdb commands you like to set breakpoints.
87Enter "continue" to start your target machine executing again. At this
88point the target system will run at full speed until it encounters
89your breakpoint or gets a segment violation in the kernel, or whatever.
90
91Serial Ports: KGDB, Console
92============================
93
94This version of KGDB may not gracefully handle conflict with other
95drivers in the kernel using the same port. If KGDB is configured on the
96same port (and with the same parameters) as the kernel console, or if
97CONFIG_SH_KGDB_CONSOLE is configured, things should be fine (though in
98some cases console messages may appear twice through GDB). But if the
99KGDB port is not the kernel console and used by another serial driver
100which assumes different serial parameters (e.g. baud rate) KGDB may not
101recover.
102
103Also, when KGDB is entered via sysrq-g (requires CONFIG_KGDB_SYSRQ) and
104the kgdb port uses the same port as the console, detaching GDB will not
105restore the console to working order without the port being re-opened.
106
107Another serious consequence of this is that GDB currently CANNOT break
108into KGDB externally (e.g. via ^C or <BREAK>); unless a breakpoint or
109error is encountered, the only way to enter KGDB after the initial halt
110(see above) is via NMI (CONFIG_KGDB_NMI) or sysrq-g (CONFIG_KGDB_SYSRQ).
111
112Code is included for the basic Hitachi Solution Engine boards to allow
113the use of ttyS0 for KGDB if desired; this is less robust, but may be
114useful in some cases. (This cannot be selected using the config file,
115but only through the kernel command line, e.g. "kgdb=ttyS0", though the
116configured defaults for baud rate etc. still apply if not overridden.)
117
118If gdbstub Does Not Work
119========================
120
121If it doesn't work, you will have to troubleshoot it. Do the easy
122things first like double checking your cabling and data rates. You
123might try some non-kernel based programs to see if the back-to-back
124connection works properly. Just something simple like cat /etc/hosts
125/dev/ttyS0 on one machine and cat /dev/ttyS0 on the other will tell you
126if you can send data from one machine to the other. There is no point
127in tearing out your hair in the kernel if the line doesn't work.
128
129If you need to debug the GDB/KGDB communication itself, the gdb commands
130"set debug remote 1" and "set debug serial 1" may be useful, but be
131warned: they produce a lot of output.
132
133Threads
134=======
135
136Each process in a target machine is seen as a gdb thread. gdb thread related
137commands (info threads, thread n) can be used. CONFIG_KGDB_THREAD must
138be defined for this to work.
139
140In this version, kgdb reports PID_MAX (32768) as the process ID for the
141idle process (pid 0), since GDB does not accept 0 as an ID.
142
143Detaching (exiting KGDB)
144=========================
145
146There are two ways to resume full-speed target execution: "continue" and
147"detach". With "continue", GDB inserts any specified breakpoints in the
148target code and resumes execution; the target is still in "gdb mode".
149If a breakpoint or other debug event (e.g. NMI) happens, the target
150halts and communicates with GDB again, which is waiting for it.
151
152With "detach", GDB does *not* insert any breakpoints; target execution
153is resumed and GDB stops communicating (does not wait for the target).
154In this case, the target is no longer in "gdb mode" -- for example,
155console messages no longer get sent separately to the KGDB port, or
156encapsulated for GDB. If a debug event (e.g. NMI) occurs, the target
157will re-enter "gdb mode" and will display this fact on the console; you
158must give a new "target remote" command to gdb.
159
160NOTE: TO AVOID LOSSING CONSOLE MESSAGES IN CASE THE KERNEL CONSOLE AND
161KGDB USING THE SAME PORT, THE TARGET WAITS FOR ANY INPUT CHARACTER ON
162THE KGDB PORT AFTER A DETACH COMMAND. For example, after the detach you
163could start a terminal emulator on the same host port and enter a <cr>;
164however, this program must then be terminated or suspended in order to
165use GBD again if KGDB is re-entered.
166
167
168Acknowledgements
169================
170
171This code was mostly generated by Henry Bell <henry.bell@st.com>;
172largely from KGDB by Amit S. Kale <akale@veritas.com> - extracts from
173code by Glenn Engel, Jim Kingdon, David Grothe <dave@gcom.com>, Tigran
174Aivazian <tigran@sco.com>, William Gatliff <bgat@open-widgets.com>, Ben
175Lee, Steve Chamberlain and Benoit Miller <fulg@iname.com> are also
176included.
177
178Jeremy Siegel
179<jsiegel@mvista.com>
diff --git a/Documentation/sound/alsa/ALSA-Configuration.txt b/Documentation/sound/alsa/ALSA-Configuration.txt
index 394d7d378dc7..841a9365d5fd 100644
--- a/Documentation/sound/alsa/ALSA-Configuration.txt
+++ b/Documentation/sound/alsa/ALSA-Configuration.txt
@@ -757,6 +757,8 @@ Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
757 model - force the model name 757 model - force the model name
758 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF) 758 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
759 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots) 759 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
760 probe_only - Only probing and no codec initialization (default=off);
761 Useful to check the initial codec status for debugging
760 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples. 762 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
761 Passing -1 will make the driver to choose the appropriate 763 Passing -1 will make the driver to choose the appropriate
762 value based on the controller chip. 764 value based on the controller chip.
@@ -772,327 +774,23 @@ Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
772 774
773 This module supports multiple cards and autoprobe. 775 This module supports multiple cards and autoprobe.
774 776
777 See Documentation/sound/alsa/HD-Audio.txt for more details about
778 HD-audio driver.
779
775 Each codec may have a model table for different configurations. 780 Each codec may have a model table for different configurations.
776 If your machine isn't listed there, the default (usually minimal) 781 If your machine isn't listed there, the default (usually minimal)
777 configuration is set up. You can pass "model=<name>" option to 782 configuration is set up. You can pass "model=<name>" option to
778 specify a certain model in such a case. There are different 783 specify a certain model in such a case. There are different
779 models depending on the codec chip. 784 models depending on the codec chip. The list of available models
780 785 is found in HD-Audio-Models.txt
781 Model name Description
782 ---------- -----------
783 ALC880
784 3stack 3-jack in back and a headphone out
785 3stack-digout 3-jack in back, a HP out and a SPDIF out
786 5stack 5-jack in back, 2-jack in front
787 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
788 6stack 6-jack in back, 2-jack in front
789 6stack-digout 6-jack with a SPDIF out
790 w810 3-jack
791 z71v 3-jack (HP shared SPDIF)
792 asus 3-jack (ASUS Mobo)
793 asus-w1v ASUS W1V
794 asus-dig ASUS with SPDIF out
795 asus-dig2 ASUS with SPDIF out (using GPIO2)
796 uniwill 3-jack
797 fujitsu Fujitsu Laptops (Pi1536)
798 F1734 2-jack
799 lg LG laptop (m1 express dual)
800 lg-lw LG LW20/LW25 laptop
801 tcl TCL S700
802 clevo Clevo laptops (m520G, m665n)
803 medion Medion Rim 2150
804 test for testing/debugging purpose, almost all controls can be
805 adjusted. Appearing only when compiled with
806 $CONFIG_SND_DEBUG=y
807 auto auto-config reading BIOS (default)
808
809 ALC260
810 hp HP machines
811 hp-3013 HP machines (3013-variant)
812 hp-dc7600 HP DC7600
813 fujitsu Fujitsu S7020
814 acer Acer TravelMate
815 will Will laptops (PB V7900)
816 replacer Replacer 672V
817 basic fixed pin assignment (old default model)
818 test for testing/debugging purpose, almost all controls can
819 adjusted. Appearing only when compiled with
820 $CONFIG_SND_DEBUG=y
821 auto auto-config reading BIOS (default)
822
823 ALC262
824 fujitsu Fujitsu Laptop
825 hp-bpc HP xw4400/6400/8400/9400 laptops
826 hp-bpc-d7000 HP BPC D7000
827 hp-tc-t5735 HP Thin Client T5735
828 hp-rp5700 HP RP5700
829 benq Benq ED8
830 benq-t31 Benq T31
831 hippo Hippo (ATI) with jack detection, Sony UX-90s
832 hippo_1 Hippo (Benq) with jack detection
833 sony-assamd Sony ASSAMD
834 toshiba-s06 Toshiba S06
835 toshiba-rx1 Toshiba RX1
836 ultra Samsung Q1 Ultra Vista model
837 lenovo-3000 Lenovo 3000 y410
838 nec NEC Versa S9100
839 basic fixed pin assignment w/o SPDIF
840 auto auto-config reading BIOS (default)
841
842 ALC267/268
843 quanta-il1 Quanta IL1 mini-notebook
844 3stack 3-stack model
845 toshiba Toshiba A205
846 acer Acer laptops
847 acer-aspire Acer Aspire One
848 dell Dell OEM laptops (Vostro 1200)
849 zepto Zepto laptops
850 test for testing/debugging purpose, almost all controls can
851 adjusted. Appearing only when compiled with
852 $CONFIG_SND_DEBUG=y
853 auto auto-config reading BIOS (default)
854
855 ALC269
856 basic Basic preset
857 quanta Quanta FL1
858 eeepc-p703 ASUS Eeepc P703 P900A
859 eeepc-p901 ASUS Eeepc P901 S101
860
861 ALC662/663
862 3stack-dig 3-stack (2-channel) with SPDIF
863 3stack-6ch 3-stack (6-channel)
864 3stack-6ch-dig 3-stack (6-channel) with SPDIF
865 6stack-dig 6-stack with SPDIF
866 lenovo-101e Lenovo laptop
867 eeepc-p701 ASUS Eeepc P701
868 eeepc-ep20 ASUS Eeepc EP20
869 ecs ECS/Foxconn mobo
870 m51va ASUS M51VA
871 g71v ASUS G71V
872 h13 ASUS H13
873 g50v ASUS G50V
874 asus-mode1 ASUS
875 asus-mode2 ASUS
876 asus-mode3 ASUS
877 asus-mode4 ASUS
878 asus-mode5 ASUS
879 asus-mode6 ASUS
880 auto auto-config reading BIOS (default)
881
882 ALC882/885
883 3stack-dig 3-jack with SPDIF I/O
884 6stack-dig 6-jack digital with SPDIF I/O
885 arima Arima W820Di1
886 targa Targa T8, MSI-1049 T8
887 asus-a7j ASUS A7J
888 asus-a7m ASUS A7M
889 macpro MacPro support
890 mbp3 Macbook Pro rev3
891 imac24 iMac 24'' with jack detection
892 w2jc ASUS W2JC
893 auto auto-config reading BIOS (default)
894
895 ALC883/888
896 3stack-dig 3-jack with SPDIF I/O
897 6stack-dig 6-jack digital with SPDIF I/O
898 3stack-6ch 3-jack 6-channel
899 3stack-6ch-dig 3-jack 6-channel with SPDIF I/O
900 6stack-dig-demo 6-jack digital for Intel demo board
901 acer Acer laptops (Travelmate 3012WTMi, Aspire 5600, etc)
902 acer-aspire Acer Aspire 9810
903 medion Medion Laptops
904 medion-md2 Medion MD2
905 targa-dig Targa/MSI
906 targa-2ch-dig Targs/MSI with 2-channel
907 laptop-eapd 3-jack with SPDIF I/O and EAPD (Clevo M540JE, M550JE)
908 lenovo-101e Lenovo 101E
909 lenovo-nb0763 Lenovo NB0763
910 lenovo-ms7195-dig Lenovo MS7195
911 lenovo-sky Lenovo Sky
912 haier-w66 Haier W66
913 3stack-hp HP machines with 3stack (Lucknow, Samba boards)
914 6stack-dell Dell machines with 6stack (Inspiron 530)
915 mitac Mitac 8252D
916 clevo-m720 Clevo M720 laptop series
917 fujitsu-pi2515 Fujitsu AMILO Pi2515
918 3stack-6ch-intel Intel DG33* boards
919 auto auto-config reading BIOS (default)
920
921 ALC861/660
922 3stack 3-jack
923 3stack-dig 3-jack with SPDIF I/O
924 6stack-dig 6-jack with SPDIF I/O
925 3stack-660 3-jack (for ALC660)
926 uniwill-m31 Uniwill M31 laptop
927 toshiba Toshiba laptop support
928 asus Asus laptop support
929 asus-laptop ASUS F2/F3 laptops
930 auto auto-config reading BIOS (default)
931
932 ALC861VD/660VD
933 3stack 3-jack
934 3stack-dig 3-jack with SPDIF OUT
935 6stack-dig 6-jack with SPDIF OUT
936 3stack-660 3-jack (for ALC660VD)
937 3stack-660-digout 3-jack with SPDIF OUT (for ALC660VD)
938 lenovo Lenovo 3000 C200
939 dallas Dallas laptops
940 hp HP TX1000
941 auto auto-config reading BIOS (default)
942
943 CMI9880
944 minimal 3-jack in back
945 min_fp 3-jack in back, 2-jack in front
946 full 6-jack in back, 2-jack in front
947 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
948 allout 5-jack in back, 2-jack in front, SPDIF out
949 auto auto-config reading BIOS (default)
950
951 AD1882 / AD1882A
952 3stack 3-stack mode (default)
953 6stack 6-stack mode
954
955 AD1884A / AD1883 / AD1984A / AD1984B
956 desktop 3-stack desktop (default)
957 laptop laptop with HP jack sensing
958 mobile mobile devices with HP jack sensing
959 thinkpad Lenovo Thinkpad X300
960
961 AD1884
962 N/A
963
964 AD1981
965 basic 3-jack (default)
966 hp HP nx6320
967 thinkpad Lenovo Thinkpad T60/X60/Z60
968 toshiba Toshiba U205
969
970 AD1983
971 N/A
972
973 AD1984
974 basic default configuration
975 thinkpad Lenovo Thinkpad T61/X61
976 dell Dell T3400
977
978 AD1986A
979 6stack 6-jack, separate surrounds (default)
980 3stack 3-stack, shared surrounds
981 laptop 2-channel only (FSC V2060, Samsung M50)
982 laptop-eapd 2-channel with EAPD (Samsung R65, ASUS A6J)
983 laptop-automute 2-channel with EAPD and HP-automute (Lenovo N100)
984 ultra 2-channel with EAPD (Samsung Ultra tablet PC)
985
986 AD1988/AD1988B/AD1989A/AD1989B
987 6stack 6-jack
988 6stack-dig ditto with SPDIF
989 3stack 3-jack
990 3stack-dig ditto with SPDIF
991 laptop 3-jack with hp-jack automute
992 laptop-dig ditto with SPDIF
993 auto auto-config reading BIOS (default)
994
995 Conexant 5045
996 laptop-hpsense Laptop with HP sense (old model laptop)
997 laptop-micsense Laptop with Mic sense (old model fujitsu)
998 laptop-hpmicsense Laptop with HP and Mic senses
999 benq Benq R55E
1000 test for testing/debugging purpose, almost all controls
1001 can be adjusted. Appearing only when compiled with
1002 $CONFIG_SND_DEBUG=y
1003
1004 Conexant 5047
1005 laptop Basic Laptop config
1006 laptop-hp Laptop config for some HP models (subdevice 30A5)
1007 laptop-eapd Laptop config with EAPD support
1008 test for testing/debugging purpose, almost all controls
1009 can be adjusted. Appearing only when compiled with
1010 $CONFIG_SND_DEBUG=y
1011
1012 Conexant 5051
1013 laptop Basic Laptop config (default)
1014 hp HP Spartan laptop
1015
1016 STAC9200
1017 ref Reference board
1018 dell-d21 Dell (unknown)
1019 dell-d22 Dell (unknown)
1020 dell-d23 Dell (unknown)
1021 dell-m21 Dell Inspiron 630m, Dell Inspiron 640m
1022 dell-m22 Dell Latitude D620, Dell Latitude D820
1023 dell-m23 Dell XPS M1710, Dell Precision M90
1024 dell-m24 Dell Latitude 120L
1025 dell-m25 Dell Inspiron E1505n
1026 dell-m26 Dell Inspiron 1501
1027 dell-m27 Dell Inspiron E1705/9400
1028 gateway Gateway laptops with EAPD control
1029 panasonic Panasonic CF-74
1030
1031 STAC9205/9254
1032 ref Reference board
1033 dell-m42 Dell (unknown)
1034 dell-m43 Dell Precision
1035 dell-m44 Dell Inspiron
1036
1037 STAC9220/9221
1038 ref Reference board
1039 3stack D945 3stack
1040 5stack D945 5stack + SPDIF
1041 intel-mac-v1 Intel Mac Type 1
1042 intel-mac-v2 Intel Mac Type 2
1043 intel-mac-v3 Intel Mac Type 3
1044 intel-mac-v4 Intel Mac Type 4
1045 intel-mac-v5 Intel Mac Type 5
1046 intel-mac-auto Intel Mac (detect type according to subsystem id)
1047 macmini Intel Mac Mini (equivalent with type 3)
1048 macbook Intel Mac Book (eq. type 5)
1049 macbook-pro-v1 Intel Mac Book Pro 1st generation (eq. type 3)
1050 macbook-pro Intel Mac Book Pro 2nd generation (eq. type 3)
1051 imac-intel Intel iMac (eq. type 2)
1052 imac-intel-20 Intel iMac (newer version) (eq. type 3)
1053 dell-d81 Dell (unknown)
1054 dell-d82 Dell (unknown)
1055 dell-m81 Dell (unknown)
1056 dell-m82 Dell XPS M1210
1057
1058 STAC9202/9250/9251
1059 ref Reference board, base config
1060 m2-2 Some Gateway MX series laptops
1061 m6 Some Gateway NX series laptops
1062 pa6 Gateway NX860 series
1063
1064 STAC9227/9228/9229/927x
1065 ref Reference board
1066 ref-no-jd Reference board without HP/Mic jack detection
1067 3stack D965 3stack
1068 5stack D965 5stack + SPDIF
1069 dell-3stack Dell Dimension E520
1070 dell-bios Fixes with Dell BIOS setup
1071
1072 STAC92HD71B*
1073 ref Reference board
1074 dell-m4-1 Dell desktops
1075 dell-m4-2 Dell desktops
1076 dell-m4-3 Dell desktops
1077
1078 STAC92HD73*
1079 ref Reference board
1080 no-jd BIOS setup but without jack-detection
1081 dell-m6-amic Dell desktops/laptops with analog mics
1082 dell-m6-dmic Dell desktops/laptops with digital mics
1083 dell-m6 Dell desktops/laptops with both type of mics
1084
1085 STAC9872
1086 vaio Setup for VAIO FE550G/SZ110
1087 vaio-ar Setup for VAIO AR
1088 786
1089 The model name "genric" is treated as a special case. When this 787 The model name "genric" is treated as a special case. When this
1090 model is given, the driver uses the generic codec parser without 788 model is given, the driver uses the generic codec parser without
1091 "codec-patch". It's sometimes good for testing and debugging. 789 "codec-patch". It's sometimes good for testing and debugging.
1092 790
1093 If the default configuration doesn't work and one of the above 791 If the default configuration doesn't work and one of the above
1094 matches with your device, report it together with the PCI 792 matches with your device, report it together with alsa-info.sh
1095 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel 793 output (with --no-upload option) to kernel bugzilla or alsa-devel
1096 ML (see the section "Links and Addresses"). 794 ML (see the section "Links and Addresses").
1097 795
1098 power_save and power_save_controller options are for power-saving 796 power_save and power_save_controller options are for power-saving
@@ -1652,7 +1350,8 @@ Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
1652 * AuzenTech X-Meridian 1350 * AuzenTech X-Meridian
1653 * Bgears b-Enspirer 1351 * Bgears b-Enspirer
1654 * Club3D Theatron DTS 1352 * Club3D Theatron DTS
1655 * HT-Omega Claro 1353 * HT-Omega Claro (plus)
1354 * HT-Omega Claro halo (XT)
1656 * Razer Barracuda AC-1 1355 * Razer Barracuda AC-1
1657 * Sondigo Inferno 1356 * Sondigo Inferno
1658 1357
@@ -2409,8 +2108,11 @@ Links and Addresses
2409 ALSA project homepage 2108 ALSA project homepage
2410 http://www.alsa-project.org 2109 http://www.alsa-project.org
2411 2110
2412 ALSA Bug Tracking System 2111 Kernel Bugzilla
2413 https://bugtrack.alsa-project.org/bugs/ 2112 http://bugzilla.kernel.org/
2414 2113
2415 ALSA Developers ML 2114 ALSA Developers ML
2416 mailto:alsa-devel@alsa-project.org 2115 mailto:alsa-devel@alsa-project.org
2116
2117 alsa-info.sh script
2118 http://www.alsa-project.org/alsa-info.sh
diff --git a/Documentation/sound/alsa/HD-Audio-Models.txt b/Documentation/sound/alsa/HD-Audio-Models.txt
new file mode 100644
index 000000000000..4b7ac21ea9eb
--- /dev/null
+++ b/Documentation/sound/alsa/HD-Audio-Models.txt
@@ -0,0 +1,348 @@
1 Model name Description
2 ---------- -----------
3ALC880
4======
5 3stack 3-jack in back and a headphone out
6 3stack-digout 3-jack in back, a HP out and a SPDIF out
7 5stack 5-jack in back, 2-jack in front
8 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
9 6stack 6-jack in back, 2-jack in front
10 6stack-digout 6-jack with a SPDIF out
11 w810 3-jack
12 z71v 3-jack (HP shared SPDIF)
13 asus 3-jack (ASUS Mobo)
14 asus-w1v ASUS W1V
15 asus-dig ASUS with SPDIF out
16 asus-dig2 ASUS with SPDIF out (using GPIO2)
17 uniwill 3-jack
18 fujitsu Fujitsu Laptops (Pi1536)
19 F1734 2-jack
20 lg LG laptop (m1 express dual)
21 lg-lw LG LW20/LW25 laptop
22 tcl TCL S700
23 clevo Clevo laptops (m520G, m665n)
24 medion Medion Rim 2150
25 test for testing/debugging purpose, almost all controls can be
26 adjusted. Appearing only when compiled with
27 $CONFIG_SND_DEBUG=y
28 auto auto-config reading BIOS (default)
29
30ALC260
31======
32 hp HP machines
33 hp-3013 HP machines (3013-variant)
34 hp-dc7600 HP DC7600
35 fujitsu Fujitsu S7020
36 acer Acer TravelMate
37 will Will laptops (PB V7900)
38 replacer Replacer 672V
39 basic fixed pin assignment (old default model)
40 test for testing/debugging purpose, almost all controls can
41 adjusted. Appearing only when compiled with
42 $CONFIG_SND_DEBUG=y
43 auto auto-config reading BIOS (default)
44
45ALC262
46======
47 fujitsu Fujitsu Laptop
48 hp-bpc HP xw4400/6400/8400/9400 laptops
49 hp-bpc-d7000 HP BPC D7000
50 hp-tc-t5735 HP Thin Client T5735
51 hp-rp5700 HP RP5700
52 benq Benq ED8
53 benq-t31 Benq T31
54 hippo Hippo (ATI) with jack detection, Sony UX-90s
55 hippo_1 Hippo (Benq) with jack detection
56 sony-assamd Sony ASSAMD
57 toshiba-s06 Toshiba S06
58 toshiba-rx1 Toshiba RX1
59 ultra Samsung Q1 Ultra Vista model
60 lenovo-3000 Lenovo 3000 y410
61 nec NEC Versa S9100
62 basic fixed pin assignment w/o SPDIF
63 auto auto-config reading BIOS (default)
64
65ALC267/268
66==========
67 quanta-il1 Quanta IL1 mini-notebook
68 3stack 3-stack model
69 toshiba Toshiba A205
70 acer Acer laptops
71 acer-dmic Acer laptops with digital-mic
72 acer-aspire Acer Aspire One
73 dell Dell OEM laptops (Vostro 1200)
74 zepto Zepto laptops
75 test for testing/debugging purpose, almost all controls can
76 adjusted. Appearing only when compiled with
77 $CONFIG_SND_DEBUG=y
78 auto auto-config reading BIOS (default)
79
80ALC269
81======
82 basic Basic preset
83 quanta Quanta FL1
84 eeepc-p703 ASUS Eeepc P703 P900A
85 eeepc-p901 ASUS Eeepc P901 S101
86 fujitsu FSC Amilo
87 auto auto-config reading BIOS (default)
88
89ALC662/663
90==========
91 3stack-dig 3-stack (2-channel) with SPDIF
92 3stack-6ch 3-stack (6-channel)
93 3stack-6ch-dig 3-stack (6-channel) with SPDIF
94 6stack-dig 6-stack with SPDIF
95 lenovo-101e Lenovo laptop
96 eeepc-p701 ASUS Eeepc P701
97 eeepc-ep20 ASUS Eeepc EP20
98 ecs ECS/Foxconn mobo
99 m51va ASUS M51VA
100 g71v ASUS G71V
101 h13 ASUS H13
102 g50v ASUS G50V
103 asus-mode1 ASUS
104 asus-mode2 ASUS
105 asus-mode3 ASUS
106 asus-mode4 ASUS
107 asus-mode5 ASUS
108 asus-mode6 ASUS
109 auto auto-config reading BIOS (default)
110
111ALC882/885
112==========
113 3stack-dig 3-jack with SPDIF I/O
114 6stack-dig 6-jack digital with SPDIF I/O
115 arima Arima W820Di1
116 targa Targa T8, MSI-1049 T8
117 asus-a7j ASUS A7J
118 asus-a7m ASUS A7M
119 macpro MacPro support
120 mbp3 Macbook Pro rev3
121 imac24 iMac 24'' with jack detection
122 w2jc ASUS W2JC
123 auto auto-config reading BIOS (default)
124
125ALC883/888
126==========
127 3stack-dig 3-jack with SPDIF I/O
128 6stack-dig 6-jack digital with SPDIF I/O
129 3stack-6ch 3-jack 6-channel
130 3stack-6ch-dig 3-jack 6-channel with SPDIF I/O
131 6stack-dig-demo 6-jack digital for Intel demo board
132 acer Acer laptops (Travelmate 3012WTMi, Aspire 5600, etc)
133 acer-aspire Acer Aspire 9810
134 acer-aspire-4930g Acer Aspire 4930G
135 medion Medion Laptops
136 medion-md2 Medion MD2
137 targa-dig Targa/MSI
138 targa-2ch-dig Targs/MSI with 2-channel
139 laptop-eapd 3-jack with SPDIF I/O and EAPD (Clevo M540JE, M550JE)
140 lenovo-101e Lenovo 101E
141 lenovo-nb0763 Lenovo NB0763
142 lenovo-ms7195-dig Lenovo MS7195
143 lenovo-sky Lenovo Sky
144 haier-w66 Haier W66
145 3stack-hp HP machines with 3stack (Lucknow, Samba boards)
146 6stack-dell Dell machines with 6stack (Inspiron 530)
147 mitac Mitac 8252D
148 clevo-m720 Clevo M720 laptop series
149 fujitsu-pi2515 Fujitsu AMILO Pi2515
150 fujitsu-xa3530 Fujitsu AMILO XA3530
151 3stack-6ch-intel Intel DG33* boards
152 auto auto-config reading BIOS (default)
153
154ALC861/660
155==========
156 3stack 3-jack
157 3stack-dig 3-jack with SPDIF I/O
158 6stack-dig 6-jack with SPDIF I/O
159 3stack-660 3-jack (for ALC660)
160 uniwill-m31 Uniwill M31 laptop
161 toshiba Toshiba laptop support
162 asus Asus laptop support
163 asus-laptop ASUS F2/F3 laptops
164 auto auto-config reading BIOS (default)
165
166ALC861VD/660VD
167==============
168 3stack 3-jack
169 3stack-dig 3-jack with SPDIF OUT
170 6stack-dig 6-jack with SPDIF OUT
171 3stack-660 3-jack (for ALC660VD)
172 3stack-660-digout 3-jack with SPDIF OUT (for ALC660VD)
173 lenovo Lenovo 3000 C200
174 dallas Dallas laptops
175 hp HP TX1000
176 asus-v1s ASUS V1Sn
177 auto auto-config reading BIOS (default)
178
179CMI9880
180=======
181 minimal 3-jack in back
182 min_fp 3-jack in back, 2-jack in front
183 full 6-jack in back, 2-jack in front
184 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
185 allout 5-jack in back, 2-jack in front, SPDIF out
186 auto auto-config reading BIOS (default)
187
188AD1882 / AD1882A
189================
190 3stack 3-stack mode (default)
191 6stack 6-stack mode
192
193AD1884A / AD1883 / AD1984A / AD1984B
194====================================
195 desktop 3-stack desktop (default)
196 laptop laptop with HP jack sensing
197 mobile mobile devices with HP jack sensing
198 thinkpad Lenovo Thinkpad X300
199
200AD1884
201======
202 N/A
203
204AD1981
205======
206 basic 3-jack (default)
207 hp HP nx6320
208 thinkpad Lenovo Thinkpad T60/X60/Z60
209 toshiba Toshiba U205
210
211AD1983
212======
213 N/A
214
215AD1984
216======
217 basic default configuration
218 thinkpad Lenovo Thinkpad T61/X61
219 dell Dell T3400
220
221AD1986A
222=======
223 6stack 6-jack, separate surrounds (default)
224 3stack 3-stack, shared surrounds
225 laptop 2-channel only (FSC V2060, Samsung M50)
226 laptop-eapd 2-channel with EAPD (ASUS A6J)
227 laptop-automute 2-channel with EAPD and HP-automute (Lenovo N100)
228 ultra 2-channel with EAPD (Samsung Ultra tablet PC)
229 samsung 2-channel with EAPD (Samsung R65)
230
231AD1988/AD1988B/AD1989A/AD1989B
232==============================
233 6stack 6-jack
234 6stack-dig ditto with SPDIF
235 3stack 3-jack
236 3stack-dig ditto with SPDIF
237 laptop 3-jack with hp-jack automute
238 laptop-dig ditto with SPDIF
239 auto auto-config reading BIOS (default)
240
241Conexant 5045
242=============
243 laptop-hpsense Laptop with HP sense (old model laptop)
244 laptop-micsense Laptop with Mic sense (old model fujitsu)
245 laptop-hpmicsense Laptop with HP and Mic senses
246 benq Benq R55E
247 test for testing/debugging purpose, almost all controls
248 can be adjusted. Appearing only when compiled with
249 $CONFIG_SND_DEBUG=y
250
251Conexant 5047
252=============
253 laptop Basic Laptop config
254 laptop-hp Laptop config for some HP models (subdevice 30A5)
255 laptop-eapd Laptop config with EAPD support
256 test for testing/debugging purpose, almost all controls
257 can be adjusted. Appearing only when compiled with
258 $CONFIG_SND_DEBUG=y
259
260Conexant 5051
261=============
262 laptop Basic Laptop config (default)
263 hp HP Spartan laptop
264
265STAC9200
266========
267 ref Reference board
268 dell-d21 Dell (unknown)
269 dell-d22 Dell (unknown)
270 dell-d23 Dell (unknown)
271 dell-m21 Dell Inspiron 630m, Dell Inspiron 640m
272 dell-m22 Dell Latitude D620, Dell Latitude D820
273 dell-m23 Dell XPS M1710, Dell Precision M90
274 dell-m24 Dell Latitude 120L
275 dell-m25 Dell Inspiron E1505n
276 dell-m26 Dell Inspiron 1501
277 dell-m27 Dell Inspiron E1705/9400
278 gateway Gateway laptops with EAPD control
279 panasonic Panasonic CF-74
280
281STAC9205/9254
282=============
283 ref Reference board
284 dell-m42 Dell (unknown)
285 dell-m43 Dell Precision
286 dell-m44 Dell Inspiron
287
288STAC9220/9221
289=============
290 ref Reference board
291 3stack D945 3stack
292 5stack D945 5stack + SPDIF
293 intel-mac-v1 Intel Mac Type 1
294 intel-mac-v2 Intel Mac Type 2
295 intel-mac-v3 Intel Mac Type 3
296 intel-mac-v4 Intel Mac Type 4
297 intel-mac-v5 Intel Mac Type 5
298 intel-mac-auto Intel Mac (detect type according to subsystem id)
299 macmini Intel Mac Mini (equivalent with type 3)
300 macbook Intel Mac Book (eq. type 5)
301 macbook-pro-v1 Intel Mac Book Pro 1st generation (eq. type 3)
302 macbook-pro Intel Mac Book Pro 2nd generation (eq. type 3)
303 imac-intel Intel iMac (eq. type 2)
304 imac-intel-20 Intel iMac (newer version) (eq. type 3)
305 dell-d81 Dell (unknown)
306 dell-d82 Dell (unknown)
307 dell-m81 Dell (unknown)
308 dell-m82 Dell XPS M1210
309
310STAC9202/9250/9251
311==================
312 ref Reference board, base config
313 m2-2 Some Gateway MX series laptops
314 m6 Some Gateway NX series laptops
315 pa6 Gateway NX860 series
316
317STAC9227/9228/9229/927x
318=======================
319 ref Reference board
320 ref-no-jd Reference board without HP/Mic jack detection
321 3stack D965 3stack
322 5stack D965 5stack + SPDIF
323 dell-3stack Dell Dimension E520
324 dell-bios Fixes with Dell BIOS setup
325
326STAC92HD71B*
327============
328 ref Reference board
329 dell-m4-1 Dell desktops
330 dell-m4-2 Dell desktops
331 dell-m4-3 Dell desktops
332
333STAC92HD73*
334===========
335 ref Reference board
336 no-jd BIOS setup but without jack-detection
337 dell-m6-amic Dell desktops/laptops with analog mics
338 dell-m6-dmic Dell desktops/laptops with digital mics
339 dell-m6 Dell desktops/laptops with both type of mics
340
341STAC92HD83*
342===========
343 ref Reference board
344
345STAC9872
346========
347 vaio Setup for VAIO FE550G/SZ110
348 vaio-ar Setup for VAIO AR
diff --git a/Documentation/sound/alsa/HD-Audio.txt b/Documentation/sound/alsa/HD-Audio.txt
new file mode 100644
index 000000000000..8d68fff71839
--- /dev/null
+++ b/Documentation/sound/alsa/HD-Audio.txt
@@ -0,0 +1,577 @@
1MORE NOTES ON HD-AUDIO DRIVER
2=============================
3 Takashi Iwai <tiwai@suse.de>
4
5
6GENERAL
7-------
8
9HD-audio is the new standard on-board audio component on modern PCs
10after AC97. Although Linux has been supporting HD-audio since long
11time ago, there are often problems with new machines. A part of the
12problem is broken BIOS, and the rest is the driver implementation.
13This document explains the brief trouble-shooting and debugging
14methods for the HD-audio hardware.
15
16The HD-audio component consists of two parts: the controller chip and
17the codec chips on the HD-audio bus. Linux provides a single driver
18for all controllers, snd-hda-intel. Although the driver name contains
19a word of a well-known harware vendor, it's not specific to it but for
20all controller chips by other companies. Since the HD-audio
21controllers are supposed to be compatible, the single snd-hda-driver
22should work in most cases. But, not surprisingly, there are known
23bugs and issues specific to each controller type. The snd-hda-intel
24driver has a bunch of workarounds for these as described below.
25
26A controller may have multiple codecs. Usually you have one audio
27codec and optionally one modem codec. In theory, there might be
28multiple audio codecs, e.g. for analog and digital outputs, and the
29driver might not work properly because of conflict of mixer elements.
30This should be fixed in future if such hardware really exists.
31
32The snd-hda-intel driver has several different codec parsers depending
33on the codec. It has a generic parser as a fallback, but this
34functionality is fairly limited until now. Instead of the generic
35parser, usually the codec-specific parser (coded in patch_*.c) is used
36for the codec-specific implementations. The details about the
37codec-specific problems are explained in the later sections.
38
39If you are interested in the deep debugging of HD-audio, read the
40HD-audio specification at first. The specification is found on
41Intel's web page, for example:
42
43- http://www.intel.com/standards/hdaudio/
44
45
46HD-AUDIO CONTROLLER
47-------------------
48
49DMA-Position Problem
50~~~~~~~~~~~~~~~~~~~~
51The most common problem of the controller is the inaccurate DMA
52pointer reporting. The DMA pointer for playback and capture can be
53read in two ways, either via a LPIB register or via a position-buffer
54map. As default the driver tries to read from the io-mapped
55position-buffer, and falls back to LPIB if the position-buffer appears
56dead. However, this detection isn't perfect on some devices. In such
57a case, you can change the default method via `position_fix` option.
58
59`position_fix=1` means to use LPIB method explicitly.
60`position_fix=2` means to use the position-buffer. 0 is the default
61value, the automatic check and fallback to LPIB as described in the
62above. If you get a problem of repeated sounds, this option might
63help.
64
65In addition to that, every controller is known to be broken regarding
66the wake-up timing. It wakes up a few samples before actually
67processing the data on the buffer. This caused a lot of problems, for
68example, with ALSA dmix or JACK. Since 2.6.27 kernel, the driver puts
69an artificial delay to the wake up timing. This delay is controlled
70via `bdl_pos_adj` option.
71
72When `bdl_pos_adj` is a negative value (as default), it's assigned to
73an appropriate value depending on the controller chip. For Intel
74chips, it'd be 1 while it'd be 32 for others. Usually this works.
75Only in case it doesn't work and you get warning messages, you should
76change this parameter to other values.
77
78
79Codec-Probing Problem
80~~~~~~~~~~~~~~~~~~~~~
81A less often but a more severe problem is the codec probing. When
82BIOS reports the available codec slots wrongly, the driver gets
83confused and tries to access the non-existing codec slot. This often
84results in the total screw-up, and destructs the further communication
85with the codec chips. The symptom appears usually as error messages
86like:
87------------------------------------------------------------------------
88 hda_intel: azx_get_response timeout, switching to polling mode:
89 last cmd=0x12345678
90 hda_intel: azx_get_response timeout, switching to single_cmd mode:
91 last cmd=0x12345678
92------------------------------------------------------------------------
93
94The first line is a warning, and this is usually relatively harmless.
95It means that the codec response isn't notified via an IRQ. The
96driver uses explicit polling method to read the response. It gives
97very slight CPU overhead, but you'd unlikely notice it.
98
99The second line is, however, a fatal error. If this happens, usually
100it means that something is really wrong. Most likely you are
101accessing a non-existing codec slot.
102
103Thus, if the second error message appears, try to narrow the probed
104codec slots via `probe_mask` option. It's a bitmask, and each bit
105corresponds to the codec slot. For example, to probe only the first
106slot, pass `probe_mask=1`. For the first and the third slots, pass
107`probe_mask=5` (where 5 = 1 | 4), and so on.
108
109Since 2.6.29 kernel, the driver has a more robust probing method, so
110this error might happen rarely, though.
111
112
113Interrupt Handling
114~~~~~~~~~~~~~~~~~~
115In rare but some cases, the interrupt isn't properly handled as
116default. You would notice this by the DMA transfer error reported by
117ALSA PCM core, for example. Using MSI might help in such a case.
118Pass `enable_msi=1` option for enabling MSI.
119
120
121HD-AUDIO CODEC
122--------------
123
124Model Option
125~~~~~~~~~~~~
126The most common problem regarding the HD-audio driver is the
127unsupported codec features or the mismatched device configuration.
128Most of codec-specific code has several preset models, either to
129override the BIOS setup or to provide more comprehensive features.
130
131The driver checks PCI SSID and looks through the static configuration
132table until any matching entry is found. If you have a new machine,
133you may see a message like below:
134------------------------------------------------------------------------
135 hda_codec: Unknown model for ALC880, trying auto-probe from BIOS...
136------------------------------------------------------------------------
137Even if you see such a message, DON'T PANIC. Take a deep breath and
138keep your towel. First of all, it's an informational message, no
139warning, no error. This means that the PCI SSID of your device isn't
140listed in the known preset model (white-)list. But, this doesn't mean
141that the driver is broken. Many codec-drivers provide the automatic
142configuration mechanism based on the BIOS setup.
143
144The HD-audio codec has usually "pin" widgets, and BIOS sets the default
145configuration of each pin, which indicates the location, the
146connection type, the jack color, etc. The HD-audio driver can guess
147the right connection judging from these default configuration values.
148However -- some codec-support codes, such as patch_analog.c, don't
149support the automatic probing (yet as of 2.6.28). And, BIOS is often,
150yes, pretty often broken. It sets up wrong values and screws up the
151driver.
152
153The preset model is provided basically to overcome such a situation.
154When the matching preset model is found in the white-list, the driver
155assumes the static configuration of that preset and builds the mixer
156elements and PCM streams based on the static information. Thus, if
157you have a newer machine with a slightly different PCI SSID from the
158existing one, you may have a good chance to re-use the same model.
159You can pass the `model` option to specify the preset model instead of
160PCI SSID look-up.
161
162What `model` option values are available depends on the codec chip.
163Check your codec chip from the codec proc file (see "Codec Proc-File"
164section below). It will show the vendor/product name of your codec
165chip. Then, see Documentation/sound/alsa/HD-Audio-Modelstxt file,
166the section of HD-audio driver. You can find a list of codecs
167and `model` options belonging to each codec. For example, for Realtek
168ALC262 codec chip, pass `model=ultra` for devices that are compatible
169with Samsung Q1 Ultra.
170
171Thus, the first thing you can do for any brand-new, unsupported and
172non-working HD-audio hardware is to check HD-audio codec and several
173different `model` option values. If you have a luck, some of them
174might suit with your device well.
175
176Some codecs such as ALC880 have a special model option `model=test`.
177This configures the driver to provide as many mixer controls as
178possible for every single pin feature except for the unsolicited
179events (and maybe some other specials). Adjust each mixer element and
180try the I/O in the way of trial-and-error until figuring out the whole
181I/O pin mappings.
182
183Note that `model=generic` has a special meaning. It means to use the
184generic parser regardless of the codec. Usually the codec-specific
185parser is much better than the generic parser (as now). Thus this
186option is more about the debugging purpose.
187
188
189Speaker and Headphone Output
190~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191One of the most frequent (and obvious) bugs with HD-audio is the
192silent output from either or both of a built-in speaker and a
193headphone jack. In general, you should try a headphone output at
194first. A speaker output often requires more additional controls like
195the external amplifier bits. Thus a headphone output has a slightly
196better chance.
197
198Before making a bug report, double-check whether the mixer is set up
199correctly. The recent version of snd-hda-intel driver provides mostly
200"Master" volume control as well as "Front" volume (where Front
201indicates the front-channels). In addition, there can be individual
202"Headphone" and "Speaker" controls.
203
204Ditto for the speaker output. There can be "External Amplifier"
205switch on some codecs. Turn on this if present.
206
207Another related problem is the automatic mute of speaker output by
208headphone plugging. This feature is implemented in most cases, but
209not on every preset model or codec-support code.
210
211In anyway, try a different model option if you have such a problem.
212Some other models may match better and give you more matching
213functionality. If none of the available models works, send a bug
214report. See the bug report section for details.
215
216If you are masochistic enough to debug the driver problem, note the
217following:
218
219- The speaker (and the headphone, too) output often requires the
220 external amplifier. This can be set usually via EAPD verb or a
221 certain GPIO. If the codec pin supports EAPD, you have a better
222 chance via SET_EAPD_BTL verb (0x70c). On others, GPIO pin (mostly
223 it's either GPIO0 or GPIO1) may turn on/off EAPD.
224- Some Realtek codecs require special vendor-specific coefficients to
225 turn on the amplifier. See patch_realtek.c.
226- IDT codecs may have extra power-enable/disable controls on each
227 analog pin. See patch_sigmatel.c.
228- Very rare but some devices don't accept the pin-detection verb until
229 triggered. Issuing GET_PIN_SENSE verb (0xf09) may result in the
230 codec-communication stall. Some examples are found in
231 patch_realtek.c.
232
233
234Capture Problems
235~~~~~~~~~~~~~~~~
236The capture problems are often because of missing setups of mixers.
237Thus, before submitting a bug report, make sure that you set up the
238mixer correctly. For example, both "Capture Volume" and "Capture
239Switch" have to be set properly in addition to the right "Capture
240Source" or "Input Source" selection. Some devices have "Mic Boost"
241volume or switch.
242
243When the PCM device is opened via "default" PCM (without pulse-audio
244plugin), you'll likely have "Digital Capture Volume" control as well.
245This is provided for the extra gain/attenuation of the signal in
246software, especially for the inputs without the hardware volume
247control such as digital microphones. Unless really needed, this
248should be set to exactly 50%, corresponding to 0dB -- neither extra
249gain nor attenuation. When you use "hw" PCM, i.e., a raw access PCM,
250this control will have no influence, though.
251
252It's known that some codecs / devices have fairly bad analog circuits,
253and the recorded sound contains a certain DC-offset. This is no bug
254of the driver.
255
256Most of modern laptops have no analog CD-input connection. Thus, the
257recording from CD input won't work in many cases although the driver
258provides it as the capture source. Use CDDA instead.
259
260The automatic switching of the built-in and external mic per plugging
261is implemented on some codec models but not on every model. Partly
262because of my laziness but mostly lack of testers. Feel free to
263submit the improvement patch to the author.
264
265
266Direct Debugging
267~~~~~~~~~~~~~~~~
268If no model option gives you a better result, and you are a tough guy
269to fight against evil, try debugging via hitting the raw HD-audio
270codec verbs to the device. Some tools are available: hda-emu and
271hda-analyzer. The detailed description is found in the sections
272below. You'd need to enable hwdep for using these tools. See "Kernel
273Configuration" section.
274
275
276OTHER ISSUES
277------------
278
279Kernel Configuration
280~~~~~~~~~~~~~~~~~~~~
281In general, I recommend you to enable the sound debug option,
282`CONFIG_SND_DEBUG=y`, no matter whether you are debugging or not.
283This enables snd_printd() macro and others, and you'll get additional
284kernel messages at probing.
285
286In addition, you can enable `CONFIG_SND_DEBUG_VERBOSE=y`. But this
287will give you far more messages. Thus turn this on only when you are
288sure to want it.
289
290Don't forget to turn on the appropriate `CONFIG_SND_HDA_CODEC_*`
291options. Note that each of them corresponds to the codec chip, not
292the controller chip. Thus, even if lspci shows the Nvidia controller,
293you may need to choose the option for other vendors. If you are
294unsure, just select all yes.
295
296`CONFIG_SND_HDA_HWDEP` is a useful option for debugging the driver.
297When this is enabled, the driver creates hardware-dependent devices
298(one per each codec), and you have a raw access to the device via
299these device files. For example, `hwC0D2` will be created for the
300codec slot #2 of the first card (#0). For debug-tools such as
301hda-verb and hda-analyzer, the hwdep device has to be enabled.
302Thus, it'd be better to turn this on always.
303
304`CONFIG_SND_HDA_RECONFIG` is a new option, and this depends on the
305hwdep option above. When enabled, you'll have some sysfs files under
306the corresponding hwdep directory. See "HD-audio reconfiguration"
307section below.
308
309`CONFIG_SND_HDA_POWER_SAVE` option enables the power-saving feature.
310See "Power-saving" section below.
311
312
313Codec Proc-File
314~~~~~~~~~~~~~~~
315The codec proc-file is a treasure-chest for debugging HD-audio.
316It shows most of useful information of each codec widget.
317
318The proc file is located in /proc/asound/card*/codec#*, one file per
319each codec slot. You can know the codec vendor, product id and
320names, the type of each widget, capabilities and so on.
321This file, however, doesn't show the jack sensing state, so far. This
322is because the jack-sensing might be depending on the trigger state.
323
324This file will be picked up by the debug tools, and also it can be fed
325to the emulator as the primary codec information. See the debug tools
326section below.
327
328This proc file can be also used to check whether the generic parser is
329used. When the generic parser is used, the vendor/product ID name
330will appear as "Realtek ID 0262", instead of "Realtek ALC262".
331
332
333HD-Audio Reconfiguration
334~~~~~~~~~~~~~~~~~~~~~~~~
335This is an experimental feature to allow you re-configure the HD-audio
336codec dynamically without reloading the driver. The following sysfs
337files are available under each codec-hwdep device directory (e.g.
338/sys/class/sound/hwC0D0):
339
340vendor_id::
341 Shows the 32bit codec vendor-id hex number. You can change the
342 vendor-id value by writing to this file.
343subsystem_id::
344 Shows the 32bit codec subsystem-id hex number. You can change the
345 subsystem-id value by writing to this file.
346revision_id::
347 Shows the 32bit codec revision-id hex number. You can change the
348 revision-id value by writing to this file.
349afg::
350 Shows the AFG ID. This is read-only.
351mfg::
352 Shows the MFG ID. This is read-only.
353name::
354 Shows the codec name string. Can be changed by writing to this
355 file.
356modelname::
357 Shows the currently set `model` option. Can be changed by writing
358 to this file.
359init_verbs::
360 The extra verbs to execute at initialization. You can add a verb by
361 writing to this file. Pass tree numbers, nid, verb and parameter.
362hints::
363 Shows hint strings for codec parsers for any use. Right now it's
364 not used.
365reconfig::
366 Triggers the codec re-configuration. When any value is written to
367 this file, the driver re-initialize and parses the codec tree
368 again. All the changes done by the sysfs entries above are taken
369 into account.
370clear::
371 Resets the codec, removes the mixer elements and PCM stuff of the
372 specified codec, and clear all init verbs and hints.
373
374
375Power-Saving
376~~~~~~~~~~~~
377The power-saving is a kind of auto-suspend of the device. When the
378device is inactive for a certain time, the device is automatically
379turned off to save the power. The time to go down is specified via
380`power_save` module option, and this option can be changed dynamically
381via sysfs.
382
383The power-saving won't work when the analog loopback is enabled on
384some codecs. Make sure that you mute all unneeded signal routes when
385you want the power-saving.
386
387The power-saving feature might cause audible click noises at each
388power-down/up depending on the device. Some of them might be
389solvable, but some are hard, I'm afraid. Some distros such as
390openSUSE enables the power-saving feature automatically when the power
391cable is unplugged. Thus, if you hear noises, suspect first the
392power-saving. See /sys/module/snd_hda_intel/parameters/power_save to
393check the current value. If it's non-zero, the feature is turned on.
394
395
396Development Tree
397~~~~~~~~~~~~~~~~
398The latest development codes for HD-audio are found on sound git tree:
399
400- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound-2.6.git
401
402The master branch or for-next branches can be used as the main
403development branches in general while the HD-audio specific patches
404are committed in topic/hda branch.
405
406If you are using the latest Linus tree, it'd be better to pull the
407above GIT tree onto it. If you are using the older kernels, an easy
408way to try the latest ALSA code is to build from the snapshot
409tarball. There are daily tarballs and the latest snapshot tarball.
410All can be built just like normal alsa-driver release packages, that
411is, installed via the usual spells: configure, make and make
412install(-modules). See INSTALL in the package. The snapshot tarballs
413are found at:
414
415- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/snapshot/
416
417
418Sending a Bug Report
419~~~~~~~~~~~~~~~~~~~~
420If any model or module options don't work for your device, it's time
421to send a bug report to the developers. Give the following in your
422bug report:
423
424- Hardware vendor, product and model names
425- Kernel version (and ALSA-driver version if you built externally)
426- `alsa-info.sh` output; run with `--no-upload` option. See the
427 section below about alsa-info
428
429If it's a regression, at best, send alsa-info outputs of both working
430and non-working kernels. This is really helpful because we can
431compare the codec registers directly.
432
433Send a bug report either the followings:
434
435kernel-bugzilla::
436 http://bugme.linux-foundation.org/
437alsa-devel ML::
438 alsa-devel@alsa-project.org
439
440
441DEBUG TOOLS
442-----------
443
444This section describes some tools available for debugging HD-audio
445problems.
446
447alsa-info
448~~~~~~~~~
449The script `alsa-info.sh` is a very useful tool to gather the audio
450device information. You can fetch the latest version from:
451
452- http://www.alsa-project.org/alsa-info.sh
453
454Run this script as root, and it will gather the important information
455such as the module lists, module parameters, proc file contents
456including the codec proc files, mixer outputs and the control
457elements. As default, it will store the information onto a web server
458on alsa-project.org. But, if you send a bug report, it'd be better to
459run with `--no-upload` option, and attach the generated file.
460
461There are some other useful options. See `--help` option output for
462details.
463
464
465hda-verb
466~~~~~~~~
467hda-verb is a tiny program that allows you to access the HD-audio
468codec directly. You can execute a raw HD-audio codec verb with this.
469This program accesses the hwdep device, thus you need to enable the
470kernel config `CONFIG_SND_HDA_HWDEP=y` beforehand.
471
472The hda-verb program takes four arguments: the hwdep device file, the
473widget NID, the verb and the parameter. When you access to the codec
474on the slot 2 of the card 0, pass /dev/snd/hwC0D2 to the first
475argument, typically. (However, the real path name depends on the
476system.)
477
478The second parameter is the widget number-id to access. The third
479parameter can be either a hex/digit number or a string corresponding
480to a verb. Similarly, the last parameter is the value to write, or
481can be a string for the parameter type.
482
483------------------------------------------------------------------------
484 % hda-verb /dev/snd/hwC0D0 0x12 0x701 2
485 nid = 0x12, verb = 0x701, param = 0x2
486 value = 0x0
487
488 % hda-verb /dev/snd/hwC0D0 0x0 PARAMETERS VENDOR_ID
489 nid = 0x0, verb = 0xf00, param = 0x0
490 value = 0x10ec0262
491
492 % hda-verb /dev/snd/hwC0D0 2 set_a 0xb080
493 nid = 0x2, verb = 0x300, param = 0xb080
494 value = 0x0
495------------------------------------------------------------------------
496
497Although you can issue any verbs with this program, the driver state
498won't be always updated. For example, the volume values are usually
499cached in the driver, and thus changing the widget amp value directly
500via hda-verb won't change the mixer value.
501
502The hda-verb program is found in the ftp directory:
503
504- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/misc/
505
506Also a git repository is available:
507
508- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-verb.git
509
510See README file in the tarball for more details about hda-verb
511program.
512
513
514hda-analyzer
515~~~~~~~~~~~~
516hda-analyzer provides a graphical interface to access the raw HD-audio
517control, based on pyGTK2 binding. It's a more powerful version of
518hda-verb. The program gives you an easy-to-use GUI stuff for showing
519the widget information and adjusting the amp values, as well as the
520proc-compatible output.
521
522The hda-analyzer is a part of alsa.git repository in
523alsa-project.org:
524
525- http://git.alsa-project.org/?p=alsa.git;a=tree;f=hda-analyzer
526
527
528Codecgraph
529~~~~~~~~~~
530Codecgraph is a utility program to generate a graph and visualizes the
531codec-node connection of a codec chip. It's especially useful when
532you analyze or debug a codec without a proper datasheet. The program
533parses the given codec proc file and converts to SVG via graphiz
534program.
535
536The tarball and GIT trees are found in the web page at:
537
538- http://helllabs.org/codecgraph/
539
540
541hda-emu
542~~~~~~~
543hda-emu is an HD-audio emulator. The main purpose of this program is
544to debug an HD-audio codec without the real hardware. Thus, it
545doesn't emulate the behavior with the real audio I/O, but it just
546dumps the codec register changes and the ALSA-driver internal changes
547at probing and operating the HD-audio driver.
548
549The program requires a codec proc-file to simulate. Get a proc file
550for the target codec beforehand, or pick up an example codec from the
551codec proc collections in the tarball. Then, run the program with the
552proc file, and the hda-emu program will start parsing the codec file
553and simulates the HD-audio driver:
554
555------------------------------------------------------------------------
556 % hda-emu codecs/stac9200-dell-d820-laptop
557 # Parsing..
558 hda_codec: Unknown model for STAC9200, using BIOS defaults
559 hda_codec: pin nid 08 bios pin config 40c003fa
560 ....
561------------------------------------------------------------------------
562
563The program gives you only a very dumb command-line interface. You
564can get a proc-file dump at the current state, get a list of control
565(mixer) elements, set/get the control element value, simulate the PCM
566operation, the jack plugging simulation, etc.
567
568The package is found in:
569
570- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/misc/
571
572A git repository is available:
573
574- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-emu.git
575
576See README file in the tarball for more details about hda-emu
577program.
diff --git a/Documentation/sound/alsa/Procfile.txt b/Documentation/sound/alsa/Procfile.txt
index f738b296440a..bba2dbb79d81 100644
--- a/Documentation/sound/alsa/Procfile.txt
+++ b/Documentation/sound/alsa/Procfile.txt
@@ -153,6 +153,16 @@ card*/codec#*
153 Shows the general codec information and the attribute of each 153 Shows the general codec information and the attribute of each
154 widget node. 154 widget node.
155 155
156card*/eld#*
157 Available for HDMI or DisplayPort interfaces.
158 Shows ELD(EDID Like Data) info retrieved from the attached HDMI sink,
159 and describes its audio capabilities and configurations.
160
161 Some ELD fields may be modified by doing `echo name hex_value > eld#*`.
162 Only do this if you are sure the HDMI sink provided value is wrong.
163 And if that makes your HDMI audio work, please report to us so that we
164 can fix it in future kernel releases.
165
156 166
157Sequencer Information 167Sequencer Information
158--------------------- 168---------------------
diff --git a/Documentation/sound/alsa/soc/machine.txt b/Documentation/sound/alsa/soc/machine.txt
index f370e7db86af..bab7711ce963 100644
--- a/Documentation/sound/alsa/soc/machine.txt
+++ b/Documentation/sound/alsa/soc/machine.txt
@@ -9,7 +9,7 @@ the audio subsystem with the kernel as a platform device and is represented by
9the following struct:- 9the following struct:-
10 10
11/* SoC machine */ 11/* SoC machine */
12struct snd_soc_machine { 12struct snd_soc_card {
13 char *name; 13 char *name;
14 14
15 int (*probe)(struct platform_device *pdev); 15 int (*probe)(struct platform_device *pdev);
@@ -67,10 +67,10 @@ static struct snd_soc_dai_link corgi_dai = {
67 .ops = &corgi_ops, 67 .ops = &corgi_ops,
68}; 68};
69 69
70struct snd_soc_machine then sets up the machine with it's DAIs. e.g. 70struct snd_soc_card then sets up the machine with it's DAIs. e.g.
71 71
72/* corgi audio machine driver */ 72/* corgi audio machine driver */
73static struct snd_soc_machine snd_soc_machine_corgi = { 73static struct snd_soc_card snd_soc_corgi = {
74 .name = "Corgi", 74 .name = "Corgi",
75 .dai_link = &corgi_dai, 75 .dai_link = &corgi_dai,
76 .num_links = 1, 76 .num_links = 1,
@@ -90,7 +90,7 @@ static struct wm8731_setup_data corgi_wm8731_setup = {
90 90
91/* corgi audio subsystem */ 91/* corgi audio subsystem */
92static struct snd_soc_device corgi_snd_devdata = { 92static struct snd_soc_device corgi_snd_devdata = {
93 .machine = &snd_soc_machine_corgi, 93 .machine = &snd_soc_corgi,
94 .platform = &pxa2xx_soc_platform, 94 .platform = &pxa2xx_soc_platform,
95 .codec_dev = &soc_codec_dev_wm8731, 95 .codec_dev = &soc_codec_dev_wm8731,
96 .codec_data = &corgi_wm8731_setup, 96 .codec_data = &corgi_wm8731_setup,
generated by cgit v1.2.2 (git 2.25.0) at 2024-12-21 23:39:42 -0500