All of lore.kernel.org
 help / color / mirror / Atom feed
From: Minchan Kim <minchan@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Seth Jennings <sjenning@linux.vnet.ibm.com>,
	Nitin Gupta <ngupta@vflare.org>,
	Dan Magenheimer <dan.magenheimer@oracle.com>,
	Andrew Morton <akpm@linux-foundation.org>
Cc: linux-kernel@vger.kernel.org, linux-mm@kvack.org,
	Minchan Kim <minchan@kernel.org>
Subject: [PATCH 4/6] zsmalloc: add/fix function comment
Date: Wed, 25 Apr 2012 15:23:12 +0900	[thread overview]
Message-ID: <1335334994-22138-5-git-send-email-minchan@kernel.org> (raw)
In-Reply-To: <1335334994-22138-1-git-send-email-minchan@kernel.org>

Add/fix the comment.

Signed-off-by: Minchan Kim <minchan@kernel.org>
---
 drivers/staging/zsmalloc/zsmalloc-main.c |   15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/drivers/staging/zsmalloc/zsmalloc-main.c b/drivers/staging/zsmalloc/zsmalloc-main.c
index 0fe4cbb..b7d31cc 100644
--- a/drivers/staging/zsmalloc/zsmalloc-main.c
+++ b/drivers/staging/zsmalloc/zsmalloc-main.c
@@ -565,12 +565,9 @@ EXPORT_SYMBOL_GPL(zs_destroy_pool);
  * zs_malloc - Allocate block of given size from pool.
  * @pool: pool to allocate from
  * @size: size of block to allocate
- * @page: page no. that holds the object
- * @offset: location of object within page
  *
  * On success, <page, offset> identifies block allocated
- * and 0 is returned. On failure, <page, offset> is set to
- * 0 and -ENOMEM is returned.
+ * and <page, offset> is returned. On failure, NULL is returned.
  *
  * Allocation requests with size > ZS_MAX_ALLOC_SIZE will fail.
  */
@@ -666,6 +663,16 @@ void zs_free(struct zs_pool *pool, void *obj)
 }
 EXPORT_SYMBOL_GPL(zs_free);
 
+/**
+ * zs_map_object - get address of allocated object from handle.
+ * @pool: object allocated pool
+ * @handle: handle returned from zs_malloc
+ *
+ * Before using object allocated from zs_malloc, object
+ * should be mapped to page table by this function.
+ * After using object,  call zs_unmap_object to unmap page
+ * table.
+ */
 void *zs_map_object(struct zs_pool *pool, void *handle)
 {
 	struct page *page;
-- 
1.7.9.5

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org.  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Fight unfair telecom internet charges in Canada: sign http://stopthemeter.ca/
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>

WARNING: multiple messages have this Message-ID (diff)
From: Minchan Kim <minchan@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Seth Jennings <sjenning@linux.vnet.ibm.com>,
	Nitin Gupta <ngupta@vflare.org>,
	Dan Magenheimer <dan.magenheimer@oracle.com>,
	Andrew Morton <akpm@linux-foundation.org>
Cc: linux-kernel@vger.kernel.org, linux-mm@kvack.org,
	Minchan Kim <minchan@kernel.org>
Subject: [PATCH 4/6] zsmalloc: add/fix function comment
Date: Wed, 25 Apr 2012 15:23:12 +0900	[thread overview]
Message-ID: <1335334994-22138-5-git-send-email-minchan@kernel.org> (raw)
In-Reply-To: <1335334994-22138-1-git-send-email-minchan@kernel.org>

Add/fix the comment.

Signed-off-by: Minchan Kim <minchan@kernel.org>
---
 drivers/staging/zsmalloc/zsmalloc-main.c |   15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/drivers/staging/zsmalloc/zsmalloc-main.c b/drivers/staging/zsmalloc/zsmalloc-main.c
index 0fe4cbb..b7d31cc 100644
--- a/drivers/staging/zsmalloc/zsmalloc-main.c
+++ b/drivers/staging/zsmalloc/zsmalloc-main.c
@@ -565,12 +565,9 @@ EXPORT_SYMBOL_GPL(zs_destroy_pool);
  * zs_malloc - Allocate block of given size from pool.
  * @pool: pool to allocate from
  * @size: size of block to allocate
- * @page: page no. that holds the object
- * @offset: location of object within page
  *
  * On success, <page, offset> identifies block allocated
- * and 0 is returned. On failure, <page, offset> is set to
- * 0 and -ENOMEM is returned.
+ * and <page, offset> is returned. On failure, NULL is returned.
  *
  * Allocation requests with size > ZS_MAX_ALLOC_SIZE will fail.
  */
@@ -666,6 +663,16 @@ void zs_free(struct zs_pool *pool, void *obj)
 }
 EXPORT_SYMBOL_GPL(zs_free);
 
