| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-Id: <20080729131757.16e721c5.randy.dunlap@oracle.com>
Date: Tue, 29 Jul 2008 13:17:57 -0700
From: Randy Dunlap <randy.dunlap@...cle.com>
To: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Cc: dbaryshkov@...il.com, jbarnes@...tuousgeek.org, mingo@...e.hu
Subject: Re: dma-coherent: add documentation to new interfaces
On Tue, 29 Jul 2008 03:01:07 GMT Linux Kernel Mailing List wrote:
> Gitweb: http://git.kernel.org/git/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=b6d4f7e3ef25beb8c658c97867d98883e69dc544
> Commit: b6d4f7e3ef25beb8c658c97867d98883e69dc544
> Parent: 8fa8b9fbab90c74139e8e868fe5b30b6a9f6be65
> Author: Dmitry Baryshkov <dbaryshkov@...il.com>
> AuthorDate: Sun Jul 20 15:01:10 2008 +0400
> Committer: Ingo Molnar <mingo@...e.hu>
> CommitDate: Sun Jul 20 21:22:00 2008 +0200
>
> dma-coherent: add documentation to new interfaces
Hi,
Please fix these to be proper kernel-doc notation, as described in
Documentation/kernel-doc-nano-HOWTO.txt ...
> Signed-off-by: Dmitry Baryshkov <dbaryshkov@...il.com>
> Cc: Jesse Barnes <jbarnes@...tuousgeek.org>
> Signed-off-by: Ingo Molnar <mingo@...e.hu>
> ---
> kernel/dma-coherent.c | 28 ++++++++++++++++++++++++++++
> 1 files changed, 28 insertions(+), 0 deletions(-)
>
> diff --git a/kernel/dma-coherent.c b/kernel/dma-coherent.c
> index 56dff5c..7517115 100644
> --- a/kernel/dma-coherent.c
> +++ b/kernel/dma-coherent.c
> @@ -92,6 +92,21 @@ void *dma_mark_declared_memory_occupied(struct device *dev,
> }
> EXPORT_SYMBOL(dma_mark_declared_memory_occupied);
>
> +/**
> + * Try to allocate memory from the per-device coherent area.
Missing function name -
> + *
> + * @dev: device from which we allocate memory
> + * @size: size of requested memory area
> + * @dma_handle: This will be filled with the correct dma handle
> + * @ret: This pointer will be filled with the virtual address
> + * to allocated area.
> + *
> + * This function should be only called from per-arch %dma_alloc_coherent()
> + * to support allocation from per-device coherent memory pools.
> + *
> + * Returns 0 if dma_alloc_coherent should continue with allocating from
> + * generic memory areas, or !0 if dma_alloc_coherent should return %ret.
'%' is a constant-value prefix in kernel-doc.
> + */
> int dma_alloc_from_coherent(struct device *dev, ssize_t size,
> dma_addr_t *dma_handle, void **ret)
> {
> @@ -111,6 +126,19 @@ int dma_alloc_from_coherent(struct device *dev, ssize_t size,
> return (mem != NULL);
> }
>
> +/**
> + * Try to free the memory allocated from per-device coherent memory pool.
Missing function name -
> + * @dev: device from which the memory was allocated
> + * @order: the order of pages allocated
> + * @vaddr: virtual address of allocated pages
> + *
> + * This checks whether the memory was allocated from the per-device
> + * coherent memory pool and if so, releases that memory.
> + *
> + * Returns 1 if we correctly released the memory, or 0 if
> + * %dma_release_coherent() should proceed with releasing memory from
Drop the '%'.
> + * generic pools.
> + */
> int dma_release_from_coherent(struct device *dev, int order, void *vaddr)
> {
> struct dma_coherent_mem *mem = dev ? dev->dma_mem : NULL;
> --
Thanks.
---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists