diff options
author | Piotr Esden-Tempski <piotr@esden.net> | 2012-11-13 03:43:45 +0400 |
---|---|---|
committer | Piotr Esden-Tempski <piotr@esden.net> | 2012-11-13 03:43:45 +0400 |
commit | d08d366e75ffab8bb779b63bb3b08811f67a7403 (patch) | |
tree | 1e162ffe7811986afd94650bfc649a73e2f67678 /include/libopencm3/stm32/can.h | |
parent | b2af3ca540d132a43f1aba9a2d1064055511b8b9 (diff) |
[doc] Added preliminary STM32 CAN documentation.
Diffstat (limited to 'include/libopencm3/stm32/can.h')
-rw-r--r-- | include/libopencm3/stm32/can.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/include/libopencm3/stm32/can.h b/include/libopencm3/stm32/can.h index cdb5df19..c5313949 100644 --- a/include/libopencm3/stm32/can.h +++ b/include/libopencm3/stm32/can.h @@ -1,3 +1,17 @@ +/** @defgroup can_defines CAN defines + +@ingroup STM32F_defines + +@brief <b>libopencm3 Defined Constants and Types for STM32 CAN </b> + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2010 Piotr Esden-Tempski <piotr@esden.net> + +@date 12 November 2012 + +LGPL License Terms @ref lgpl_license +*/ /* * This file is part of the libopencm3 project. * @@ -23,11 +37,19 @@ #include <libopencm3/stm32/memorymap.h> #include <libopencm3/cm3/common.h> +/**@{*/ + /* --- Convenience macros -------------------------------------------------- */ /* CAN register base adresses (for convenience) */ +/*****************************************************************************/ +/** @defgroup can_reg_base CAN register base address +@ingroup can_defines + +@{*/ #define CAN1 BX_CAN1_BASE #define CAN2 BX_CAN2_BASE +/**@}*/ /* --- CAN registers ------------------------------------------------------- */ |