share/man/man5/linsysfs.5

   1 .\" Written by Garrett Wollman
   2 .\" This file is in the public domain.
   3 .\"
   4 .Dd November 13, 2019
   5 .Dt LINSYSFS 5
   6 .Os
   7 .Sh NAME
   8 .Nm linsysfs
   9 .Nd Linux kernel objects file system
  10 .Sh SYNOPSIS
  11 .Bd -literal
  12 linsys          /compat/linux/sys       linsysfs        rw 0 0
  13 .Ed
  14 .Sh DESCRIPTION
  15 The
  16 .Tn Linux
  17 system file system, or
  18 .Nm ,
  19 emulates a subset of the
  20 .Tn Linux
  21 sys file system and is required for
  22 the complete operation of some
  23 .Tn Linux
  24 binaries.
  25 .Pp
  26 The
  27 .Nm
  28 provides a two-level view of devices.
  29 At the highest level, PCI devices themselves are named, according to
  30 their bus, slot and function in the system hierarchy.
  31 PCI storage devices are listed in the
  32 .Pa scsi_host
  33 class with a device symlink
  34 to the PCI directories of the devices.
  35 .Pp
  36 Each device node is a directory containing some files and directories:
  37 .Bl -tag -width ".Pa status"
  38 .It Pa host
  39 A place holder for storage host information.
  40 .It Pa pci_id
  41 A directory for the
  42 .Pa pci_id
  43 that contains either the device information or another directory structure
  44 for a PCI bridge.
  45 .El
  46 .Pp
  47 Each host node of scsi_host is a directory containing some files and directories:
  48 .Bl -tag -width ".Pa proc_name"
  49 .It Pa proc_name
  50 The
  51 .Tn Linux
  52 registered driver name for these devices.
  53 .It Pa device
  54 A symlink to the PCI device directory.
  55 .El
  56 .Sh FILES
  57 .Bl -tag -width ".Pa /compat/linux/sys/devices/pci0000:00" -compact
  58 .It Pa /compat/linux/sys
  59 The normal mount point for
  60 .Nm .
  61 .It Pa /compat/linux/sys/class/scsi_host
  62 The storage host node.
  63 .It Pa /compat/linux/sys/devices/pci0000:00
  64 The PCI device hierarchy node.
  65 .El
  66 .Sh EXAMPLES
  67 The most common usage follows:
  68 .Pp
  69 .Dl "mount -t linsysfs linsys /compat/linux/sys"
  70 .Pp
  71 where
  72 .Pa /compat/linux/sys
  73 is a mount point.
  74 .Sh SEE ALSO
  75 .Xr nmount 2 ,
  76 .Xr unmount 2 ,
  77 .Xr linux 4 ,
  78 .Xr linprocfs 5 ,
  79 .Xr pseudofs 9
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 driver first appeared in
  84 .Fx 6.2 .
  85 .Sh AUTHORS
  86 .An -nosplit
  87 The
  88 .Nm
  89 driver was derived from
  90 .Nm linprocfs
  91 by
  92 .An Doug Ambrisko .
  93 This manual page was edited by
  94 .An Doug Ambrisko ,
  95 based on the
  96 .Xr linprocfs 5
  97 manual page by
  98 .An Garrett Wollman .