alsactl_init.xml

ALSA驱动的一些调试测试工具

<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article>
  <section>
    <title>alsactl init</title>
    <refentry>
      <refentryinfo>
        <title>alsactl init</title>
        <date>July 2008</date>
        <productname>alsactl</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>alsactl_init</refentrytitle>
        <manvolnum>7</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>alsactl init</refname>
        <refpurpose>alsa control management - initialization</refpurpose>
      </refnamediv>

      <refsect1><title>DESCRIPTION</title>
        <para>"alsactl init" provides soundcard specific initialization.</para>
      </refsect1>

      <refsect1><title>CONFIGURATION</title>
        <para>All "alsactl init" configuration files are placed in
        <filename>/usr/share/alsa/init/</filename> directory. The top level
        configuration file is <filename>/usr/share/alsa/init/00main</filename>.
	The default top-level file can be also specified using -i or
	--initfile parameter for the alsactl tool.
	Every file consists of a set of lines of text. All empty lines or
        lines beginning with '#' will be ignored.</para>

        <refsect2><title>Rules files</title>
          <para>The "alsactl init" rules are read from the files located
          in the <filename>/usr/share/alsa/init/*</filename>. The top
          level configuration file is <filename>/usr/share/alsa/init/00main</filename>.
          Every line in the rules file contains at least one key value pair.
          There are two kind of keys, match and assignment keys. If all match
          keys are matching against its value, the rule gets applied and the
          assign keys get the specified value assigned.</para>
          
          <para>A rule may consists of a list of one or more key value pairs
          separated by a comma. Each key has a distinct operation, depending
          on the used operator. Valid operators are:</para>
          <variablelist>
            <varlistentry>
              <term><option>==</option></term>
              <listitem>
                <para>Compare for equality.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>!=</option></term>
              <listitem>
                <para>Compare for non-equality.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>=</option></term>
              <listitem>
                <para>Assign a value to a key. Keys that represent a list,
                are reset and only this single value is assigned.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>+=</option></term>
              <listitem>
                <para>Add the value to a key that holds a list
                of entries.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>:=</option></term>
              <listitem>
                <para>Assign  a  value  to  a key finally; disallow any
                later changes, which may be used to prevent changes by
                any later rules.</para>
              </listitem>
            </varlistentry>
          </variablelist>

          <para>The following key names can be used to match against device
          properties:</para>
          <variablelist>
            <varlistentry>
              <term><option>CARDINDEX</option></term>
              <listitem>
                <para>Match the card index of the ALSA driver.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>CTL{<replaceable>attribute</replaceable>}</option></term>
              <listitem>
                <para>Set or test universal control attribute. Possible
		attributes:</para>
                <variablelist>
                  <varlistentry>
                    <term><option>numid</option></term>
                    <listitem>
                      <para>Numeric control identification.</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>iface</option>, <option>interface</option></term>
                    <listitem>
                      <para>Control interface name (CARD, HWEDEP, MIXER, PCM, RAWMIDI, TIMER, SEQUENCER)</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>subdev</option>, <option>subdevice</option></term>
                    <listitem>
                      <para>Subdevice number.</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>name</option></term>
                    <listitem>
                      <para>Control name</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>index</option></term>
                    <listitem>
                      <para>Control index</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>type</option></term>
                    <listitem>
                      <para>Control type (BOOLEAN, INTEGER, INTEGER64, ENUMERATED, BYTES, IEC958)</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>attr</option>, <option>attribute</option></term>
                    <listitem>
                      <para>Attributes (stored in a string - use match characters * and ?):</para>
	              <variablelist>
	                <varlistentry>
	                  <term><option>r</option></term>
	                  <listitem>
	                    <para>control is readable</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>w</option></term>
	                  <listitem>
	                    <para>control is writable</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>v</option></term>
	                  <listitem>
	                    <para>control is volatile</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>i</option></term>
	                  <listitem>
	                    <para>control is inactive</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>l</option></term>
	                  <listitem>
	                    <para>control is locked</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>R</option></term>
	                  <listitem>
	                    <para>control is TLV readable</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>W</option></term>
	                  <listitem>
	                    <para>control is TLV writable</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>C</option></term>
	                  <listitem>
	                    <para>control is TLV commandable</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>o</option></term>
	                  <listitem>
	                    <para>process is owner of this control</para>
	                  </listitem>
	                </varlistentry>
	                <varlistentry>
	                  <term><option>u</option></term>
	                  <listitem>
	                    <para>control created in user space</para>
	                  </listitem>
	                </varlistentry>
	              </variablelist>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>owner</option></term>
                    <listitem>
                      <para>Control owner process PID number</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>count</option></term>
                    <listitem>
                      <para>Control count of values</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>min</option></term>
                    <listitem>
                      <para>Value range - minimum value</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>max</option></term>
                    <listitem>
                      <para>Value range - maximum value</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>step</option></term>
                    <listitem>
                      <para>Value range - step value</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>dBmin</option></term>
                    <listitem>
                      <para>Value range - minimum dB value</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>dBmax</option></term>
                    <listitem>
                      <para>Value range - maximum dB value</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>items</option></term>
                    <listitem>
                      <para>Enumerated value - number of text items</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>enums</option></term>
                    <listitem>
                      <para>Enumerated value - list of text names stored between '|' character</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term><option>value</option></term>
                    <listitem>
                      <para>Value of control stored to a string delimited by
                      comma (,).</para>
                    </listitem>
                  </varlistentry>
                </variablelist>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>CONFIG{sysfs_device}</option></term>
              <listitem>
                <para>The relative path to sysfs subsystem specifying
                the root directory of a soundcard device. Usually,
                it should be set to "/class/sound/controlC$cardinfo{card}/device".
                </para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term><option>ATTR{<replaceable>filename</replaceable>}</option></term>
              <listitem>
                <para>Match sysfs attribute values of the soundcard device.
                The relative path to sysfs tree must be defined by
		CONFIG{sysfs_device} key. Trailing whitespace in the attribute
		values is ignored, if the specified match value does
		not contain trailing whitespace itself. Depending on
		the type of operator, this key is also used to set
		the value of a sysfs attribute.