@<<INCLUDE ../template/head.inc@!>>
@<<INCLUDE ../template/nav.inc@!>>
@<<DEF google="8963309302"@!>>
@<<DEF google-search="6039882207"@!>>
@<<DEF title=LKDDb database format@!>>
@<<ME /lkddb/format.html@!>>

<div class="title">
  <h1>LKDDb database format</h1>
  <h2>all about lkddb.list</h2>
</div>

<div class="main">

<script type="text/javascript"
  src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>


<h2>Latest changes</h2>

<dl>
  <dt>2007-11-22</dt>
    <dd>Total change of the format</dd>
  <dt>2007-10-31</dt>
    <dd>USB: hi and low bdc are now 4 digit hex-numbers
    (instead of decimal numbers)</dd>
</dl>


<h2>File format</h2>

<p><code>lkddb.list</code> file is an text file. Lines starting with
<code>#</code> are comments.  Other lines starts with <code>lkddb</code>.</p>

<p>The fields <em>detection</em>, <em>configuration</em> and
<em>source file</em> are separated by the <code>"\t:: "</code>
separator.</p>

<p>Subfields are separated by spaces or/and tabs (check the sources)</p>

<p>In the description of fields
we use the following (<code>printf</code>-like) convention:</p>
<dl>
  <dt><code>%</code><i>n</i><code>x</code></dt>
    <dd>an hexadecimal mask with <i>n</i> digits. The digit are always
      written lowercase.  A <code>.</code> means <em>any single digit</em>.
      </dd>
  <dt><code>%s</code></dt>
    <dd>a string.  Eventually the double quotes and the backslashes
      are quoted with an additional backslash</dd>
  <dt><code>%C</code></dt>
    <dd>a space separated list of kernel configuration items (CONFIG_). Every token
      start with CONFIG_</dd>
  <dt><code>%F</code></dt>
    <dd>a kernel filename. Paths are relative to the top kernel source directory</dd>
</dl>

<p>A standard line if formed by:</p>

<p><code>lkddb sub-sytem %nx... %s... :: %C :: %F</code></p>

<p>where the configuration list (%C) is the kernel configuration symbols that
need to be set (<code>m</code> or <code>y</code>) to activate kernel driver
relative to the probed hardware. The special <code>CONFIG__UNKNOW__</code>
symbol is used both for yet unknow symbol (error or unimplemented feature on
the scanner), or for the drivers that are always included in the kernel. The
kernel filename (%F) is the file that contain the hardware definition.</p>


<h2>Hardware data</h2>

<p>In this section we enumerate the probes of numbers
and strings provided directly by hardware. Usually these
detection are done on bus level and should be complete.</p>

<h3>pci</h3>

<p>Devices on the PCI buses.
Format:</p>

<p><code>lkddb pci %4x %4x %4x %4x %4x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>vendor</li>
  <li>device</li>
  <li>subvendor</li>
  <li>subdevice</li>
  <li>class-mask</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>
<p>Note: The <code>pci.ids</code> file from lspci package or from kernel translates the codes into real names.
An online version is in <a href="http://pciids.sourceforge.net/">The Linux PCI ID Repository</a></p>


<h3>usb</h3>

<p>Devices attached on the USB buses.
Format</p>

<p><code>lkddb usb %4x %4x %2x%2x%2x %2x%2x%2x %4x %4x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>idVendor</li>
  <li>idProduct</li>
  <li>bDeviceClass</li>
  <li>bDeviceSubClass</li>
  <li>bDeviceProtocol</li>
  <li>bInterfaceClass</li>
  <li>bInterfaceSubClass</li>
  <li>bInterfaceProtocol</li>
  <li>bcdDevice_lo</li>
  <li>bcdDevice_hi</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>
<p>The dots are used by detection for the <em>bcdDevice</em> fields,
but in database there is only the low and the hi limit of such
number.</p>
<p>Note: A list of USB ID with full name is available as
<a href="http://www.linux-usb.org/usb.ids">usb.ids</a> file
(which is part of usbutils).</p>


<h3>IEEE1394 (FireWire)</h3>

<p>devices attached on the IEEE1394 (FireWire) bus.
Format:</p>

<p><code>lkddb ieee1394 %6x %6x %6x %x6 :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>vendor_id</li>
  <li>model_id</li>
  <li>specifier_id</li>
  <li>version</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>s390 CCW</h3>

<p>devices on the s390 CCW bus.
Format:</p>

<p><code>lkddb ccw %4x %2x %4x %2x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>cu_type</li>
  <li>cu_model</li>
  <li>dev_type</li>
  <li>dev_model</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>s390 AP (adjunct processor)</h3>

<p>Devices which uses the Ajunct processor interface on s390.
Format:</p>

<p><code>lkddb ap %2x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>dev_type</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>ACPI</h3>

<p>ACPI devices. Format:</p>

<p><code>lkddb ap "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>id</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>PnP (ISA plug and play)</h3>

