Skip to content

L
linux
Commit f304fc42 authored by Robert Schwebel's avatar Robert Schwebel Committed by Russell King
Browse files
Options

[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: default avatarJuergen Beisert <j.beisert@pengutronix.de>
Signed-off-by: default avatarRoss Wille <wille@freescale.com>
Signed-off-by: default avatarRussell King <rmk+kernel@arm.linux.org.uk>
parent 05dda977
Hide whitespace changes
Inline Side-by-side
Showing with 61 additions and 161 deletions
include/asm-arm/arch-mxc/board-mx31ads.h
View file @ f304fc42
...@@ -11,107 +11,77 @@ ...@@ -11,107 +11,77 @@
#ifndef __ASM_ARCH_MXC_BOARD_MX31ADS_H__ #ifndef __ASM_ARCH_MXC_BOARD_MX31ADS_H__
#define __ASM_ARCH_MXC_BOARD_MX31ADS_H__ #define __ASM_ARCH_MXC_BOARD_MX31ADS_H__
/*! /* Base address of PBC controller */
* @name PBC Controller parameters
*/
/*! @{ */
/*!
* Base address of PBC controller
*/
#define PBC_BASE_ADDRESS IO_ADDRESS(CS4_BASE_ADDR) #define PBC_BASE_ADDRESS IO_ADDRESS(CS4_BASE_ADDR)
/* Offsets for the PBC Controller register */ /* Offsets for the PBC Controller register */
/*!
* PBC Board status register offset /* PBC Board status register offset */
*/
#define PBC_BSTAT 0x000002 #define PBC_BSTAT 0x000002
/*!
* PBC Board control register 1 set address. /* PBC Board control register 1 set address */
*/
#define PBC_BCTRL1_SET 0x000004 #define PBC_BCTRL1_SET 0x000004
/*!
* PBC Board control register 1 clear address. /* PBC Board control register 1 clear address */
*/
#define PBC_BCTRL1_CLEAR 0x000006 #define PBC_BCTRL1_CLEAR 0x000006
/*!
* PBC Board control register 2 set address. /* PBC Board control register 2 set address */
*/
#define PBC_BCTRL2_SET 0x000008 #define PBC_BCTRL2_SET 0x000008
/*!
* PBC Board control register 2 clear address. /* PBC Board control register 2 clear address */
*/
#define PBC_BCTRL2_CLEAR 0x00000A #define PBC_BCTRL2_CLEAR 0x00000A
/*!
* PBC Board control register 3 set address. /* PBC Board control register 3 set address */
*/
#define PBC_BCTRL3_SET 0x00000C #define PBC_BCTRL3_SET 0x00000C
/*!
* PBC Board control register 3 clear address. /* PBC Board control register 3 clear address */
*/
#define PBC_BCTRL3_CLEAR 0x00000E #define PBC_BCTRL3_CLEAR 0x00000E
/*!
* PBC Board control register 4 set address. /* PBC Board control register 4 set address */
*/
#define PBC_BCTRL4_SET 0x000010 #define PBC_BCTRL4_SET 0x000010
/*!
* PBC Board control register 4 clear address. /* PBC Board control register 4 clear address */
*/
#define PBC_BCTRL4_CLEAR 0x000012 #define PBC_BCTRL4_CLEAR 0x000012
/*!
* PBC Board status register 1. /* PBC Board status register 1 */
*/
#define PBC_BSTAT1 0x000014 #define PBC_BSTAT1 0x000014
/*!
* PBC Board interrupt status register. /* PBC Board interrupt status register */
*/
#define PBC_INTSTATUS 0x000016 #define PBC_INTSTATUS 0x000016
/*!
* PBC Board interrupt current status register. /* PBC Board interrupt current status register */
*/
#define PBC_INTCURR_STATUS 0x000018 #define PBC_INTCURR_STATUS 0x000018
/*!
* PBC Interrupt mask register set address. /* PBC Interrupt mask register set address */
*/
#define PBC_INTMASK_SET 0x00001A #define PBC_INTMASK_SET 0x00001A
/*!
* PBC Interrupt mask register clear address. /* PBC Interrupt mask register clear address */
*/
#define PBC_INTMASK_CLEAR 0x00001C #define PBC_INTMASK_CLEAR 0x00001C
/*! /* External UART A */
* External UART A.
*/
#define PBC_SC16C652_UARTA 0x010000 #define PBC_SC16C652_UARTA 0x010000
/*!
* External UART B. /* External UART B */
*/
#define PBC_SC16C652_UARTB 0x010010 #define PBC_SC16C652_UARTB 0x010010
/*!
* Ethernet Controller IO base address. /* Ethernet Controller IO base address */
*/
#define PBC_CS8900A_IOBASE 0x020000 #define PBC_CS8900A_IOBASE 0x020000
/*!
* Ethernet Controller Memory base address. /* Ethernet Controller Memory base address */
*/
#define PBC_CS8900A_MEMBASE 0x021000 #define PBC_CS8900A_MEMBASE 0x021000
/*!
* Ethernet Controller DMA base address. /* Ethernet Controller DMA base address */
*/
#define PBC_CS8900A_DMABASE 0x022000 #define PBC_CS8900A_DMABASE 0x022000
/*!
* External chip select 0. /* External chip select 0 */
*/
#define PBC_XCS0 0x040000 #define PBC_XCS0 0x040000
/*!
* LCD Display enable. /* LCD Display enable */
*/
#define PBC_LCD_EN_B 0x060000 #define PBC_LCD_EN_B 0x060000
/*!
* Code test debug enable. /* Code test debug enable */
*/
#define PBC_CODE_B 0x070000 #define PBC_CODE_B 0x070000
/*!
* PSRAM memory select. /* PSRAM memory select */
*/
#define PBC_PSRAM_B 0x5000000 #define PBC_PSRAM_B 0x5000000
#define PBC_INTSTATUS_REG (PBC_INTSTATUS + PBC_BASE_ADDRESS) #define PBC_INTSTATUS_REG (PBC_INTSTATUS + PBC_BASE_ADDRESS)
...@@ -139,4 +109,4 @@ ...@@ -139,4 +109,4 @@
#define MXC_MAX_EXP_IO_LINES 16 #define MXC_MAX_EXP_IO_LINES 16
#endif /* __ASM_ARCH_MXC_BOARD_MX31ADS_H__ */ #endif /* __ASM_ARCH_MXC_BOARD_MX31ADS_H__ */
include/asm-arm/arch-mxc/dma.h
View file @ f304fc42
...@@ -11,11 +11,4 @@ ...@@ -11,11 +11,4 @@
#ifndef __ASM_ARCH_MXC_DMA_H__ #ifndef __ASM_ARCH_MXC_DMA_H__
#define __ASM_ARCH_MXC_DMA_H__ #define __ASM_ARCH_MXC_DMA_H__
/*!
* @file dma.h
* @brief This file contains Unified DMA API for all MXC platforms.
* The API is platform independent.
*
* @ingroup SDMA
*/
#endif #endif
include/asm-arm/arch-mxc/hardware.h
View file @ f304fc42
...@@ -8,12 +8,6 @@ ...@@ -8,12 +8,6 @@
* published by the Free Software Foundation. * published by the Free Software Foundation.
*/ */
/*!
* @file hardware.h
* @brief This file contains the hardware definitions of the board.
*
* @ingroup System
*/
#ifndef __ASM_ARCH_MXC_HARDWARE_H__ #ifndef __ASM_ARCH_MXC_HARDWARE_H__
#define __ASM_ARCH_MXC_HARDWARE_H__ #define __ASM_ARCH_MXC_HARDWARE_H__
...@@ -49,4 +43,4 @@ ...@@ -49,4 +43,4 @@
MXC_MAX_EXP_IO_LINES + \ MXC_MAX_EXP_IO_LINES + \
MXC_MAX_VIRTUAL_INTS) MXC_MAX_VIRTUAL_INTS)
#endif /* __ASM_ARCH_MXC_HARDWARE_H__ */ #endif /* __ASM_ARCH_MXC_HARDWARE_H__ */
include/asm-arm/arch-mxc/io.h
View file @ f304fc42
...@@ -8,24 +8,13 @@ ...@@ -8,24 +8,13 @@
* published by the Free Software Foundation. * published by the Free Software Foundation.
*/ */
/*!
* @file io.h
* @brief This file contains some memory mapping macros.
* @note There is no real ISA or PCI buses. But have to define these macros
* for some drivers to compile.
*
* @ingroup System
*/
#ifndef __ASM_ARCH_MXC_IO_H__ #ifndef __ASM_ARCH_MXC_IO_H__
#define __ASM_ARCH_MXC_IO_H__ #define __ASM_ARCH_MXC_IO_H__
/*! Allow IO space to be anywhere in the memory */ /* Allow IO space to be anywhere in the memory */
#define IO_SPACE_LIMIT 0xffffffff #define IO_SPACE_LIMIT 0xffffffff
/*! /* io address mapping macro */
* io address mapping macro
*/
#define __io(a) ((void __iomem *)(a)) #define __io(a) ((void __iomem *)(a))
#define __mem_pci(a) (a) #define __mem_pci(a) (a)
......
include/asm-arm/arch-mxc/irqs.h
View file @ f304fc42
...@@ -13,26 +13,15 @@ ...@@ -13,26 +13,15 @@
#include <asm/hardware.h> #include <asm/hardware.h>
/*!
* @file irqs.h
* @brief This file defines the number of normal interrupts and fast interrupts
*
* @ingroup Interrupt
*/
#define MXC_IRQ_TO_EXPIO(irq) ((irq) - MXC_EXP_IO_BASE) #define MXC_IRQ_TO_EXPIO(irq) ((irq) - MXC_EXP_IO_BASE)
#define MXC_IRQ_TO_GPIO(irq) ((irq) - MXC_GPIO_INT_BASE) #define MXC_IRQ_TO_GPIO(irq) ((irq) - MXC_GPIO_INT_BASE)
#define MXC_GPIO_TO_IRQ(x) (MXC_GPIO_INT_BASE + x) #define MXC_GPIO_TO_IRQ(x) (MXC_GPIO_INT_BASE + x)
/*! /* Number of normal interrupts */
* Number of normal interrupts
*/
#define NR_IRQS MXC_MAX_INTS #define NR_IRQS MXC_MAX_INTS
/*! /* Number of fast interrupts */
* Number of fast interrupts
*/
#define NR_FIQS MXC_MAX_INTS #define NR_FIQS MXC_MAX_INTS
#endif /* __ASM_ARCH_MXC_IRQS_H__ */ #endif /* __ASM_ARCH_MXC_IRQS_H__ */
include/asm-arm/arch-mxc/memory.h
View file @ f304fc42
...@@ -13,24 +13,17 @@ ...@@ -13,24 +13,17 @@
#include <asm/hardware.h> #include <asm/hardware.h>
/*! /*
* @file memory.h
* @brief This file contains macros needed by the Linux kernel and drivers.
*
* @ingroup Memory
*/
/*!
* Virtual view <-> DMA view memory address translations * Virtual view <-> DMA view memory address translations
* This macro is used to translate the virtual address to an address * This macro is used to translate the virtual address to an address
* suitable to be passed to set_dma_addr() * suitable to be passed to set_dma_addr()
*/ */
#define __virt_to_bus(a) __virt_to_phys(a) #define __virt_to_bus(a) __virt_to_phys(a)
/*! /*
* Used to convert an address for DMA operations to an address that the * Used to convert an address for DMA operations to an address that the
* kernel can use. * kernel can use.
*/ */
#define __bus_to_virt(a) __phys_to_virt(a) #define __bus_to_virt(a) __phys_to_virt(a)
#endif /* __ASM_ARCH_MXC_MEMORY_H__ */ #endif /* __ASM_ARCH_MXC_MEMORY_H__ */
include/asm-arm/arch-mxc/mxc.h
View file @ f304fc42
...@@ -31,9 +31,7 @@ ...@@ -31,9 +31,7 @@
#define MXC_GPT_GPTICR2 IO_ADDRESS(GPT1_BASE_ADDR + 0x20) #define MXC_GPT_GPTICR2 IO_ADDRESS(GPT1_BASE_ADDR + 0x20)
#define MXC_GPT_GPTCNT IO_ADDRESS(GPT1_BASE_ADDR + 0x24) #define MXC_GPT_GPTCNT IO_ADDRESS(GPT1_BASE_ADDR + 0x24)
/*! /* GPT Control register bit definitions */
* GPT Control register bit definitions
*/
#define GPTCR_FO3 (1 << 31) #define GPTCR_FO3 (1 << 31)
#define GPTCR_FO2 (1 << 30) #define GPTCR_FO2 (1 << 30)
#define GPTCR_FO1 (1 << 29) #define GPTCR_FO1 (1 << 29)
...@@ -146,4 +144,4 @@ ...@@ -146,4 +144,4 @@
#define IIM_PROD_REV_SH 3 #define IIM_PROD_REV_SH 3
#define IIM_PROD_REV_LEN 5 #define IIM_PROD_REV_LEN 5
#endif /* __ASM_ARCH_MXC_H__ */ #endif /* __ASM_ARCH_MXC_H__ */
include/asm-arm/arch-mxc/system.h
View file @ f304fc42
...@@ -21,30 +21,14 @@ ...@@ -21,30 +21,14 @@
#ifndef __ASM_ARCH_MXC_SYSTEM_H__ #ifndef __ASM_ARCH_MXC_SYSTEM_H__
#define __ASM_ARCH_MXC_SYSTEM_H__ #define __ASM_ARCH_MXC_SYSTEM_H__
/*!
* @file system.h
* @brief This file contains idle and reset functions.
*
* @ingroup System
*/
/*!
* This function puts the CPU into idle mode. It is called by default_idle()
* in process.c file.
*/
static inline void arch_idle(void) static inline void arch_idle(void)
{ {
cpu_do_idle(); cpu_do_idle();
} }
/*
* This function resets the system. It is called by machine_restart().
*
* @param mode indicates different kinds of resets
*/
static inline void arch_reset(char mode) static inline void arch_reset(char mode)
{ {
cpu_reset(0); cpu_reset(0);
} }
#endif /* __ASM_ARCH_MXC_SYSTEM_H__ */ #endif /* __ASM_ARCH_MXC_SYSTEM_H__ */
include/asm-arm/arch-mxc/vmalloc.h
View file @ f304fc42
...@@ -20,17 +20,7 @@ ...@@ -20,17 +20,7 @@
#ifndef __ASM_ARCH_MXC_VMALLOC_H__ #ifndef __ASM_ARCH_MXC_VMALLOC_H__
#define __ASM_ARCH_MXC_VMALLOC_H__ #define __ASM_ARCH_MXC_VMALLOC_H__
/*! /* vmalloc ending address */
* @file vmalloc.h
*
* @brief This file contains platform specific macros for vmalloc.
*
* @ingroup System
*/
/*!
* vmalloc ending address
*/
#define VMALLOC_END 0xF4000000 #define VMALLOC_END 0xF4000000
#endif /* __ASM_ARCH_MXC_VMALLOC_H__ */ #endif /* __ASM_ARCH_MXC_VMALLOC_H__ */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7