summaryrefslogtreecommitdiffstats
path: root/fs/pstore
diff options
context:
space:
mode:
authorKees Cook <keescook@chromium.org>2018-11-01 15:11:47 -0700
committerKees Cook <keescook@chromium.org>2018-12-03 16:52:35 -0800
commitc208f7d4b037e1c71e5c839bb5dfcc3e0df19890 (patch)
tree61314678e6a015e0a28f13d4d74ee796afc81588 /fs/pstore
parentdc80b1ea4cbff1d72ce3d5edaaf1b6602fd7c780 (diff)
downloadlinux-c208f7d4b037e1c71e5c839bb5dfcc3e0df19890.tar.bz2
pstore/ram: Add kern-doc for struct persistent_ram_zone
The struct persistent_ram_zone wasn't well documented. This adds kern-doc for it. Signed-off-by: Kees Cook <keescook@chromium.org>
Diffstat (limited to 'fs/pstore')
-rw-r--r--fs/pstore/ram_core.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/fs/pstore/ram_core.c b/fs/pstore/ram_core.c
index 62830734deee..3e9e3ba4fb07 100644
--- a/fs/pstore/ram_core.c
+++ b/fs/pstore/ram_core.c
@@ -29,6 +29,16 @@
#include <linux/vmalloc.h>
#include <asm/page.h>
+/**
+ * struct persistent_ram_buffer - persistent circular RAM buffer
+ *
+ * @sig:
+ * signature to indicate header (PERSISTENT_RAM_SIG xor PRZ-type value)
+ * @start:
+ * offset into @data where the beginning of the stored bytes begin
+ * @size:
+ * number of valid bytes stored in @data
+ */
struct persistent_ram_buffer {
uint32_t sig;
atomic_t start;