nutdoc_en.txt

含有完整TCP/IP PPP协议的嵌入式操作系统

/*@{*/
/*!
 * \defgroup xgEth0Dev Device eth0
 * \brief Realtek 8019AS Ethernet device
 */
/*@}*/

/*!
 * \defgroup xgNicLanc111 SMSC LAN91C111
 * \brief 10/100 MBit Ethernet controller.
 *
 * The LAN91C111 chip is used on the Ethernut 2 board.
 */
/*@{*/
/*!
 * \defgroup xgSmscRegs LAN91C111 registers
 * \brief SMSC LAN91C111 register definitions.
 */
/*@}*/

/*!
 * \defgroup xgNicCs8900 Crystal CS8900A
 * \brief 10 MBit Ethernet controller.
 *
 * The device driver for the CS8900A is poorly supported. Be
 * prepared that some debugging may be required when using
 * it with the latest Nut/Net release.
 */

/*@} xgNutArchAvrDevEthernet */

/*!
 * \defgroup xgNutArchAvrDevDebug Debug
 * \brief AVR debug output devices.
 */
/*@{*/
/*@} xgNutArchAvrDevDebug */

/*@} xgNutArchAvrDev */

/*!
 * \defgroup xgHardwareAvr Special Hardware
 * \brief Support routines for direct hardware access.
 *
 * Not every hardware fits into I/O driver model. For
 * example it would look at least a bit strange using
 * printf() or _ioctl() to switch an LED on or off.
 * Therefore several API calls had been added to deal
 * with special hardware.
 */
/*@{*/

/*!
 * \defgroup xgAvrAdc A/D Converter
 * \brief ATmega128 On-Chip ADC.
 */
 
/*!
 * \defgroup xgCanSJA1000 SJA1000
 * \brief CAN Bus Controller
 */

/*!
 * \defgroup xgVs1001 VLSI VS1001K
 * \brief MP3 Decoder
 */

/*!
 * \defgroup xgIrSony Sony IR
 * \brief Infrared Remote Control
 */
 
/*! 
 * \defgroup xgSpiDigIo SPI Digital I/O
 * \brief SPI controlled digital input and output ports.
 *
 * This simple driver supports digital I/O ports like 
 * relay outputs and optocoupler inputs.
 */

/*! 
 * \defgroup xgSpiFlash SPI Flash Devices
 * \brief Programs SPI attached flash devices.
 *
 * When AVR CPUs are attached to the SPI, then the
 * routines in this module can be used to write
 * to the flash ROM of these devices.
 *
 * These routines are poorly supported and may not work as expected.
 */

/*@} xgHardwareAvr */

/*!
 * \defgroup xgConfigAvr Configuration
 * \brief Hardware Settings.
 */
/*@{*/
 
/*!
 * \defgroup xgConfigPortsAvr Ports
 * \brief Assigned port bits.
 */

/*!
 * \defgroup xgMCanCfg MCAN Board
 * \brief Microcontroller Board with CAN Bus
 */

/*@} xgConfigAvr */


/*@} xgNutArchAvr */



/* =================================== ARM Architectures ================================= */
/*!
 * \defgroup xgNutArchArm ARM
 * \brief 32 Bit RISC processor.
 *
 * \code
 * #include <arch/arm.h>
 * \endcode
 *
 * This port had been successfully tested on the AT91R40008 
 * (including Nut/Net) and the GameBoy Advance (w/o Nut/Net).
 */
/*@{*/

/*!
 * \defgroup xgNutArchArmAt91 AT91
 * \brief AT91 peripheral registers.
 *
 * The AT91 peripherals are connected to the 32-bit wide advanced peripheral bus.
 * All registers are word accessible only.
 */ 
/*@{*/

/*!
 * \defgroup xgNutArchArmAt91Ebi Bus Interface
 * \brief External bus interface registers.
 */ 

/*!
 * \defgroup xgNutArchArmAt91Ps Power Saving
 * \brief Power saving registers.
 *
 * The Power-saving feature optimizes power consumption, enabling the 
 * software to stop the CPU clock and restarting it on interrupts or
 * on reset. Also, the on-chip peripheral clocks can be enabled or 
 * disabled individually.
 */

