[mirror_ubuntu-bionic-kernel.git] / Documentation / ABI / stable / sysfs-module

What:		/sys/module
Description:
	The /sys/module tree consists of the following structure:

	/sys/module/MODULENAME
		The name of the module that is in the kernel.  This
		module name will always show up if the module is loaded as a
		dynamic module.  If it is built directly into the kernel, it
		will only show up if it has a version or at least one
		parameter.

		Note: The conditions of creation in the built-in case are not
		by design and may be removed in the future.

	/sys/module/MODULENAME/parameters
		This directory contains individual files that are each
		individual parameters of the module that are able to be
		changed at runtime.  See the individual module
		documentation as to the contents of these parameters and
		what they accomplish.

		Note: The individual parameter names and values are not
		considered stable, only the fact that they will be
		placed in this location within sysfs.  See the
		individual driver documentation for details as to the
		stability of the different parameters.

	/sys/module/MODULENAME/refcnt
		If the module is able to be unloaded from the kernel, this file
		will contain the current reference count of the module.

		Note: If the module is built into the kernel, or if the
		CONFIG_MODULE_UNLOAD kernel configuration value is not enabled,
		this file will not be present.
Commit	Line	Data
c18f6365 GKH	1	What: /sys/module
	2	Description:
	3	The /sys/module tree consists of the following structure:
	4
	5	/sys/module/MODULENAME
	6	The name of the module that is in the kernel. This
86f12003 JD	7	module name will always show up if the module is loaded as a
	8	dynamic module. If it is built directly into the kernel, it
	9	will only show up if it has a version or at least one
	10	parameter.
	11
	12	Note: The conditions of creation in the built-in case are not
	13	by design and may be removed in the future.
c18f6365 GKH	14
	15	/sys/module/MODULENAME/parameters
	16	This directory contains individual files that are each
	17	individual parameters of the module that are able to be
	18	changed at runtime. See the individual module
	19	documentation as to the contents of these parameters and
	20	what they accomplish.
	21
	22	Note: The individual parameter names and values are not
	23	considered stable, only the fact that they will be
	24	placed in this location within sysfs. See the
	25	individual driver documentation for details as to the
	26	stability of the different parameters.
	27
	28	/sys/module/MODULENAME/refcnt
	29	If the module is able to be unloaded from the kernel, this file
	30	will contain the current reference count of the module.
	31
	32	Note: If the module is built into the kernel, or if the
	33	CONFIG_MODULE_UNLOAD kernel configuration value is not enabled,
	34	this file will not be present.