usr/src/cmd/hal/fdi/README

   1
   2 This file describe the layout of device information files in the hal
   3 source tree and their three different applications. It should serve as
   4 a brief guide for IHV's and third party open source projects on how to
   5 integrate with hal.
   6
   7 Said third parties need to name their files in a unique manner using
   8 the following format: <organization>-[<model>]-[<purpose>].fdi. As a
   9 device information file can be used to match several models the model
  10 field may be omitted (the <purpose> field may be useful if the <model>
  11 field is omitted). The filename of a device information file must
  12 contain only lowercase alphanumeric characters, the '-' and '_'
  13 characters, and not any whitespace.
  14
  15 Device information files are processed in the following order:
  16
  17 1. Preprobing
  18 -------------
  19
  20 Contains device information files that are used to handle exceptional
  21 conditions such as telling hal to ignore a device and all children
  22 (using info.ignore), run programs to upload firmware or configure
  23 the device in an otherwise non-standard way that is incompatible with
  24 probing routines in hal (using info.callouts.preprobing) [1].
  25
  26 These files are processed BEFORE the device have been been probed.
  27
  28 Subdirs are installed in $(sysconfdir)/hal/preprobe (e.g. /etc/hal/preprobe)
  29
  30   preprobe
  31   |-- 10osvendor    # From the hal tarball and/or supplied by the os vendor
  32   |                 # -> installs into /usr/share/hal/fdi/preprobe/10osvendor
  33   |-- 20thirdparty  # 3rd party projects and IHV's install here
  34   |                 # -> installs into /usr/share/hal/fdi/preprobe/20thirdparty
  35   `-- 30user        # Installed by the user/admin
  36                     # -> installs into /etc/hal/fdi/preprobe/
  37
  38 [1] : http://lists.freedesktop.org/archives/hal/2004-August/000858.html
  39
  40 2. Information
  41 --------------
  42
  43 Contains device information files that describe hardware such as what
  44 kind of media a card reader uses (compact flash, memorystick etc),
  45 what out-of-tree kernel drivers are needed, whether the device is a
  46 camera and not just a harddrive.
  47
  48 These files are processed AFTER the device have been probed but before
  49 any policy device information files.
  50
  51 Subdirs are installed in $(datadir)/hal/fdi (e.g. /usr/share/hal/fdi)
  52
  53   information
  54   |-- 10freedesktop # From the hal tarball
  55   |                 # -> installs into /usr/share/hal/fdi/information/10freedesktop
  56   |-- 20thirdparty  # 3rd party projects and IHV's install here
  57   |                 # -> installs into /usr/share/hal/fdi/information/20thirdparty
  58   `-- 30user        # Installed by the user/admin
  59                     # -> installs into /etc/hal/fdi/information
  60
  61
  62 3. Policy
  63 ---------
  64
  65 Contains device information files that describe policy for hardware
  66 such as what callouts and addons to run for a device.
  67
  68 These files are processed AFTER the device have been been probed and
  69 also AFTER the information device files have been processed
  70
  71 Subdirs are installed in $(sysconfdir)/hal/policy (e.g. /etc/hal/policy)
  72
  73   policy
  74   |-- 10osvendor    # From the hal tarball and/or supplied by the os vendor
  75   |                 # -> installs into /usr/share/hal/fdi/policy/10freedesktop
  76   |-- 20thirdparty  # 3rd party projects and IHV's install here
  77   |                 # -> installs into /usr/share/hal/fdi/policy/20thirdparty
  78   `-- 30user        # Installed by the user/admin
  79                     # -> installs into /etc/hal/fdi/policy
  80