kernel-doc for kernel/dma.c
PATCH 1/1 kernel-doc for kernel/dma.c
From: Randy Dunlap <[email protected]>
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 <[email protected]>
--- Documentation/DocBook/kernel-api.tmpl | 4 ++++ include/asm-i386/mca_dma.h | 3 +-- kernel/dma.c | 10 +++++++++- 3 files changed, 14 insertions(+), 3 deletions(-)
include/asm-i386/mca_dma.h +1 -2
@@ -181,7 +181,7 @@ static __inline__ void mca_set_dma_io(un* @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(un* %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)
kernel/dma.c +9 -1
@@ -62,6 +62,11 @@ static struct dma_chan dma_chan_busy[MAX }; +/** +* 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, consreturn 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 ) {
Documentation/DocBook/kernel-api.tmpl +4 -0
@@ -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>
---