00001 /* ---------------------------------------------------------------------------- 00002 * SAM Software Package License 00003 * ---------------------------------------------------------------------------- 00004 * Copyright (c) 2012, Atmel Corporation 00005 * 00006 * All rights reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions are met: 00010 * 00011 * - Redistributions of source code must retain the above copyright notice, 00012 * this list of conditions and the disclaimer below. 00013 * 00014 * Atmel's name may not be used to endorse or promote products derived from 00015 * this software without specific prior written permission. 00016 * 00017 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR 00018 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 00019 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 00020 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, 00021 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00022 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 00023 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00024 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00025 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 00026 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00027 * ---------------------------------------------------------------------------- 00028 */ 00029 00030 /** 00031 * \page libchip_page Chip Library 00032 * 00033 * \section Purpose 00034 * 00035 * This directory provides a library of highly re-usable code to access 00036 * peripheral controllers with microcontrollers. 00037 * 00038 * \section Contents 00039 * - \ref acc_module "ACC": the Analog Comparator Controller. 00040 * - \ref aes_module "AES": the Advanced Encryption Standard module. 00041 * - \ref AFEC_module "AFEC": the Analog Front-End Controller. 00042 * - \ref afe_dma_module "AFEC DMA": the Analog Front-End Controller with DMA support. 00043 * - \ref dacc_module "DAC": the Digital-to-Analog Converter Controller. 00044 * - \ref mediaLB "MediaLB": the MediaLB peripheral. 00045 * - \ref pio_capture_module "PIO Parallel Capture": the PIO Parallel Capture mode. 00046 * - \ref pwm_module "PWMC": the Pulse Width Modulation controller (PWMC). 00047 * - \ref pmc_module "PMC": the Power Management Controller (PMC). 00048 * - \ref rtc_module "RTC": the Real-time Clock (RTC) controller. 00049 * - \ref spi_module "SPI": the Serial Peripheral Interface (SPI). 00050 * - \ref rtt_module "RTT": the Real-time Timer. 00051 * - \ref rtng_module "TRNG": the True Random Number Generator. 00052 * - \ref twi_module "TWI": the Two-wire Interface (TWI). 00053 * - \ref wdt_module "WDT": the Interface for the Watchdog Timer (WDT). 00054 * 00055 * For more accurate information, please look at the related peripheral section of the 00056 * Datasheet. 00057 * 00058 * \ref peripherals_module "Chip Ligrary" shows detailed information of the library. 00059 * \note 00060 * Depending on the chip, not all the peripherals will be available. 00061 */ 00062 */ 00063 /** 00064 \defgroup peripherals_module peripherals_module 00065 */ 00066 /** \defgroup peripherals_module Chip Library 00067 * \section Contents 00068 * The directory can basically be divided into several sections for their usage: 00069 * - \ref acc_module "ACC": the Analog Comparator Controller. 00070 * - \ref aes_module "AES": the Advanced Encryption Standard module. 00071 * - \ref AFEC_module "AFEC": the Analog Front-End Controller. 00072 * - \ref afe_dma_module "AFEC DMA": the Analog Front-End Controller with DMA support. 00073 * - \ref dacc_module "DAC": the Digital-to-Analog Converter Controller. 00074 * - \ref mediaLB "MediaLB": the MediaLB peripheral. 00075 * - \ref pio_capture_module "PIO Parallel Capture": the PIO Parallel Capture mode. 00076 * - \ref pwm_module "PWMC": the Pulse Width Modulation controller (PWMC). 00077 * - \ref pmc_module "PMC": the Power Management Controller (PMC). 00078 * - \ref rtc_module "RTC": the Real-time Clock (RTC) controller. 00079 * - \ref spi_module "SPI": the Serial Peripheral Interface (SPI). 00080 * - \ref rtt_module "RTT": the Real-time Timer. 00081 * - \ref rtng_module "TRNG": the True Random Number Generator. 00082 * - \ref twi_module "TWI": the Two-wire Interface (TWI). 00083 * - \ref wdt_module "WDT": the Interface for the Watchdog Timer (WDT). 00084 */ 00085 00086 /*--------------------- Module layer Start ---------------------------*/ 00087 /**@{*/ 00088 00089 /** \defgroup acc_module Working with ACC 00090 */ 00091 00092 /** \defgroup aes_module Working with AES 00093 */ 00094 00095 /** \defgroup AFEC_module Working with AFE 00096 */ 00097 00098 /** \defgroup afe_dma_module Working with AFE (DMA support) 00099 */ 00100 00101 /** \defgroup dacc_module Working with DACC 00102 */ 00103 00104 /** \defgroup mediaLB Working with MediaLB 00105 */ 00106 00107 /** \defgroup pio_capture_module Working with PIO Parallel Capture Mode 00108 */ 00109 00110 /** \defgroup pmc_module Working with PMC 00111 */ 00112 00113 /** \defgroup rtt_module Working with Real-time Timer 00114 */ 00115 00116 /** \defgroup rtc_module Working with RTC 00117 */ 00118 00119 /** \defgroup spi_module Working with SPI 00120 */ 00121 00122 00123 /** \defgroup rtng_module Working with RTNG 00124 */ 00125 00126 00127 /** \defgroup wdt_module Working with WDT 00128 */ 00129 00130 /**@}*/ 00131