While working on the DMA pool concept in the TTM code I re-read
everything once more to make sure I was not missing anything. Whilst doing
that I found some spelling mistakes and some wording that could be improved
a bit. So fixed it up and please consider this patch for 3.1.
. and some comments to make it easier to understand.
Signed-off-by: Konrad Rzeszutek Wilk <[email protected]>
---
drivers/gpu/drm/ttm/ttm_page_alloc.c | 14 +++++++-------
include/drm/ttm/ttm_bo_api.h | 3 ---
include/drm/ttm/ttm_bo_driver.h | 6 +++---
include/drm/ttm/ttm_memory.h | 2 +-
include/drm/ttm/ttm_object.h | 4 ++--
include/drm/ttm/ttm_page_alloc.h | 2 +-
6 files changed, 14 insertions(+), 17 deletions(-)
diff --git a/drivers/gpu/drm/ttm/ttm_page_alloc.c b/drivers/gpu/drm/ttm/ttm_page_alloc.c
index 9d9d929..3277965 100644
--- a/drivers/gpu/drm/ttm/ttm_page_alloc.c
+++ b/drivers/gpu/drm/ttm/ttm_page_alloc.c
@@ -355,7 +355,7 @@ restart:
if (nr_free)
goto restart;
- /* Not allowed to fall tough or break because
+ /* Not allowed to fall through or break because
* following context is inside spinlock while we are
* outside here.
*/
@@ -554,7 +554,7 @@ out:
}
/**
- * Fill the given pool if there isn't enough pages and requested number of
+ * Fill the given pool if there isn't enough pages and the requested number of
* pages is small.
*/
static void ttm_page_pool_fill_locked(struct ttm_page_pool *pool,
@@ -575,7 +575,7 @@ static void ttm_page_pool_fill_locked(struct ttm_page_pool *pool,
pool->fill_lock = true;
/* If allocation request is small and there is not enough
- * pages in pool we fill the pool first */
+ * pages in a pool we fill the pool up first. */
if (count < _manager->options.small
&& count > pool->npages) {
struct list_head new_pages;
@@ -612,9 +612,9 @@ static void ttm_page_pool_fill_locked(struct ttm_page_pool *pool,
}
/**
- * Cut count nubmer of pages from the pool and put them to return list
+ * Cut out a number of pages from the pool and put them on the return list.
*
- * @return count of pages still to allocate to fill the request.
+ * @return count of pages still required to fulfill the request.
*/
static unsigned ttm_page_pool_get_pages(struct ttm_page_pool *pool,
struct list_head *pages, int ttm_flags,
@@ -635,7 +635,7 @@ static unsigned ttm_page_pool_get_pages(struct ttm_page_pool *pool,
goto out;
}
/* find the last pages to include for requested number of pages. Split
- * pool to begin and halves to reduce search space. */
+ * pool to begin and halve it to reduce search space. */
if (count <= pool->npages/2) {
i = 0;
list_for_each(p, &pool->list) {
@@ -649,7 +649,7 @@ static unsigned ttm_page_pool_get_pages(struct ttm_page_pool *pool,
break;
}
}
- /* Cut count number of pages from pool */
+ /* Cut the count number of pages from the pool */
list_cut_position(pages, &pool->list, p);
pool->npages -= count;
count = 0;
diff --git a/include/drm/ttm/ttm_bo_api.h b/include/drm/ttm/ttm_bo_api.h
index 62a0e4c..42e3469 100644
--- a/include/drm/ttm/ttm_bo_api.h
+++ b/include/drm/ttm/ttm_bo_api.h
@@ -662,9 +662,6 @@ extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
-#if 0
-#endif
-
/**
* ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
*
diff --git a/include/drm/ttm/ttm_bo_driver.h b/include/drm/ttm/ttm_bo_driver.h
index 09af2d7..94eb143 100644
--- a/include/drm/ttm/ttm_bo_driver.h
+++ b/include/drm/ttm/ttm_bo_driver.h
@@ -78,7 +78,7 @@ struct ttm_backend_func {
*
* Bind the backend pages into the aperture in the location
* indicated by @bo_mem. This function should be able to handle
- * differences between aperture- and system page sizes.
+ * differences between aperture and system page sizes.
*/
int (*bind) (struct ttm_backend *backend, struct ttm_mem_reg *bo_mem);
@@ -88,7 +88,7 @@ struct ttm_backend_func {
* @backend: Pointer to a struct ttm_backend.
*
* Unbind previously bound backend pages. This function should be
- * able to handle differences between aperture- and system page sizes.
+ * able to handle differences between aperture and system page sizes.
*/
int (*unbind) (struct ttm_backend *backend);
@@ -786,7 +786,7 @@ extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
* ttm_bo_device_init
*
* @bdev: A pointer to a struct ttm_bo_device to initialize.
- * @mem_global: A pointer to an initialized struct ttm_mem_global.
+ * @glob: A pointer to an initialized struct ttm_bo_global.
* @driver: A pointer to a struct ttm_bo_driver set up by the caller.
* @file_page_offset: Offset into the device address space that is available
* for buffer data. This ensures compatibility with other users of the
diff --git a/include/drm/ttm/ttm_memory.h b/include/drm/ttm/ttm_memory.h
index b199170..26c1f78 100644
--- a/include/drm/ttm/ttm_memory.h
+++ b/include/drm/ttm/ttm_memory.h
@@ -41,7 +41,7 @@
* @do_shrink: The callback function.
*
* Arguments to the do_shrink functions are intended to be passed using
- * inheritance. That is, the argument class derives from struct ttm_mem_srink,
+ * inheritance. That is, the argument class derives from struct ttm_mem_shrink,
* and can be accessed using container_of().
*/
diff --git a/include/drm/ttm/ttm_object.h b/include/drm/ttm/ttm_object.h
index 0d9db09..e46054e 100644
--- a/include/drm/ttm/ttm_object.h
+++ b/include/drm/ttm/ttm_object.h
@@ -111,7 +111,7 @@ struct ttm_object_device;
*
* @ref_obj_release: A function to be called when a reference object
* with another ttm_ref_type than TTM_REF_USAGE is deleted.
- * this function may, for example, release a lock held by a user-space
+ * This function may, for example, release a lock held by a user-space
* process.
*
* This struct is intended to be used as a base struct for objects that
@@ -172,7 +172,7 @@ extern struct ttm_base_object *ttm_base_object_lookup(struct ttm_object_file
/**
* ttm_base_object_unref
*
- * @p_base: Pointer to a pointer referncing a struct ttm_base_object.
+ * @p_base: Pointer to a pointer referencing a struct ttm_base_object.
*
* Decrements the base object refcount and clears the pointer pointed to by
* p_base.
diff --git a/include/drm/ttm/ttm_page_alloc.h b/include/drm/ttm/ttm_page_alloc.h
index 8062890..129de12 100644
--- a/include/drm/ttm/ttm_page_alloc.h
+++ b/include/drm/ttm/ttm_page_alloc.h
@@ -32,7 +32,7 @@
/**
* Get count number of pages from pool to pages list.
*
- * @pages: heado of empty linked list where pages are filled.
+ * @pages: head of empty linked list where pages are filled.
* @flags: ttm flags for page allocation.
* @cstate: ttm caching state for the page.
* @count: number of pages to allocate.
--
1.7.4.1
On Tue, 7 Jun 2011 14:35:52 -0400 Konrad Rzeszutek Wilk wrote:
> . and some comments to make it easier to understand.
>
> Signed-off-by: Konrad Rzeszutek Wilk <[email protected]>
> ---
> drivers/gpu/drm/ttm/ttm_page_alloc.c | 14 +++++++-------
> include/drm/ttm/ttm_bo_api.h | 3 ---
> include/drm/ttm/ttm_bo_driver.h | 6 +++---
> include/drm/ttm/ttm_memory.h | 2 +-
> include/drm/ttm/ttm_object.h | 4 ++--
> include/drm/ttm/ttm_page_alloc.h | 2 +-
> 6 files changed, 14 insertions(+), 17 deletions(-)
>
> diff --git a/drivers/gpu/drm/ttm/ttm_page_alloc.c b/drivers/gpu/drm/ttm/ttm_page_alloc.c
> index 9d9d929..3277965 100644
> --- a/drivers/gpu/drm/ttm/ttm_page_alloc.c
> +++ b/drivers/gpu/drm/ttm/ttm_page_alloc.c
> @@ -355,7 +355,7 @@ restart:
> if (nr_free)
> goto restart;
>
> - /* Not allowed to fall tough or break because
> + /* Not allowed to fall through or break because
> * following context is inside spinlock while we are
> * outside here.
> */
> @@ -554,7 +554,7 @@ out:
> }
>
> /**
> - * Fill the given pool if there isn't enough pages and requested number of
> + * Fill the given pool if there isn't enough pages and the requested number of
aren't
> * pages is small.
> */
> static void ttm_page_pool_fill_locked(struct ttm_page_pool *pool,
> @@ -575,7 +575,7 @@ static void ttm_page_pool_fill_locked(struct ttm_page_pool *pool,
> pool->fill_lock = true;
>
> /* If allocation request is small and there is not enough
are not enough
> - * pages in pool we fill the pool first */
> + * pages in a pool we fill the pool up first. */
> if (count < _manager->options.small
> && count > pool->npages) {
> struct list_head new_pages;
> @@ -612,9 +612,9 @@ static void ttm_page_pool_fill_locked(struct ttm_page_pool *pool,
> }
>
> /**
> - * Cut count nubmer of pages from the pool and put them to return list
> + * Cut out a number of pages from the pool and put them on the return list.
No, it wants 'count' or <count> in there, like:
* Cut 'count' number of pages from the pool and put them on the return list.
> *
> - * @return count of pages still to allocate to fill the request.
> + * @return count of pages still required to fulfill the request.
> */
> static unsigned ttm_page_pool_get_pages(struct ttm_page_pool *pool,
> struct list_head *pages, int ttm_flags,
> @@ -635,7 +635,7 @@ static unsigned ttm_page_pool_get_pages(struct ttm_page_pool *pool,
> goto out;
> }
> /* find the last pages to include for requested number of pages. Split
> - * pool to begin and halves to reduce search space. */
> + * pool to begin and halve it to reduce search space. */
> if (count <= pool->npages/2) {
> i = 0;
> list_for_each(p, &pool->list) {
> @@ -649,7 +649,7 @@ static unsigned ttm_page_pool_get_pages(struct ttm_page_pool *pool,
> break;
> }
> }
> - /* Cut count number of pages from pool */
> + /* Cut the count number of pages from the pool */
Not any better IMO. How about:
/* Cut <count> number of pages from the pool */
or
/* Cut 'count' number of pages from the pool */
> list_cut_position(pages, &pool->list, p);
> pool->npages -= count;
> count = 0;
[snip]
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***