/*!
 * \defgroup xgNutArchArmAt91Aic Interrupt Controller
 * \brief Advanced interrupt controller registers.
 *
 * The AT91 series provides an 8-level priority, individually maskable, 
 * vectored interrupt controller.
 */

/*!
 * \defgroup xgNutArchArmAt91Pio Parallel I/O
 * \brief Parallel I/O controller registers.
 *
 * Most parallel I/O lines are multiplexed with external signals of 
 * other peripherals to optimize the use of available package pins.
 */
 
/*!
 * \defgroup xgNutArchArmAt91Wd Watchdog
 * \brief Watchdog timer registers.
 *
 * The Watch Dog is used to prevent system lock-up if the software becomes 
 * trapped in a deadlock. It can generate an internal reset or interrupt.
 */
 
/*!
 * \defgroup xgNutArchArmAt91Sf Special Function
 * \brief Special function registers
 */
 
/*!
 * \defgroup xgNutArchArmAt91Us USART
 * \brief Universal synchronous / asynchronous receiver / transmitter registers.
 */
 
/*!
 * \defgroup xgNutArchArmAt91Tc Timer/Counter
 * \brief Timer / Counter registers.
 */
 
/*@} xgNutArchArmAt91 */

/*!
 * \defgroup xgNutArchArmGba Gameboy Advance Support
 * \brief Nintendo Gameboy Advance
 */ 
 
/*!
 * \defgroup xgNutArchArmBoot Boot
 * \brief Loading the code
 */ 
 
/*!
 * \defgroup xgNutArchArmInit Initialization
 * \brief Starting Nut/OS
 */ 

/*!
 * \defgroup xgNutArchArmOs System Support
 * \brief Hardware dependant functions used by Nut/OS.
 */
/*@{*/

/*!
 * \defgroup xgNutArchArmOsContext Context Switching
 * \brief Context Switching for GNUARM
 *
 * This code should work with other GCC distributions for the ARM CPU.
 */
 
/*!
 * \defgroup xgNutArchArmOsTimerAt91 AT91 System Timer
 * \brief Nut/OS System Timer implemented on the AT91
 */
 
/*!
 * \defgroup xgNutArchArmOsTimerGba GBA System Timer
 * \brief Nut/OS System Timer implemented on the GBA
 */
 
/*@} xgNutArchArmOs */
 
/*!
 * \defgroup xgNutArchArmDev Device Drivers
 * \brief Hardware dependant device driver code.
 */
/*@{*/

/*!
 * \defgroup xgNutArchArmDevIrq Interrupts
 * \brief Interrupt handler routines
 *
 */
/*@{*/

/*!
 * \defgroup xgNutArchArmDevIrqAt91 AT91 Interrupts
 * \brief Interrupt handler for the AT91
 *
 * Handling interrupts on the AT91 is still a miserable hack.
 *
 * \todo Handle AT91 interrupts nicely.
 */
 
/*!
 * \defgroup xgNutArchArmDevIrqGba GBA Interrupts
 * \brief Interrupt handler for the GameBoy Advance
 *
 */

/*@} xgNutArchArmDevIrq */

/*!
 * \defgroup xgNutArchArmDevSerial Serial
 * \brief ARM drivers for serial communication.
 *
 */
/*@{*/

/*!
 * \defgroup xgUartGba GBA UART
 * \brief Gameboy Advance UART driver.
 *
 * This code doesn't work.
 */
 
/*@} xgNutArchArmDevSerial */

/*!
 * \defgroup xgNutArchArmDevEthernet Ethernet
 * \brief Ethernet controller drivers.
 *
 */
/*@{*/

/*!
 * \defgroup xgNicAsix Asix AX88796L
 * \brief 10/100 MBit NE2000 compatible controller.
 *
 * Highly experimental.
 */

/*@} xgNutArchArmDevEthernet */

/*!
 * \defgroup xgNutArchArmDevDebug Debug
 * \brief Debug output drivers
 *
 */
/*@{*/

/*!
 * \defgroup xgDevDebugAt91 AT91 Debug Device
 * \brief Debug output driver for AT91 On-Chip UART.
 *
 * This stream device driver writes data to the internal UART.
 * The output is unbuffered and uses polling. Therefore it can 
 * be used for standard I/O output even within interrupt routines.
 */

