Skip to content

Latest commit

 

History

History
182 lines (135 loc) · 5.03 KB

README.md

File metadata and controls

182 lines (135 loc) · 5.03 KB

AmbiqMicroApolloSDK (beta)

Alternative SDK for Ambiq Micro Apollo 1 and 2 MCU from Fujitsu (beta and under development)

Official low-level drivers for Apollo1 can be found here: https://ambiqmicro.com/apollo-ultra-low-power-mcus/apollo1-mcu/

Official low-level drivers for Apollo2 can be found here: https://ambiqmicro.com/apollo-ultra-low-power-mcus/apollo2-mcu/

Official low-level drivers for Apollo2Blue can be found here: https://ambiqmicro.com/apollo-ultra-low-power-mcus/apollo2-blue-mcu/

The alternative SDK for Ambiq Micro Apollo 1 and 2 MCUs is offering CMSIS compatible implementations. In the first step the API is not yet CMSIS driver API compatible, but this feature will be added as next step.

The SDK can be used with FEEU MCU Templates, already configured for the correct device.

The latest MCU Template for Apollo1 and software examples can be found here: http://www.feeu.com/apollo1

The latest MCU Template for Apollo2 and software examples can be found here: http://www.feeu.com/apollo2

See also FEEUs ClickBeetle(TM) Platform for example software: http://www.feeu.com/clickbeetle

Usage with MCU Templates

Low-Level drivers are put into \library\lowlevel Configuration of low-level drivers is done in example\source\config\RTE_Device.h

Configuration

Configuration of low-level drivers is done in example\source\config\RTE_Device.h

Debug

set DEBUG_OUTPUT to 1 to enable debug output by adding following line in example\source\config\RTE_Device.h

#define DEBUG_OUTPUT 1

Debug print is realized automatically if debugprint is not defined via printf:

#if (DEBUG_OUTPUT == 1) && (!defined(debugprint))
#define debugprint(...) if ((CoreDebug->DHCSR & (1 << CoreDebug_DHCSR_C_DEBUGEN_Pos)) != 0) printf(__VA_ARGS__)
#define debugprintln(...) debugprint(__VA_ARGS__); debugprint("\r\n")
#endif

ADC

Enable ADC by adding following line in example\source\config\RTE_Device.h

#define APOLLOADC_ENABLED 1

Enable ADC debug by adding following line in example\source\config\RTE_Device.h

#define ADC_DEBUG 1

CTIMER

Enable all CTIMERs by adding following line in example\source\config\RTE_Device.h

#define APOLLOCTIMER_ENABLED 1

Enable just selected CTIMER0..3 by adding following line(s) in example\source\config\RTE_Device.h

#define CTIMER0_ENABLED 1
#define CTIMER1_ENABLED 1
#define CTIMER2_ENABLED 1
#define CTIMER3_ENABLED 1

Add the GPIO module (ApolloGpio) and enable it to have advanced functionalities in example\source\config\RTE_Device.h

#define APOLLOGPIO_ENABLED 1

Enable CTIMER debug by adding following line in example\source\config\RTE_Device.h

#define CTIMER_DEBUG 1

IOM

Enable all IOMs by adding following line in example\source\config\RTE_Device.h

#define APOLLOIOM_ENABLED 1

Enable just selected IOM0..5 by adding following line(s) in example\source\config\RTE_Device.h

#define IOMSTR0_ENABLED 1
#define IOMSTR1_ENABLED 1
#define IOMSTR2_ENABLED 1
#define IOMSTR3_ENABLED 1
#define IOMSTR4_ENABLED 1
#define IOMSTR5_ENABLED 1

To enable IRQ handling inside of the IOM module (ApolloIom) and possible usage of callbacks initiated by the interrupt, enable APOLLOIOM_USE_IRQS by adding following line in example\source\config\RTE_Device.h

#define APOLLOIOM_USE_IRQS 1

Enable IOM debug by adding following line in example\source\config\RTE_Device.h

#define IOM_DEBUG 1

GPIO

Enable by adding following line in example\source\config\RTE_Device.h

#define APOLLOGPIO_ENABLED 1

Enable APOLLOGPIO_USE_ARDUINO to add pinMode, attachInterrupt, digitalWrite, digitalRead and detachInterrupt functions by adding following line in example\source\config\RTE_Device.h

#define APOLLOGPIO_USE_ARDUINO 1

To enable IRQ handling inside of the GPIO module (ApolloGpio) and possible usage of callbacks initiated by the interrupt, enable APOLLOGPIO_USE_IRQS by adding following line in example\source\config\RTE_Device.h

#define APOLLOGPIO_USE_IRQS 1

Enable GPIO debug by adding following line in example\source\config\RTE_Device.h

#define GPIO_DEBUG 1

UART

Enable all UARTs by adding following line in example\source\config\RTE_Device.h

#define APOLLOUART_ENABLED 1

Enable just selected UART0..1 by adding following line(s) in example\source\config\RTE_Device.h

#define APOLLOUART0_ENABLED 1
#define APOLLOUART1_ENABLED 1

Enable Semihosting via UART by adding following line(s) in example\source\config\RTE_Device.h

#define UART_SEMIHOST_ENABLED  1
#define UART_SEMIHOST UART0

Enable CMSIS Driver API by adding following line(s) in example\source\config\RTE_Device.h

#define USE_CMSIS_DRIVER 1

Enable UART debug by adding following line in example\source\config\RTE_Device.h

#define UART_DEBUG 1

SYSCTRL

Enable SYSCTRL debug by adding following line in example\source\config\RTE_Device.h

#define SYSCTRL_DEBUG 1

ITMSEMIHOST

Enable ITMSEMIHOST by adding following line in example\source\config\RTE_Device.h

#define ITMSEMIHOST_ENABLED  1

A complete documentation will follow soon.