From: Cruz Julian Bishop <cruzjbishop@gmail.com>
To: greg@kroah.com
Cc: swetland@google.com, linux-kernel@vger.kernel.org,
Cruz Julian Bishop <cruzjbishop@gmail.com>
Subject: [PATCH 3/5] Finish documentation of two structs in android/logger.c
Date: Wed, 1 Aug 2012 14:54:18 +1000 [thread overview]
Message-ID: <1343796860-7025-4-git-send-email-cruzjbishop@gmail.com> (raw)
In-Reply-To: <1343796860-7025-1-git-send-email-cruzjbishop@gmail.com>
Signed-off-by: Cruz Julian Bishop <cruzjbishop@gmail.com>
---
drivers/staging/android/logger.c | 40 +++++++++++++++++++++++++-------------
1 file changed, 26 insertions(+), 14 deletions(-)
diff --git a/drivers/staging/android/logger.c b/drivers/staging/android/logger.c
index f7b8237..1d5ed47 100644
--- a/drivers/staging/android/logger.c
+++ b/drivers/staging/android/logger.c
@@ -32,38 +32,50 @@
#include <asm/ioctls.h>
-/*
+/**
* struct logger_log - represents a specific log, such as 'main' or 'radio'
+ * @buffer: The actual ring buffer
+ * @misc: The "misc" device representing the log
+ * @wq: The wait queue for @readers
+ * @readers: This log's readers
+ * @mutex: The mutex that protects the @buffer
+ * @w_off: The current write head offset
+ * @head: The head, or location that readers start reading at.
+ * @size: The size of the log
+ * @logs: The list of log channels
*
* This structure lives from module insertion until module removal, so it does
* not need additional reference counting. The structure is protected by the
* mutex 'mutex'.
*/
struct logger_log {
- unsigned char *buffer;/* the ring buffer itself */
- struct miscdevice misc; /* misc device representing the log */
- wait_queue_head_t wq; /* wait queue for readers */
- struct list_head readers; /* this log's readers */
- struct mutex mutex; /* mutex protecting buffer */
- size_t w_off; /* current write head offset */
- size_t head; /* new readers start here */
- size_t size; /* size of the log */
- struct list_head logs; /* list of log channels (myself)*/
+ unsigned char *buffer;
+ struct miscdevice misc;
+ wait_queue_head_t wq;
+ struct list_head readers;
+ struct mutex mutex;
+ size_t w_off;
+ size_t head;
+ size_t size;
+ struct list_head logs;
};
static LIST_HEAD(log_list);
-/*
+/**
* struct logger_reader - a logging device open for reading
+ * @log: The associated log
+ * @list: The associated entry in @logger_log's list
+ * @r_off: The current read head offset.
*
* This object lives from open to release, so we don't need additional
* reference counting. The structure is protected by log->mutex.
*/
struct logger_reader {
- struct logger_log *log; /* associated log */
- struct list_head list; /* entry in logger_log's list */
- size_t r_off; /* current read head offset */
+ struct logger_log *log;
+ struct list_head list;
+ size_t r_off;
};
/* logger_offset - returns index 'n' into the log via (optimized) modulus */
--
1.7.9.5
next prev parent reply other threads:[~2012-08-01 4:55 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-08-01 4:54 [PATCH 0/5] Android: Small documentation changes and a bug fix Cruz Julian Bishop
2012-08-01 4:54 ` [PATCH 1/5] Fix comment/license formatting in android/ashmem.c Cruz Julian Bishop
2012-08-01 4:54 ` [PATCH 2/5] Complete documentation of logger_entry in android/logger.h Cruz Julian Bishop
2012-08-01 4:54 ` Cruz Julian Bishop [this message]
2012-08-01 4:54 ` [PATCH 4/5] Redocument some functions in android/logger.c Cruz Julian Bishop
2012-08-14 2:00 ` Greg KH
2012-08-01 4:54 ` [PATCH 5/5] Fixes a potential bug " Cruz Julian Bishop
2012-08-01 23:50 ` Ryan Mallon
2012-08-14 2:01 ` Greg KH
2012-08-14 4:08 ` Cruz Julian Bishop
2012-08-01 5:18 ` [PATCH 0/5] Android: Small documentation changes and a bug fix Cruz Julian Bishop
2012-08-14 2:02 ` Greg KH
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1343796860-7025-4-git-send-email-cruzjbishop@gmail.com \
--to=cruzjbishop@gmail.com \
--cc=greg@kroah.com \
--cc=linux-kernel@vger.kernel.org \
--cc=swetland@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).