[linux-2.6-block.git] / drivers / nvdimm / Kconfig

menuconfig LIBNVDIMM
	tristate "NVDIMM (Non-Volatile Memory Device) Support"
	depends on PHYS_ADDR_T_64BIT
	depends on BLK_DEV
	help
	  Generic support for non-volatile memory devices including
	  ACPI-6-NFIT defined resources.  On platforms that define an
	  NFIT, or otherwise can discover NVDIMM resources, a libnvdimm
	  bus is registered to advertise PMEM (persistent memory)
	  namespaces (/dev/pmemX) and BLK (sliding mmio window(s))
	  namespaces (/dev/ndblkX.Y). A PMEM namespace refers to a
	  memory resource that may span multiple DIMMs and support DAX
	  (see CONFIG_DAX).  A BLK namespace refers to an NVDIMM control
	  region which exposes an mmio register set for windowed access
	  mode to non-volatile memory.

if LIBNVDIMM

config BLK_DEV_PMEM
	tristate "PMEM: Persistent memory block device support"
	default LIBNVDIMM
	depends on HAS_IOMEM
	select ND_BTT if BTT
	select ND_PFN if NVDIMM_PFN
	help
	  Memory ranges for PMEM are described by either an NFIT
	  (NVDIMM Firmware Interface Table, see CONFIG_NFIT_ACPI), a
	  non-standard OEM-specific E820 memory type (type-12, see
	  CONFIG_X86_PMEM_LEGACY), or it is manually specified by the
	  'memmap=nn[KMG]!ss[KMG]' kernel command line (see
	  Documentation/kernel-parameters.txt).  This driver converts
	  these persistent memory ranges into block devices that are
	  capable of DAX (direct-access) file system mappings.  See
	  Documentation/nvdimm/nvdimm.txt for more details.

	  Say Y if you want to use an NVDIMM

config ND_BLK
	tristate "BLK: Block data window (aperture) device support"
	default LIBNVDIMM
	select ND_BTT if BTT
	help
	  Support NVDIMMs, or other devices, that implement a BLK-mode
	  access capability.  BLK-mode access uses memory-mapped-i/o
	  apertures to access persistent media.

	  Say Y if your platform firmware emits an ACPI.NFIT table
	  (CONFIG_ACPI_NFIT), or otherwise exposes BLK-mode
	  capabilities.

config ND_CLAIM
	bool

config ND_BTT
	tristate

config BTT
	bool "BTT: Block Translation Table (atomic sector updates)"
	default y if LIBNVDIMM
	select ND_CLAIM
	help
	  The Block Translation Table (BTT) provides atomic sector
	  update semantics for persistent memory devices, so that
	  applications that rely on sector writes not being torn (a
	  guarantee that typical disks provide) can continue to do so.
	  The BTT manifests itself as an alternate personality for an
	  NVDIMM namespace, i.e. a namespace can be in raw mode (pmemX,
	  ndblkX.Y, etc...), or 'sectored' mode, (pmemXs, ndblkX.Ys,
	  etc...).

	  Select Y if unsure

config ND_PFN
	tristate

config NVDIMM_PFN
	bool "PFN: Map persistent (device) memory"
	default LIBNVDIMM
	depends on ZONE_DEVICE
	select ND_CLAIM
	help
	  Map persistent memory, i.e. advertise it to the memory
	  management sub-system.  By default persistent memory does
	  not support direct I/O, RDMA, or any other usage that
	  requires a 'struct page' to mediate an I/O request.  This
	  driver allocates and initializes the infrastructure needed
	  to support those use cases.

	  Select Y if unsure

endif
Commit	Line	Data
18da2c9e	1	menuconfig LIBNVDIMM
b94d5230 DW	2	tristate "NVDIMM (Non-Volatile Memory Device) Support"
	3	depends on PHYS_ADDR_T_64BIT
	4	depends on BLK_DEV
	5	help
	6	Generic support for non-volatile memory devices including
	7	ACPI-6-NFIT defined resources. On platforms that define an
	8	NFIT, or otherwise can discover NVDIMM resources, a libnvdimm
	9	bus is registered to advertise PMEM (persistent memory)
	10	namespaces (/dev/pmemX) and BLK (sliding mmio window(s))