+/**
+ * zs_map_object - get address of allocated object from handle.
+ * @pool: object allocated pool
+ * @handle: handle returned from zs_malloc
+ *
+ * Before using object allocated from zs_malloc, object
+ * should be mapped to page table by this function.
+ * After using object,  call zs_unmap_object to unmap page
+ * table.
+ */
 void *zs_map_object(struct zs_pool *pool, void *handle)
 {
 	struct page *page;
-- 
1.7.9.5


  parent reply	other threads:[~2012-04-25  6:22 UTC|newest]

Thread overview: 64+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-04-25  6:23 [PATCH 0/6] zsmalloc: clean up and fix arch dependency Minchan Kim
2012-04-25  6:23 ` Minchan Kim
2012-04-25  6:23 ` [PATCH 1/6] zsmalloc: use PageFlag macro instead of [set|test]_bit Minchan Kim
2012-04-25  6:23   ` Minchan Kim
2012-04-25 12:43   ` Nitin Gupta
2012-04-25 12:43     ` Nitin Gupta
2012-04-25  6:23 ` [PATCH 2/6] zsmalloc: remove unnecessary alignment Minchan Kim
2012-04-25  6:23   ` Minchan Kim
2012-04-25 12:53   ` Nitin Gupta
2012-04-25 12:53     ` Nitin Gupta
2012-04-26  1:42     ` Minchan Kim
2012-04-26  1:42       ` Minchan Kim
2012-05-03  5:16       ` Nitin Gupta
2012-05-03  5:16         ` Nitin Gupta
2012-04-25  6:23 ` [PATCH 3/6] zsmalloc: rename zspage_order with zspage_pages Minchan Kim
2012-04-25  6:23   ` Minchan Kim
2012-04-25 13:03   ` Nitin Gupta
2012-04-25 13:03     ` Nitin Gupta
2012-04-26  1:46     ` Minchan Kim
2012-04-26  1:46       ` Minchan Kim
2012-04-25  6:23 ` Minchan Kim [this message]
2012-04-25  6:23   ` [PATCH 4/6] zsmalloc: add/fix function comment Minchan Kim
2012-04-25 13:27   ` Nitin Gupta
2012-04-25 13:27     ` Nitin Gupta
2012-04-26  1:51     ` Minchan Kim
2012-04-26  1:51       ` Minchan Kim
2012-04-25  6:23 ` [PATCH 5/6] zsmalloc: remove unnecessary type casting Minchan Kim
2012-04-25  6:23   ` Minchan Kim
2012-04-25 13:35   ` Nitin Gupta
2012-04-25 13:35     ` Nitin Gupta
2012-04-25 17:56     ` Greg Kroah-Hartman
2012-04-25 17:56       ` Greg Kroah-Hartman
2012-04-25 18:13       ` Nitin Gupta
2012-04-25 18:13         ` Nitin Gupta
2012-04-26  1:58     ` Minchan Kim
2012-04-26  1:58       ` Minchan Kim
2012-04-25  6:23 ` [PATCH 6/6] zsmalloc: make zsmalloc portable Minchan Kim
2012-04-25  6:23   ` Minchan Kim
2012-04-25 14:32   ` Nitin Gupta
2012-04-25 14:32     ` Nitin Gupta
2012-04-25 15:40     ` Dan Magenheimer
2012-04-25 15:40       ` Dan Magenheimer
2012-04-26  2:03       ` Minchan Kim
2012-04-26  2:03         ` Minchan Kim
2012-04-26  5:07         ` Minchan Kim
2012-04-26  5:07           ` Minchan Kim
2012-04-30 16:24           ` Seth Jennings
2012-04-30 16:24             ` Seth Jennings
2012-04-25 16:37     ` Seth Jennings
2012-04-25 16:37       ` Seth Jennings
2012-04-26  2:04       ` Minchan Kim
2012-04-26  2:04         ` Minchan Kim
2012-05-07 15:14       ` Seth Jennings
2012-05-07 15:14         ` Seth Jennings
2012-05-08  0:46         ` Minchan Kim
2012-05-08  0:46           ` Minchan Kim
2012-04-26  2:11   ` Minchan Kim
2012-04-26  2:11     ` Minchan Kim
2012-04-25 12:41 ` [PATCH 0/6] zsmalloc: clean up and fix arch dependency Nitin Gupta
2012-04-25 12:41   ` Nitin Gupta
2012-04-26  1:20   ` Minchan Kim
2012-04-26  1:20     ` Minchan Kim
2012-04-25 18:14 ` Greg Kroah-Hartman
2012-04-25 18:14   ` Greg Kroah-Hartman

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=1335334994-22138-5-git-send-email-minchan@kernel.org \
    --to=minchan@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=dan.magenheimer@oracle.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=ngupta@vflare.org \
    --cc=sjenning@linux.vnet.ibm.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.