diff options
| author | Randy Dunlap <rdunlap@xenotime.net> | 2006-10-03 01:13:50 -0700 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-10-03 08:03:41 -0700 |
| commit | eed34d0fc5e4b89269053ed855ef714edbcf4518 (patch) | |
| tree | 62b8756937231eb28dea460cf8a0276fb56dc2eb | |
| parent | d3717bdf8f08a0e1039158c8bab2c24d20f492b6 (diff) | |
| download | lwn-eed34d0fc5e4b89269053ed855ef714edbcf4518.tar.gz lwn-eed34d0fc5e4b89269053ed855ef714edbcf4518.zip | |
[PATCH] kernel-doc for kernel/dma.c
Add kernel-doc function headers in kernel/dma.c and use it in DocBook.
Clean up kernel-doc in mca_dma.h (the colon (':') represents a
section header).
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
| -rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 4 | ||||
| -rw-r--r-- | include/asm-i386/mca_dma.h | 3 | ||||
| -rw-r--r-- | kernel/dma.c | 10 |
3 files changed, 14 insertions, 3 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index 6d4b1ef5b6f1..83b601b963c5 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl @@ -325,6 +325,10 @@ X!Ekernel/module.c !Ekernel/irq/manage.c </sect1> + <sect1><title>DMA Channels</title> +!Ekernel/dma.c + </sect1> + <sect1><title>Resources Management</title> !Ikernel/resource.c </sect1> diff --git a/include/asm-i386/mca_dma.h b/include/asm-i386/mca_dma.h index 4b3b526c5a3f..fbb1f3b71279 100644 --- a/include/asm-i386/mca_dma.h +++ b/include/asm-i386/mca_dma.h @@ -181,7 +181,7 @@ static __inline__ void mca_set_dma_io(unsigned int dmanr, unsigned int io_addr) * @mode: mode to set * * The DMA controller supports several modes. The mode values you can - * set are : + * set are- * * %MCA_DMA_MODE_READ when reading from the DMA device. * @@ -190,7 +190,6 @@ static __inline__ void mca_set_dma_io(unsigned int dmanr, unsigned int io_addr) * %MCA_DMA_MODE_IO to do DMA to or from an I/O port. * * %MCA_DMA_MODE_16 to do 16bit transfers. - * */ static __inline__ void mca_set_dma_mode(unsigned int dmanr, unsigned int mode) diff --git a/kernel/dma.c b/kernel/dma.c index aef0a45b7893..2020644c938a 100644 --- a/kernel/dma.c +++ b/kernel/dma.c @@ -62,6 +62,11 @@ static struct dma_chan dma_chan_busy[MAX_DMA_CHANNELS] = { }; +/** + * request_dma - request and reserve a system DMA channel + * @dmanr: DMA channel number + * @device_id: reserving device ID string, used in /proc/dma + */ int request_dma(unsigned int dmanr, const char * device_id) { if (dmanr >= MAX_DMA_CHANNELS) @@ -76,7 +81,10 @@ int request_dma(unsigned int dmanr, const char * device_id) return 0; } /* request_dma */ - +/** + * free_dma - free a reserved system DMA channel + * @dmanr: DMA channel number + */ void free_dma(unsigned int dmanr) { if (dmanr >= MAX_DMA_CHANNELS) { |