5212e11f VV	11	namespaces (/dev/ndblkX.Y). A PMEM namespace refers to a
	12	memory resource that may span multiple DIMMs and support DAX
	13	(see CONFIG_DAX). A BLK namespace refers to an NVDIMM control
	14	region which exposes an mmio register set for windowed access
	15	mode to non-volatile memory.
18da2c9e DW	16
	17	if LIBNVDIMM
	18
	19	config BLK_DEV_PMEM
	20	tristate "PMEM: Persistent memory block device support"
	21	default LIBNVDIMM
	22	depends on HAS_IOMEM
5212e11f	23	select ND_BTT if BTT
e1455744	24	select ND_PFN if NVDIMM_PFN
18da2c9e DW	25	help
	26	Memory ranges for PMEM are described by either an NFIT
	27	(NVDIMM Firmware Interface Table, see CONFIG_NFIT_ACPI), a
	28	non-standard OEM-specific E820 memory type (type-12, see
	29	CONFIG_X86_PMEM_LEGACY), or it is manually specified by the
	30	'memmap=nn[KMG]!ss[KMG]' kernel command line (see
	31	Documentation/kernel-parameters.txt). This driver converts
	32	these persistent memory ranges into block devices that are
	33	capable of DAX (direct-access) file system mappings. See
	34	Documentation/nvdimm/nvdimm.txt for more details.
	35
	36	Say Y if you want to use an NVDIMM
	37
047fc8a1 RZ	38	config ND_BLK
	39	tristate "BLK: Block data window (aperture) device support"
	40	default LIBNVDIMM
	41	select ND_BTT if BTT
	42	help
	43	Support NVDIMMs, or other devices, that implement a BLK-mode
	44	access capability. BLK-mode access uses memory-mapped-i/o
	45	apertures to access persistent media.
	46
	47	Say Y if your platform firmware emits an ACPI.NFIT table
	48	(CONFIG_ACPI_NFIT), or otherwise exposes BLK-mode
	49	capabilities.
	50
e1455744 DW	51	config ND_CLAIM
	52	bool
	53
5212e11f VV	54	config ND_BTT
	55	tristate
	56
8c2f7e86	57	config BTT
5212e11f VV	58	bool "BTT: Block Translation Table (atomic sector updates)"
5212e11f VV	59	default y if LIBNVDIMM
e1455744	60	select ND_CLAIM
5212e11f VV	61	help
	62	The Block Translation Table (BTT) provides atomic sector
	63	update semantics for persistent memory devices, so that
	64	applications that rely on sector writes not being torn (a
	65	guarantee that typical disks provide) can continue to do so.
	66	The BTT manifests itself as an alternate personality for an
	67	NVDIMM namespace, i.e. a namespace can be in raw mode (pmemX,
	68	ndblkX.Y, etc...), or 'sectored' mode, (pmemXs, ndblkX.Ys,
	69	etc...).
	70
	71	Select Y if unsure
8c2f7e86	72
e1455744 DW	73	config ND_PFN
	74	tristate
	75
	76	config NVDIMM_PFN
	77	bool "PFN: Map persistent (device) memory"
	78	default LIBNVDIMM
32ab0a3f	79	depends on ZONE_DEVICE
e1455744 DW	80	select ND_CLAIM
	81	help
	82	Map persistent memory, i.e. advertise it to the memory
	83	management sub-system. By default persistent memory does
	84	not support direct I/O, RDMA, or any other usage that
	85	requires a 'struct page' to mediate an I/O request. This
	86	driver allocates and initializes the infrastructure needed
	87	to support those use cases.
	88
	89	Select Y if unsure
	90
18da2c9e	91	endif