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