xref: /OK3568_Linux_fs/kernel/Documentation/ABI/stable/sysfs-module (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunWhat:		/sys/module
2*4882a593SmuzhiyunDescription:
3*4882a593Smuzhiyun	The /sys/module tree consists of the following structure:
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun	/sys/module/MODULENAME
6*4882a593Smuzhiyun		The name of the module that is in the kernel.  This
7*4882a593Smuzhiyun		module name will always show up if the module is loaded as a
8*4882a593Smuzhiyun		dynamic module.  If it is built directly into the kernel, it
9*4882a593Smuzhiyun		will only show up if it has a version or at least one
10*4882a593Smuzhiyun		parameter.
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun		Note: The conditions of creation in the built-in case are not
13*4882a593Smuzhiyun		by design and may be removed in the future.
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun	/sys/module/MODULENAME/parameters
16*4882a593Smuzhiyun		This directory contains individual files that are each
17*4882a593Smuzhiyun		individual parameters of the module that are able to be
18*4882a593Smuzhiyun		changed at runtime.  See the individual module
19*4882a593Smuzhiyun		documentation as to the contents of these parameters and
20*4882a593Smuzhiyun		what they accomplish.
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun		Note: The individual parameter names and values are not
23*4882a593Smuzhiyun		considered stable, only the fact that they will be
24*4882a593Smuzhiyun		placed in this location within sysfs.  See the
25*4882a593Smuzhiyun		individual driver documentation for details as to the
26*4882a593Smuzhiyun		stability of the different parameters.
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun	/sys/module/MODULENAME/refcnt
29*4882a593Smuzhiyun		If the module is able to be unloaded from the kernel, this file
30*4882a593Smuzhiyun		will contain the current reference count of the module.
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun		Note: If the module is built into the kernel, or if the
33*4882a593Smuzhiyun		CONFIG_MODULE_UNLOAD kernel configuration value is not enabled,
34*4882a593Smuzhiyun		this file will not be present.
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunWhat:		/sys/module/MODULENAME/scmversion
37*4882a593SmuzhiyunDate:		November 2020
38*4882a593SmuzhiyunKernelVersion:	Android Common Kernel -- android12-5.10+
39*4882a593SmuzhiyunContact:	Will McVicker <willmcvicker@google.com>
40*4882a593SmuzhiyunDescription:	This read-only file will appear if modpost was supplied with an
41*4882a593Smuzhiyun		SCM version for the module. It can be enabled with the config
42*4882a593Smuzhiyun		MODULE_SCMVERSION. The SCM version is retrieved by
43*4882a593Smuzhiyun		scripts/setlocalversion, which means that the presence of this
44*4882a593Smuzhiyun		file depends on CONFIG_LOCALVERSION_AUTO=y. When read, the SCM
45*4882a593Smuzhiyun		version that the module was compiled with is returned. The SCM
46*4882a593Smuzhiyun		version is returned in the following format::
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun		===
49*4882a593Smuzhiyun		Git:		g[a-f0-9]\+(-dirty)\?
50*4882a593Smuzhiyun		Mercurial:	hg[a-f0-9]\+(-dirty)\?
51*4882a593Smuzhiyun		Subversion:	svn[0-9]\+
52*4882a593Smuzhiyun		===
53