summaryrefslogtreecommitdiff
path: root/peripherals/peripherals.dir
diff options
context:
space:
mode:
Diffstat (limited to 'peripherals/peripherals.dir')
-rw-r--r--peripherals/peripherals.dir47
1 files changed, 47 insertions, 0 deletions
diff --git a/peripherals/peripherals.dir b/peripherals/peripherals.dir
new file mode 100644
index 0000000..464b743
--- /dev/null
+++ b/peripherals/peripherals.dir
@@ -0,0 +1,47 @@
+/* ----------------------------------------------------------------------------
+ * ATMEL Microcontroller Software Support
+ * ----------------------------------------------------------------------------
+ * Copyright (c) 2008, Atmel Corporation
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the disclaimer below.
+ *
+ * Atmel's name may not be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
+ * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ----------------------------------------------------------------------------
+ */
+
+//------------------------------------------------------------------------------
+/// \dir
+/// !!!Purpose
+///
+/// The #peripherals# directory stores a collection of basic APIs for each of
+/// the peripherals available on AT91 microcontrollers.
+///
+/// !!!Contents
+/// Each subdirectory inside this one provides code for a single peripheral. The
+/// directory is named according to the short-handed name of the peripheral, as
+/// written in the product datasheet (e.g. Advanced Interrupt Controller code
+/// is located in the #aic# directory).
+///
+/// Peripheral APIs provide low-level functions to simplify the use of
+/// AT91 peripherals. However, they do not provide fully-fledged drivers; such
+/// code can be found in the #drivers# directory of at91lib.
+//------------------------------------------------------------------------------
+
personal git repositories of Harald Welte. Your mileage may vary