xref: /openbmc/linux/fs/ntfs/Kconfig (revision c900529f3d9161bfde5cca0754f83b4d3c3e0220)
1ec8f24b7SThomas Gleixner# SPDX-License-Identifier: GPL-2.0-only
29d73ac9eSAlexey Dobriyanconfig NTFS_FS
39d73ac9eSAlexey Dobriyan	tristate "NTFS file system support"
4*925c86a1SChristoph Hellwig	select BUFFER_HEAD
59d73ac9eSAlexey Dobriyan	select NLS
69d73ac9eSAlexey Dobriyan	help
79d73ac9eSAlexey Dobriyan	  NTFS is the file system of Microsoft Windows NT, 2000, XP and 2003.
89d73ac9eSAlexey Dobriyan
99d73ac9eSAlexey Dobriyan	  Saying Y or M here enables read support.  There is partial, but
109d73ac9eSAlexey Dobriyan	  safe, write support available.  For write support you must also
119d73ac9eSAlexey Dobriyan	  say Y to "NTFS write support" below.
129d73ac9eSAlexey Dobriyan
139d73ac9eSAlexey Dobriyan	  There are also a number of user-space tools available, called
149d73ac9eSAlexey Dobriyan	  ntfsprogs.  These include ntfsundelete and ntfsresize, that work
159d73ac9eSAlexey Dobriyan	  without NTFS support enabled in the kernel.
169d73ac9eSAlexey Dobriyan
179d73ac9eSAlexey Dobriyan	  This is a rewrite from scratch of Linux NTFS support and replaced
189d73ac9eSAlexey Dobriyan	  the old NTFS code starting with Linux 2.5.11.  A backport to
199d73ac9eSAlexey Dobriyan	  the Linux 2.4 kernel series is separately available as a patch
209d73ac9eSAlexey Dobriyan	  from the project web site.
219d73ac9eSAlexey Dobriyan
220c1bc6b8SMauro Carvalho Chehab	  For more information see <file:Documentation/filesystems/ntfs.rst>
239d73ac9eSAlexey Dobriyan	  and <http://www.linux-ntfs.org/>.
249d73ac9eSAlexey Dobriyan
259d73ac9eSAlexey Dobriyan	  To compile this file system support as a module, choose M here: the
269d73ac9eSAlexey Dobriyan	  module will be called ntfs.
279d73ac9eSAlexey Dobriyan
289d73ac9eSAlexey Dobriyan	  If you are not using Windows NT, 2000, XP or 2003 in addition to
299d73ac9eSAlexey Dobriyan	  Linux on your computer it is safe to say N.
309d73ac9eSAlexey Dobriyan
319d73ac9eSAlexey Dobriyanconfig NTFS_DEBUG
329d73ac9eSAlexey Dobriyan	bool "NTFS debugging support"
339d73ac9eSAlexey Dobriyan	depends on NTFS_FS
349d73ac9eSAlexey Dobriyan	help
359d73ac9eSAlexey Dobriyan	  If you are experiencing any problems with the NTFS file system, say
369d73ac9eSAlexey Dobriyan	  Y here.  This will result in additional consistency checks to be
379d73ac9eSAlexey Dobriyan	  performed by the driver as well as additional debugging messages to
389d73ac9eSAlexey Dobriyan	  be written to the system log.  Note that debugging messages are
399d73ac9eSAlexey Dobriyan	  disabled by default.  To enable them, supply the option debug_msgs=1
409d73ac9eSAlexey Dobriyan	  at the kernel command line when booting the kernel or as an option
419d73ac9eSAlexey Dobriyan	  to insmod when loading the ntfs module.  Once the driver is active,
429d73ac9eSAlexey Dobriyan	  you can enable debugging messages by doing (as root):
439d73ac9eSAlexey Dobriyan	  echo 1 > /proc/sys/fs/ntfs-debug
449d73ac9eSAlexey Dobriyan	  Replacing the "1" with "0" would disable debug messages.
459d73ac9eSAlexey Dobriyan
469d73ac9eSAlexey Dobriyan	  If you leave debugging messages disabled, this results in little
479d73ac9eSAlexey Dobriyan	  overhead, but enabling debug messages results in very significant
489d73ac9eSAlexey Dobriyan	  slowdown of the system.
499d73ac9eSAlexey Dobriyan
509d73ac9eSAlexey Dobriyan	  When reporting bugs, please try to have available a full dump of
519d73ac9eSAlexey Dobriyan	  debugging messages while the misbehaviour was occurring.
529d73ac9eSAlexey Dobriyan
539d73ac9eSAlexey Dobriyanconfig NTFS_RW
549d73ac9eSAlexey Dobriyan	bool "NTFS write support"
559d73ac9eSAlexey Dobriyan	depends on NTFS_FS
564eec7fafSGuenter Roeck	depends on PAGE_SIZE_LESS_THAN_64KB
579d73ac9eSAlexey Dobriyan	help
589d73ac9eSAlexey Dobriyan	  This enables the partial, but safe, write support in the NTFS driver.
599d73ac9eSAlexey Dobriyan
609d73ac9eSAlexey Dobriyan	  The only supported operation is overwriting existing files, without
619d73ac9eSAlexey Dobriyan	  changing the file length.  No file or directory creation, deletion or
629d73ac9eSAlexey Dobriyan	  renaming is possible.  Note only non-resident files can be written to
639d73ac9eSAlexey Dobriyan	  so you may find that some very small files (<500 bytes or so) cannot
649d73ac9eSAlexey Dobriyan	  be written to.
659d73ac9eSAlexey Dobriyan
669d73ac9eSAlexey Dobriyan	  While we cannot guarantee that it will not damage any data, we have
679d73ac9eSAlexey Dobriyan	  so far not received a single report where the driver would have
689d73ac9eSAlexey Dobriyan	  damaged someones data so we assume it is perfectly safe to use.
699d73ac9eSAlexey Dobriyan
709d73ac9eSAlexey Dobriyan	  Note:  While write support is safe in this version (a rewrite from
719d73ac9eSAlexey Dobriyan	  scratch of the NTFS support), it should be noted that the old NTFS
729d73ac9eSAlexey Dobriyan	  write support, included in Linux 2.5.10 and before (since 1997),
739d73ac9eSAlexey Dobriyan	  is not safe.
749d73ac9eSAlexey Dobriyan
759d73ac9eSAlexey Dobriyan	  This is currently useful with TopologiLinux.  TopologiLinux is run
769d73ac9eSAlexey Dobriyan	  on top of any DOS/Microsoft Windows system without partitioning your
779d73ac9eSAlexey Dobriyan	  hard disk.  Unlike other Linux distributions TopologiLinux does not
789d73ac9eSAlexey Dobriyan	  need its own partition.  For more information see
799d73ac9eSAlexey Dobriyan	  <http://topologi-linux.sourceforge.net/>
809d73ac9eSAlexey Dobriyan
819d73ac9eSAlexey Dobriyan	  It is perfectly safe to say N here.
82