Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[ARM] 4876/1: i.MXC family: Clean up

From: Juergen Beisert <j.beisert@pengutronix.de>

Clean up current header files from doxygen style comments. There are
probably more such comments left, but we start with these.

Things happend since last review:
- needless blank lines removed (note by Russell King)
- re-format comments (note by Ross Wille)

Signed-off-by: Juergen Beisert <j.beisert@pengutronix.de>
Signed-off-by: Ross Wille <wille@freescale.com>
Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>

authored by

Robert Schwebel and committed by
Russell King
f304fc42 05dda977

+61 -161
+47 -77
include/asm-arm/arch-mxc/board-mx31ads.h
··· 11 11 #ifndef __ASM_ARCH_MXC_BOARD_MX31ADS_H__ 12 12 #define __ASM_ARCH_MXC_BOARD_MX31ADS_H__ 13 13 14 - /*! 15 - * @name PBC Controller parameters 16 - */ 17 - /*! @{ */ 18 - /*! 19 - * Base address of PBC controller 20 - */ 14 + /* Base address of PBC controller */ 21 15 #define PBC_BASE_ADDRESS IO_ADDRESS(CS4_BASE_ADDR) 22 16 /* Offsets for the PBC Controller register */ 23 - /*! 24 - * PBC Board status register offset 25 - */ 17 + 18 + /* PBC Board status register offset */ 26 19 #define PBC_BSTAT 0x000002 27 - /*! 28 - * PBC Board control register 1 set address. 29 - */ 20 + 21 + /* PBC Board control register 1 set address */ 30 22 #define PBC_BCTRL1_SET 0x000004 31 - /*! 32 - * PBC Board control register 1 clear address. 33 - */ 23 + 24 + /* PBC Board control register 1 clear address */ 34 25 #define PBC_BCTRL1_CLEAR 0x000006 35 - /*! 36 - * PBC Board control register 2 set address. 37 - */ 26 + 27 + /* PBC Board control register 2 set address */ 38 28 #define PBC_BCTRL2_SET 0x000008 39 - /*! 40 - * PBC Board control register 2 clear address. 41 - */ 29 + 30 + /* PBC Board control register 2 clear address */ 42 31 #define PBC_BCTRL2_CLEAR 0x00000A 43 - /*! 44 - * PBC Board control register 3 set address. 45 - */ 32 + 33 + /* PBC Board control register 3 set address */ 46 34 #define PBC_BCTRL3_SET 0x00000C 47 - /*! 48 - * PBC Board control register 3 clear address. 49 - */ 35 + 36 + /* PBC Board control register 3 clear address */ 50 37 #define PBC_BCTRL3_CLEAR 0x00000E 51 - /*! 52 - * PBC Board control register 4 set address. 53 - */ 38 + 39 + /* PBC Board control register 4 set address */ 54 40 #define PBC_BCTRL4_SET 0x000010 55 - /*! 56 - * PBC Board control register 4 clear address. 57 - */ 41 + 42 + /* PBC Board control register 4 clear address */ 58 43 #define PBC_BCTRL4_CLEAR 0x000012 59 - /*! 60 - * PBC Board status register 1. 61 - */ 44 + 45 + /* PBC Board status register 1 */ 62 46 #define PBC_BSTAT1 0x000014 63 - /*! 64 - * PBC Board interrupt status register. 65 - */ 47 + 48 + /* PBC Board interrupt status register */ 66 49 #define PBC_INTSTATUS 0x000016 67 - /*! 68 - * PBC Board interrupt current status register. 69 - */ 50 + 51 + /* PBC Board interrupt current status register */ 70 52 #define PBC_INTCURR_STATUS 0x000018 71 - /*! 72 - * PBC Interrupt mask register set address. 73 - */ 53 + 54 + /* PBC Interrupt mask register set address */ 74 55 #define PBC_INTMASK_SET 0x00001A 75 - /*! 76 - * PBC Interrupt mask register clear address. 77 - */ 56 + 57 + /* PBC Interrupt mask register clear address */ 78 58 #define PBC_INTMASK_CLEAR 0x00001C 79 59 80 - /*! 81 - * External UART A. 82 - */ 60 + /* External UART A */ 83 61 #define PBC_SC16C652_UARTA 0x010000 84 - /*! 85 - * External UART B. 86 - */ 62 + 63 + /* External UART B */ 87 64 #define PBC_SC16C652_UARTB 0x010010 88 - /*! 89 - * Ethernet Controller IO base address. 90 - */ 65 + 66 + /* Ethernet Controller IO base address */ 91 67 #define PBC_CS8900A_IOBASE 0x020000 92 - /*! 93 - * Ethernet Controller Memory base address. 94 - */ 68 + 69 + /* Ethernet Controller Memory base address */ 95 70 #define PBC_CS8900A_MEMBASE 0x021000 96 - /*! 97 - * Ethernet Controller DMA base address. 98 - */ 71 + 72 + /* Ethernet Controller DMA base address */ 99 73 #define PBC_CS8900A_DMABASE 0x022000 100 - /*! 101 - * External chip select 0. 102 - */ 74 + 75 + /* External chip select 0 */ 103 76 #define PBC_XCS0 0x040000 104 - /*! 105 - * LCD Display enable. 106 - */ 77 + 78 + /* LCD Display enable */ 107 79 #define PBC_LCD_EN_B 0x060000 108 - /*! 109 - * Code test debug enable. 110 - */ 80 + 81 + /* Code test debug enable */ 111 82 #define PBC_CODE_B 0x070000 112 - /*! 113 - * PSRAM memory select. 114 - */ 83 + 84 + /* PSRAM memory select */ 115 85 #define PBC_PSRAM_B 0x5000000 116 86 117 87 #define PBC_INTSTATUS_REG (PBC_INTSTATUS + PBC_BASE_ADDRESS) ··· 109 139 110 140 #define MXC_MAX_EXP_IO_LINES 16 111 141 112 - #endif /* __ASM_ARCH_MXC_BOARD_MX31ADS_H__ */ 142 + #endif /* __ASM_ARCH_MXC_BOARD_MX31ADS_H__ */
-7
include/asm-arm/arch-mxc/dma.h
··· 11 11 #ifndef __ASM_ARCH_MXC_DMA_H__ 12 12 #define __ASM_ARCH_MXC_DMA_H__ 13 13 14 - /*! 15 - * @file dma.h 16 - * @brief This file contains Unified DMA API for all MXC platforms. 17 - * The API is platform independent. 18 - * 19 - * @ingroup SDMA 20 - */ 21 14 #endif
+1 -7
include/asm-arm/arch-mxc/hardware.h
··· 8 8 * published by the Free Software Foundation. 9 9 */ 10 10 11 - /*! 12 - * @file hardware.h 13 - * @brief This file contains the hardware definitions of the board. 14 - * 15 - * @ingroup System 16 - */ 17 11 #ifndef __ASM_ARCH_MXC_HARDWARE_H__ 18 12 #define __ASM_ARCH_MXC_HARDWARE_H__ 19 13 ··· 43 49 MXC_MAX_EXP_IO_LINES + \ 44 50 MXC_MAX_VIRTUAL_INTS) 45 51 46 - #endif /* __ASM_ARCH_MXC_HARDWARE_H__ */ 52 + #endif /* __ASM_ARCH_MXC_HARDWARE_H__ */
+2 -13
include/asm-arm/arch-mxc/io.h
··· 8 8 * published by the Free Software Foundation. 9 9 */ 10 10 11 - /*! 12 - * @file io.h 13 - * @brief This file contains some memory mapping macros. 14 - * @note There is no real ISA or PCI buses. But have to define these macros 15 - * for some drivers to compile. 16 - * 17 - * @ingroup System 18 - */ 19 - 20 11 #ifndef __ASM_ARCH_MXC_IO_H__ 21 12 #define __ASM_ARCH_MXC_IO_H__ 22 13 23 - /*! Allow IO space to be anywhere in the memory */ 14 + /* Allow IO space to be anywhere in the memory */ 24 15 #define IO_SPACE_LIMIT 0xffffffff 25 16 26 - /*! 27 - * io address mapping macro 28 - */ 17 + /* io address mapping macro */ 29 18 #define __io(a) ((void __iomem *)(a)) 30 19 31 20 #define __mem_pci(a) (a)
+3 -14
include/asm-arm/arch-mxc/irqs.h
··· 13 13 14 14 #include <asm/hardware.h> 15 15 16 - /*! 17 - * @file irqs.h 18 - * @brief This file defines the number of normal interrupts and fast interrupts 19 - * 20 - * @ingroup Interrupt 21 - */ 22 - 23 16 #define MXC_IRQ_TO_EXPIO(irq) ((irq) - MXC_EXP_IO_BASE) 24 17 25 18 #define MXC_IRQ_TO_GPIO(irq) ((irq) - MXC_GPIO_INT_BASE) 26 19 #define MXC_GPIO_TO_IRQ(x) (MXC_GPIO_INT_BASE + x) 27 20 28 - /*! 29 - * Number of normal interrupts 30 - */ 21 + /* Number of normal interrupts */ 31 22 #define NR_IRQS MXC_MAX_INTS 32 23 33 - /*! 34 - * Number of fast interrupts 35 - */ 24 + /* Number of fast interrupts */ 36 25 #define NR_FIQS MXC_MAX_INTS 37 26 38 - #endif /* __ASM_ARCH_MXC_IRQS_H__ */ 27 + #endif /* __ASM_ARCH_MXC_IRQS_H__ */
+3 -10
include/asm-arm/arch-mxc/memory.h
··· 13 13 14 14 #include <asm/hardware.h> 15 15 16 - /*! 17 - * @file memory.h 18 - * @brief This file contains macros needed by the Linux kernel and drivers. 19 - * 20 - * @ingroup Memory 21 - */ 22 - 23 - /*! 16 + /* 24 17 * Virtual view <-> DMA view memory address translations 25 18 * This macro is used to translate the virtual address to an address 26 19 * suitable to be passed to set_dma_addr() 27 20 */ 28 21 #define __virt_to_bus(a) __virt_to_phys(a) 29 22 30 - /*! 23 + /* 31 24 * Used to convert an address for DMA operations to an address that the 32 25 * kernel can use. 33 26 */ 34 27 #define __bus_to_virt(a) __phys_to_virt(a) 35 28 36 - #endif /* __ASM_ARCH_MXC_MEMORY_H__ */ 29 + #endif /* __ASM_ARCH_MXC_MEMORY_H__ */
+2 -4
include/asm-arm/arch-mxc/mxc.h
··· 31 31 #define MXC_GPT_GPTICR2 IO_ADDRESS(GPT1_BASE_ADDR + 0x20) 32 32 #define MXC_GPT_GPTCNT IO_ADDRESS(GPT1_BASE_ADDR + 0x24) 33 33 34 - /*! 35 - * GPT Control register bit definitions 36 - */ 34 + /* GPT Control register bit definitions */ 37 35 #define GPTCR_FO3 (1 << 31) 38 36 #define GPTCR_FO2 (1 << 30) 39 37 #define GPTCR_FO1 (1 << 29) ··· 144 146 #define IIM_PROD_REV_SH 3 145 147 #define IIM_PROD_REV_LEN 5 146 148 147 - #endif /* __ASM_ARCH_MXC_H__ */ 149 + #endif /* __ASM_ARCH_MXC_H__ */
+1 -17
include/asm-arm/arch-mxc/system.h
··· 21 21 #ifndef __ASM_ARCH_MXC_SYSTEM_H__ 22 22 #define __ASM_ARCH_MXC_SYSTEM_H__ 23 23 24 - /*! 25 - * @file system.h 26 - * @brief This file contains idle and reset functions. 27 - * 28 - * @ingroup System 29 - */ 30 - 31 - /*! 32 - * This function puts the CPU into idle mode. It is called by default_idle() 33 - * in process.c file. 34 - */ 35 24 static inline void arch_idle(void) 36 25 { 37 26 cpu_do_idle(); 38 27 } 39 28 40 - /* 41 - * This function resets the system. It is called by machine_restart(). 42 - * 43 - * @param mode indicates different kinds of resets 44 - */ 45 29 static inline void arch_reset(char mode) 46 30 { 47 31 cpu_reset(0); 48 32 } 49 33 50 - #endif /* __ASM_ARCH_MXC_SYSTEM_H__ */ 34 + #endif /* __ASM_ARCH_MXC_SYSTEM_H__ */
+2 -12
include/asm-arm/arch-mxc/vmalloc.h
··· 20 20 #ifndef __ASM_ARCH_MXC_VMALLOC_H__ 21 21 #define __ASM_ARCH_MXC_VMALLOC_H__ 22 22 23 - /*! 24 - * @file vmalloc.h 25 - * 26 - * @brief This file contains platform specific macros for vmalloc. 27 - * 28 - * @ingroup System 29 - */ 30 - 31 - /*! 32 - * vmalloc ending address 33 - */ 23 + /* vmalloc ending address */ 34 24 #define VMALLOC_END 0xF4000000 35 25 36 - #endif /* __ASM_ARCH_MXC_VMALLOC_H__ */ 26 + #endif /* __ASM_ARCH_MXC_VMALLOC_H__ */