share/man/man5/linsysfs.5

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