<p>>PnP (ISA plug and play) capable ISA devices. Format:</p>

<p><code>lkddb pnp "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>id</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<p><code>lkddb pnp_card "%s" "%s" "%s" "%s" "%s" "%s" "%s" "%s" "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>id</li>
  <li>devs 1</li>
  <li>devs 2</li>
  <li>devs 3</li>
  <li>devs 4</li>
  <li>devs 5</li>
  <li>devs 6</li>
  <li>devs 7</li>
  <li>devs 8</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>SERIO</h3>

<p>SERIO. Format:</p>

<p><code>lkddb serio %2x %2x %2x %2x :: %C : %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>type</li>
  <li>proto</li>
  <li>id</li>
  <li>extra</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>OF</h3>

<p>OF. Format:</p>

<p><code>lkddb of %s\t%s\t%s :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>name</li>
  <li>type</li>
  <li>compat</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>VIO</h3>

<p>VIO devices.
Format:</p>

<p><code>lkddb vio "%s" "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>name</li>
  <li>compat</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>PCMCIA (and CardBus)</h3>

<p>devices on the PCMCIA and (CardBus) buses.
Format:</p>

<p><code>lkddb pcmcia %4x %4x %2x %2x %2x "%s" "%s" "%s" "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>manf_id</li>
  <li>card_id</li>
  <li>func_id</li>
  <li>function</li>
  <li>device_no</li>
  <li>prod_id 1</li>
  <li>prod_id 2</li>
  <li>prod_id 3</li>
  <li>prod_id 4</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>input</h3>

<p>Input devices. Format:</p>

<p><code>lkddb input %4x %4x %4x %4x %s %s %s %s %s %s %s %s %s :: %C:: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>bustype</li>
  <li>vendor</li>
  <li>product</li>
  <li>version</li>
  <li>evbit</li>
  <li>keybit</li>
  <li>relbit</li>
  <li>absbit</li>
  <li>mscbit</li>
  <li>ledbit</li>
  <li>sndbit</li>
  <li>ffbit</li>
  <li>swbit</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>EISA (Extended Industry Standard Architecture)</h3>

<p>EISA (Extended Industry Standard Architecture) devices (on ISA buses). Format:</p>

<p><code>lkddb eisa "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>sig</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>parisc</h3>

<p>parisc devices. Format:</p>

<p><code>lkddb parisc %2x %2x %4x %8x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>hw_type</li>
  <li>hversion_rev</li>
  <li>hversion</li>
  <li>sversion</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>SDIO</h3>

<p>SDIO devices. Format:</p>

<p><code>lkddb sdio %2x %4x %4x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>class</li>
  <li>vendor</li>
  <li>device</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>SBB (Sonics Silicon Backplane)</h3>

<p>Devices on the SBB (Sonics Silicon Backplane) buses.
SSB is an SoC bus used in a number of embedded devices.
Format:</p>

<p><code>lkddb sbb %4x %4x %2x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>vendor</li>
  <li>coreid</li>
  <li>revision</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>virtio</h3>

<p>devices with use the virtio (virtual I/O) layer. Format:</p>

<p><code>lkddb virtio %8x %8x :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>device</li>
  <li>vendor</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h3>TC (TURBOchannel)</h3>

<p>Devices on TurboChannel.  TurboChannel is a DEC (now Compaq (now HP)) bus
for Alpha and MIPS processors.
Format:</p>

<p><code>lkddb tc "%s" "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>vendor</li>
  <li>name</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>


<h2>kernel strings</h2>

<p>This section enumerate the probes about kernel provided strings,
In principle they could change depending on kernel version.</p>


<h3>I2C driver name</h3>

<p>I2C driver name. Format:</p>

<p><code>lkddb i2c "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>kernel driver name</li>
  <li>configuration list</li>
 <li>filename of the driver</li>
</ul>


<h3>"platform" driver name</h3>

<p>platform driver name. Format:</p>

<p><code>lkddb platform "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>kernel driver name</li>
  <li>configuration list</li>
 <li>filename of the driver</li>
</ul>


<h3>FS (file systems)</h3>

<p>File systems. Format:</p>

<p><code>lkddb fs "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>name</li>
  <li>configuration list</li>
  <li>filename of the driver</li>
</ul>
<p>Note: the <em>name</em> is the name as seen from kernel view</p>


<h3>module (kernel modules)</h3>

<p>Linux kernel modules names. Format:</p>

<p><code>lkddb module %s "%s" :: %C :: %F</code></p>

<p>where the fields are (left to right):</p>
<ul>
  <li>module name</li>
  <li>module description</li>
  <li>module configuration</li>
  <li>filename of the Kconfig file where the configuration is defined</li>
</ul>
<p>Note: the <em>name</em> is the name as seen from kernel view,
and <em>description</em> could have a quoted (with backslash) doublequote</p>

</div>
@<<INCLUDE ../template/foot.inc@>>