/*!
 * \defgroup xgDevDebugGba GBA Debug Output
 * \brief Debug output driver for GBA LCD Screen.
 */
 
/*@} xgNutArchArmDevDebug */

/*@} xgNutArchArmDev */


/*@} xgNutArchArm */

/* ================================= Emulator Architecture =============================== */
/*!
 * \defgroup xgNutArchUnix Emulator (UNIX)
 * \brief Running Nut/OS Apps on a UNIX machine 
 *
 * Nut/OS can be compiled for a native unix target.
 *
 * The following hardware is currently emulated: RTC and UART.
 * A RTC clock is provided. All AVR UARTS are mapped to STDIO but this can configure
 * at app start-up using command line paramters. Syntax:
 * 
 * MyNutOSAPP.unix [-u0 deviceName] [-u1 deviceName] [-u2 deviceName]
 * 
 * The unix emulation provides a third uart for debugging purposes as devDebug2, devUsart2 and devUsartAvr2)
 * 
 */
/*@{*/

/*!
 * \defgroup xgNutArchUnixInit Initialization
 * \brief Starting Nut/OS
 */ 

/*!
 * \defgroup xgNutArchUnixOs System Support
 * \brief Hardware dependant functions used by Nut/OS.
 */
/*@{*/

/*!
 * \defgroup xgNutArchUnixOsContext Context Switching
 * \brief Context Switching for the UNIX emulator.
 */
 
/*!
 * \defgroup xgNutArchUnixOsTimer System Timer
 * \brief Nut/OS System Timer
 */
 
/*@} xgNutArchUnixOs */

/*@} xgNutArchUnix */

/* ================================= H8/300H Architecture ================================ */
/*!
 * \defgroup xgNutArchH8300h H8/300H
 * \brief Renesas 16 Bit CPU
 *
 * Poorly supported.
 */
/*@{*/

/*!
 * \defgroup xgNutArchH8300hBoot Boot
 * \brief Loading the code
 */ 
 
/*!
 * \defgroup xgNutArchH8300hInit Initialization
 * \brief Starting Nut/OS
 */ 

/*!
 * \defgroup xgNutArchH8300hOs System Support
 * \brief Hardware dependant functions used by Nut/OS.
 */
/*@{*/

/*!
 * \defgroup xgNutArchH8300hOsContext Context Switching
 * \brief Context Switching with GCC
 */
 
/*!
 * \defgroup xgNutArchH8300hOsTimer System Timer
 * \brief Nut/OS System Timer implemented on the H8/300H
 */
 
/*@} xgNutArchH8300hOs */
 
/*!
 * \defgroup xgNutArchH8300hDev Device Drivers
 * \brief Hardware dependant device driver code.
 */
/*@{*/

/*!
 * \defgroup xgNutArchH8300hDevSerial Serial
 * \brief ARM drivers for serial communication.
 *
 */
/*@{*/

/*!
 * \defgroup xgUartH8 UART
 * \brief TODO
 *
 */

/*!
 * \defgroup xgUartDev UART
 * \brief TODO
 *
 */
 
/*@} xgNutArchH8300hDevSerial */

/*!
 * \defgroup xgNutArchH8300hDevEthernet Ethernet
 * \brief Ethernet controller drivers.
 *
 */

/*!
 * \defgroup xgNutArchH8300hDevDebug Debug
 * \brief Debug output drivers
 *
 */

/*@} xgNutArchH8300hDev */

 
/*!
 * \defgroup xgRPortCfg RPort
 * \brief RPort hardware specification.
 */
 
/*@} xgNutArchH8300h */

/* ================================= M68K Architecture =================================== */
/*!
 * \defgroup xgNutArchM68k M68K
 * \brief Freescale CISC Processor
 *
 * Not implemented. Nothing but a placeholder.
 */
/*@{*/

/*!
 * \defgroup xgNutArchM68kBoot Boot
 * \brief Loading the code
 */ 
 
/*!
 * \defgroup xgNutArchM68kInit Initialization
 * \brief Starting Nut/OS
 */ 

/*@} xgNutArchM68k */

/*@}*/
  
/* ================================= Directories ========================================= */
/*!
 * \dir nut/os/
 * Nut/OS Kernel
 */
/* ======================================================================================= */