kernel/linux
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/ synced 2026-11-13 07:31:07 +00:00
Code Issues Releases Packages Activity
linux/Documentation/filesystems/debugfs.txt

231 lines
9.5 KiB
Raw Permalink Normal View History

Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
debugfs: add mode, uid and gid options Cautious admins may want to restrict access to debugfs. Currently a manual chown/chmod e.g. in an init script is needed to achieve that. Distributions that want to make the mount options configurable need to add extra config files. By allowing to set the root inode's uid, gid and mode via mount options no such hacks are needed anymore. Instead configuration becomes straight forward via fstab. Signed-off-by: Ludwig Nussel <ludwig.nussel@suse.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2012-01-25 11:52:28 +01:00
debugfs: more tightly restrict default mount mode Since the debugfs is mostly only used by root, make the default mount mode 0700. Most system owners do not need a more permissive value, but they can choose to weaken the restrictions via their fstab. Signed-off-by: Kees Cook <keescook@chromium.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2012-08-27 13:32:15 -07:00
debugfs: add mode, uid and gid options Cautious admins may want to restrict access to debugfs. Currently a manual chown/chmod e.g. in an init script is needed to achieve that. Distributions that want to make the mount options configurable need to add extra config files. By allowing to set the root inode's uid, gid and mode via mount options no such hacks are needed anymore. Instead configuration becomes straight forward via fstab. Signed-off-by: Ludwig Nussel <ludwig.nussel@suse.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2012-01-25 11:52:28 +01:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
Documentation: Update filesystems/debugfs.txt This patch update the Documentation/filesystems/debugfs.txt file. The main work is to add the description of the following functions: debugfs_create_atomic_t debugfs_create_u32_array debugfs_create_devm_seqfile debugfs_create_file_size Signed-off-by: Wang Long <long.wanglong@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-07-16 06:31:16 +00:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
debugfs: add documentation for debugfs_create_x64 debugfs_create_x64() exists. Signed-off-by: Akinobu Mita <akinobu.mita@gmail.com> Cc: Greg Kroah-Hartman <gregkh@suse.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-07-09 14:01:17 +09:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
debugfs: Pass bool pointer to debugfs_create_bool() Its a bit odd that debugfs_create_bool() takes 'u32 *' as an argument, when all it needs is a boolean pointer. It would be better to update this API to make it accept 'bool *' instead, as that will make it more consistent and often more convenient. Over that bool takes just a byte. That required updates to all user sites as well, in the same commit updating the API. regmap core was also using debugfs_{read|write}_file_bool(), directly and variable types were updated for that to be bool as well. Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org> Acked-by: Mark Brown <broonie@kernel.org> Acked-by: Charles Keepax <ckeepax@opensource.wolfsonmicro.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2015-09-26 15:04:07 -07:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
Documentation: Update filesystems/debugfs.txt This patch update the Documentation/filesystems/debugfs.txt file. The main work is to add the description of the following functions: debugfs_create_atomic_t debugfs_create_u32_array debugfs_create_devm_seqfile debugfs_create_file_size Signed-off-by: Wang Long <long.wanglong@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-07-16 06:31:16 +00:00
debugfs: add tools to printk 32-bit registers Some debugfs file I deal with are mostly blocks of registers, i.e. lines of the form "<name> = 0x<value>". Some files are only registers, some include registers blocks among other material. This patch introduces data structures and functions to deal with both cases. I expect more users of this over time. Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Acked-by: Giancarlo Asnaghi <giancarlo.asnaghi@st.com> Cc: Felipe Balbi <balbi@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-11-18 14:50:21 +01:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
switch debugfs to umode_t Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2011-07-24 04:33:43 -04:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00
debugfs: add tools to printk 32-bit registers Some debugfs file I deal with are mostly blocks of registers, i.e. lines of the form "<name> = 0x<value>". Some files are only registers, some include registers blocks among other material. This patch introduces data structures and functions to deal with both cases. I expect more users of this over time. Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Acked-by: Giancarlo Asnaghi <giancarlo.asnaghi@st.com> Cc: Felipe Balbi <balbi@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-11-18 14:50:21 +01:00
debugfs-related mode_t whack-a-mole all of those should be umode_t... Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2012-03-20 06:00:24 -04:00
debugfs: add tools to printk 32-bit registers Some debugfs file I deal with are mostly blocks of registers, i.e. lines of the form "<name> = 0x<value>". Some files are only registers, some include registers blocks among other material. This patch introduces data structures and functions to deal with both cases. I expect more users of this over time. Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Acked-by: Giancarlo Asnaghi <giancarlo.asnaghi@st.com> Cc: Felipe Balbi <balbi@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-11-18 14:50:21 +01:00
debugfs: Have debugfs_print_regs32() return void The seq_printf() will soon just return void, and seq_has_overflowed() should be used instead to see if the seq can no longer accept input. As the return value of debugfs_print_regs32() has no users and the seq_file descriptor should be checked with seq_has_overflowed() instead of return values of functions, it is better to just have debugfs_print_regs32() also return void. Link: http://lkml.kernel.org/p/2634b19eb1c04a9d31148c1fe6f1f3819be95349.1412031505.git.joe@perches.com Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Joe Perches <joe@perches.com> [ original change only updated seq_printf() return, added return of void to debugfs_print_regs32() as well ] Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2014-09-29 16:08:26 -07:00
debugfs: add tools to printk 32-bit registers Some debugfs file I deal with are mostly blocks of registers, i.e. lines of the form "<name> = 0x<value>". Some files are only registers, some include registers blocks among other material. This patch introduces data structures and functions to deal with both cases. I expect more users of this over time. Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Acked-by: Giancarlo Asnaghi <giancarlo.asnaghi@st.com> Cc: Felipe Balbi <balbi@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-11-18 14:50:21 +01:00
Documentation: Update filesystems/debugfs.txt This patch update the Documentation/filesystems/debugfs.txt file. The main work is to add the description of the following functions: debugfs_create_atomic_t debugfs_create_u32_array debugfs_create_devm_seqfile debugfs_create_file_size Signed-off-by: Wang Long <long.wanglong@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-07-16 06:31:16 +00:00
debugfs: add tools to printk 32-bit registers Some debugfs file I deal with are mostly blocks of registers, i.e. lines of the form "<name> = 0x<value>". Some files are only registers, some include registers blocks among other material. This patch introduces data structures and functions to deal with both cases. I expect more users of this over time. Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Acked-by: Giancarlo Asnaghi <giancarlo.asnaghi@st.com> Cc: Felipe Balbi <balbi@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-11-18 14:50:21 +01:00
Document the debugfs API This is an updated document covering the internal API for the debugfs filesystem. Thanks to Shen Feng for suggesting that I put this text here and noting that the old LWN version was rather out of date. Acked-by: Greg Kroah-Hartman <gregkh@suse.de> Reported-by: Shen Feng <shen@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2009-06-04 16:35:25 -06:00