diff options
| -rw-r--r-- | docs/Doxyfile | 14 | ||||
| -rw-r--r-- | libmaple/libmaple.h | 75 |
2 files changed, 61 insertions, 28 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 21b847b..4016c05 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -147,7 +147,7 @@ SHORT_NAMES = NO # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style @@ -608,9 +608,7 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.c \ - *.cpp \ - *.h +FILE_PATTERNS = *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -1442,7 +1440,7 @@ PERL_PATH = /usr/bin/perl # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. -CLASS_DIAGRAMS = YES +CLASS_DIAGRAMS = NO # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see @@ -1502,19 +1500,19 @@ DOT_FONTPATH = # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. -CLASS_GRAPH = YES +CLASS_GRAPH = NO # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. -COLLABORATION_GRAPH = YES +COLLABORATION_GRAPH = NO # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies -GROUP_GRAPHS = YES +GROUP_GRAPHS = NO # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling diff --git a/libmaple/libmaple.h b/libmaple/libmaple.h index fa6c8a1..0b0494f 100644 --- a/libmaple/libmaple.h +++ b/libmaple/libmaple.h @@ -33,7 +33,7 @@ #include "libmaple_types.h" -// General configuration +/* General configuration */ #define DEBUG_NONE 0 #define DEBUG_FAULT 1 #define DEBUG_ALL 2 @@ -42,30 +42,31 @@ #define DEBUG_LEVEL DEBUG_ALL #endif -// MCU-specific configuration +/* MCU-specific configuration */ #ifdef MCU_STM32F103RB - // eg, LeafLabs Maple + /* e.g., LeafLabs Maple */ - // Number of GPIO ports (GPIOA, GPIOB, etc), definately used + /* Number of GPIO ports (GPIOA, GPIOB, etc.) */ #define NR_GPIO_PORTS 4 - // Total number of GPIO pins + /* Total number of GPIO pins */ #define NR_GPIO_PINS 39 - // Number of timer devices ports, definately used + /* Number of timer devices ports, definitely used */ #define NR_TIMERS 4 - // Number of USART ports + /* Number of USART ports */ #define NR_USART 3 - // Has an FSMC bus? + /* Has an FSMC bus? */ #define NR_FSMC 0 - // Has an FSMC bus? + /* Has an FSMC bus? */ #define NR_DAC_PINS 0 - // USB Identifier numbers - // Descriptor strings must be modified by hand in usb/descriptors.c for now + /* USB Identifier numbers */ + /* Descriptor strings must be modified by hand in + usb/descriptors.c for now */ #define VCOM_ID_VENDOR 0x1EAF #define VCOM_ID_PRODUCT 0x0004 #define USB_DISC_BANK GPIOC_BASE @@ -73,25 +74,25 @@ #define USB_CONFIG_MAX_POWER (100 >> 1) #define RESET_DELAY (100) - // Where to put usercode (based on space reserved for bootloader) + /* Where to put usercode (based on space reserved for bootloader) */ #define USER_ADDR_ROM 0x08005000 #define USER_ADDR_RAM 0x20000C00 #define STACK_TOP 0x20000800 - // Debug port settings (from ASSERT) + /* Debug port settings (from ASSERT) */ #define ERROR_LED_PORT GPIOA_BASE #define ERROR_LED_PIN 5 #define ERROR_USART_NUM USART2 #define ERROR_USART_BAUD 9600 - #define ERROR_TX_PIN 2 #define ERROR_TX_PORT GPIOA_BASE + #define ERROR_TX_PIN 2 - // Just in case, most boards have at least some memory + /* Just in case, most boards have at least some memory */ #ifndef RAMSIZE # define RAMSIZE (caddr_t)0x50000 #endif - // Bitbanded Memory sections + /* Bitbanded Memory sections */ #define BITBAND_SRAM_REF 0x20000000 #define BITBAND_SRAM_BASE 0x22000000 #define BITBAND_PERI_REF 0x40000000 @@ -99,7 +100,8 @@ #endif #ifdef MCU_STM32F103ZE - // eg, LeafLabs Maple Native + /* e.g., LeafLabs Maple Native */ + #define NR_GPIO_PORTS 7 #define NR_GPIO_PINS 63 #define NR_TIMERS 8 @@ -122,8 +124,8 @@ #define ERROR_LED_PIN 15 #define ERROR_USART_NUM USART1 #define ERROR_USART_BAUD 9600 - #define ERROR_TX_PIN 10 #define ERROR_TX_PORT GPIOA_BASE + #define ERROR_TX_PIN 10 #ifndef RAMSIZE # define RAMSIZE (caddr_t)0x50000 @@ -135,13 +137,46 @@ #define BITBAND_PERI_BASE 0x42000000 #endif -// Make sure MCU-specific settings were defined +#ifdef MCU_STM32F103CB + /* e.g., LeafLabs Maple Mini */ + + #define NR_GPIO_PORTS 3 + #define NR_GPIO_PINS 34 + #define NR_TIMERS 4 + #define NR_USART 3 + #define NR_FSMC 0 + #define NR_DAC_PINS 0 + + #define VCOM_ID_VENDOR 0x1EAF + #define VCOM_ID_PRODUCT 0x0005 + #define USB_DISC_BANK GPIOB_BASE + #define USB_DISC_PIN 9 + #define USB_CONFIG_MAX_POWER (100 >> 1) /* WTF does this mean */ + #define RESET_DELAY 100 + + #define USER_ADDR_ROM 0x08005000 + #define USER_ADDR_RAM 0x20000C00 + #define STACK_TOP 0x20000800 + + #define ERROR_LED_PORT GPIOB_BASE + #define ERROR_LED_PIN 12 + #define ERROR_USART_NUM USART2 + #define ERROR_USART_BAUD 9600 + #define ERROR_TX_PORT GPIOA_BASE + #define ERROR_TX_PIN 2 + + #ifndef RAMSIZE + # define RAMSIZE (caddr_t)0x50000 + #endif +#endif + +/* Make sure MCU-specific settings were defined */ #ifndef NR_GPIO_PORTS #error "No MCU type specified. Add something like -DMCU_STM32F103RB " \ "to your compiler arguments (probably in a Makefile)." #endif -// Requires board configuration info +/* Requires board configuration info */ #include "util.h" #endif |