aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple/include/libmaple/stm32.h
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2012-05-03 14:03:31 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2012-05-03 14:09:05 -0400
commita58ab72172936a224fb220122e703ea9a21cf9b8 (patch)
treef6fef7c864d3de1924959c95d23e4eb1b0a824d6 /libmaple/include/libmaple/stm32.h
parentae98df23f2f940faa9197d3efa8bfd8cf8c6df96 (diff)
downloadlibrambutan-a58ab72172936a224fb220122e703ea9a21cf9b8.tar.gz
librambutan-a58ab72172936a224fb220122e703ea9a21cf9b8.zip
libmaple/stm32.h: Copyrights and cosmetics.
Fix copyright. Fix Doxygen @file. Update file-level documentation, given this file's increased importance as an abstraction for porting between series. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'libmaple/include/libmaple/stm32.h')
-rw-r--r--libmaple/include/libmaple/stm32.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/libmaple/include/libmaple/stm32.h b/libmaple/include/libmaple/stm32.h
index d53af3a..80d0777 100644
--- a/libmaple/include/libmaple/stm32.h
+++ b/libmaple/include/libmaple/stm32.h
@@ -1,7 +1,7 @@
/******************************************************************************
* The MIT License
*
- * Copyright (c) 2010 LeafLabs, LLC.
+ * Copyright (c) 2010, 2011, 2012 LeafLabs, LLC.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
@@ -25,8 +25,14 @@
*****************************************************************************/
/**
- * @file stm32.h
- * @brief STM32 chip-specific definitions
+ * @file libmaple/include/libmaple/stm32.h
+ * @brief STM32 chip header
+ *
+ * This header supplies various chip-specific values for the current
+ * build target. It's useful both to abstract away hardware details
+ * (e.g. through use of STM32_NR_INTERRUPTS) and to decide what to do
+ * when you want something nonportable (e.g. by checking
+ * STM32_MCU_SERIES).
*/
#ifndef _LIBMAPLE_STM32_H_