468 lines
14 KiB
C
468 lines
14 KiB
C
//*****************************************************************************
|
|
//
|
|
//! @file am_bsp.c
|
|
//!
|
|
//! @brief Top level functions for performing board initialization.
|
|
//!
|
|
//! @addtogroup BSP Board Support Package (BSP)
|
|
//! @addtogroup apollo1_evb BSP for the Apollo1 APOLLO512-KBR Board Rev 1.0 board
|
|
//! @ingroup BSP
|
|
//! @{
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Copyright (c) 2020, Ambiq Micro
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// 1. Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
//
|
|
// 2. Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// 3. Neither the name of the copyright holder nor the names of its
|
|
// contributors may be used to endorse or promote products derived from this
|
|
// software without specific prior written permission.
|
|
//
|
|
// Third party software included in this distribution is subject to the
|
|
// additional license terms as defined in the /docs/licenses directory.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
|
|
//
|
|
// This is part of revision 2.4.2 of the AmbiqSuite Development Package.
|
|
//
|
|
//*****************************************************************************
|
|
|
|
#include "am_mcu_apollo.h"
|
|
#include "am_bsp.h"
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// LEDs
|
|
//
|
|
//*****************************************************************************
|
|
am_devices_led_t am_bsp_psLEDs[AM_BSP_NUM_LEDS] =
|
|
{
|
|
{AM_BSP_GPIO_LED0, AM_DEVICES_LED_ON_LOW},
|
|
{AM_BSP_GPIO_LED1, AM_DEVICES_LED_ON_LOW},
|
|
{AM_BSP_GPIO_LED2, AM_DEVICES_LED_ON_LOW},
|
|
{AM_BSP_GPIO_LED3, AM_DEVICES_LED_ON_LOW},
|
|
{AM_BSP_GPIO_LED4, AM_DEVICES_LED_ON_LOW},
|
|
};
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Buttons.
|
|
//
|
|
//*****************************************************************************
|
|
am_devices_button_t am_bsp_psButtons[AM_BSP_NUM_BUTTONS] =
|
|
{
|
|
AM_DEVICES_BUTTON(AM_BSP_GPIO_BUTTON0, AM_DEVICES_BUTTON_NORMAL_HIGH),
|
|
AM_DEVICES_BUTTON(AM_BSP_GPIO_BUTTON1, AM_DEVICES_BUTTON_NORMAL_HIGH),
|
|
AM_DEVICES_BUTTON(AM_BSP_GPIO_BUTTON2, AM_DEVICES_BUTTON_NORMAL_HIGH),
|
|
};
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// IOM MISO Pin assignments.
|
|
//
|
|
//*****************************************************************************
|
|
//
|
|
// Table of SPI pins - used by am_bsp_iom_enable() to make sure the MISO input
|
|
// is enabled (for power optimization).
|
|
//
|
|
#define AM_BSP_GPIO_UNDEF 0xDEADBEEF
|
|
static uint32_t g_SPIpins[AM_REG_IOMSTR_NUM_MODULES][2] =
|
|
{
|
|
{AM_BSP_GPIO_IOM0_MISO, AM_BSP_GPIO_CFG_IOM0_MISO},
|
|
{AM_BSP_GPIO_IOM1_MISO, AM_BSP_GPIO_CFG_IOM1_MISO},
|
|
};
|
|
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Enable the necessary pins for the given IOM module.
|
|
//!
|
|
//! @param ui32Module is the module number of the IOM interface to be used.
|
|
//!
|
|
//! Uses BSP pin definitions to configure the correct interface for the
|
|
//! selected IOM module.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_iom_spi_pins_enable(uint32_t ui32Module)
|
|
{
|
|
switch(ui32Module)
|
|
{
|
|
#ifdef AM_BSP_GPIO_IOM0_SCK
|
|
case 0:
|
|
am_bsp_pin_enable(IOM0_SCK);
|
|
am_bsp_pin_enable(IOM0_MISO);
|
|
am_bsp_pin_enable(IOM0_MOSI);
|
|
break;
|
|
#endif
|
|
|
|
#ifdef AM_BSP_GPIO_IOM1_SCK
|
|
case 1:
|
|
am_bsp_pin_enable(IOM1_SCK);
|
|
am_bsp_pin_enable(IOM1_MISO);
|
|
am_bsp_pin_enable(IOM1_MOSI);
|
|
break;
|
|
#endif
|
|
//
|
|
// If we get here, the caller's selected IOM interface couldn't be
|
|
// found in the BSP GPIO definitions. Halt program execution for
|
|
// debugging.
|
|
//
|
|
default:
|
|
while(1);
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Disable the necessary pins for the given IOM module.
|
|
//!
|
|
//! @param ui32Module is the module number of the IOM interface to be used.
|
|
//!
|
|
//! Uses BSP pin definitions to configure the correct interface for the
|
|
//! selected IOM module.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_iom_spi_pins_disable(uint32_t ui32Module)
|
|
{
|
|
switch(ui32Module)
|
|
{
|
|
#ifdef AM_BSP_GPIO_IOM0_SCK
|
|
case 0:
|
|
am_bsp_pin_disable(IOM0_SCK);
|
|
am_bsp_pin_disable(IOM0_MISO);
|
|
am_bsp_pin_disable(IOM0_MOSI);
|
|
break;
|
|
#endif
|
|
|
|
#ifdef AM_BSP_GPIO_IOM1_SCK
|
|
case 1:
|
|
am_bsp_pin_disable(IOM1_SCK);
|
|
am_bsp_pin_disable(IOM1_MISO);
|
|
am_bsp_pin_disable(IOM1_MOSI);
|
|
break;
|
|
#endif
|
|
//
|
|
// If we get here, the caller's selected IOM interface couldn't be
|
|
// found in the BSP GPIO definitions. Halt program execution for
|
|
// debugging.
|
|
//
|
|
default:
|
|
while(1);
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Enable the IOM & the MISO input in SPI mode if used, for the given IOM module
|
|
//!
|
|
//! @param ui32Module is the module number of the IOM interface to be used.
|
|
//!
|
|
//! Uses during operation of the IOM to conserve power.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_iom_enable(uint32_t ui32Module)
|
|
{
|
|
am_hal_iom_enable(ui32Module);
|
|
|
|
// Check that the MISO pin is defined in BSP and we are in SPI mode.
|
|
if ( (AM_BSP_GPIO_UNDEF != g_SPIpins[ui32Module][0] ) &&
|
|
(1 == AM_BFRn(IOMSTR, ui32Module, CFG, IFCSEL) ) )
|
|
{
|
|
am_hal_gpio_pin_config(g_SPIpins[ui32Module][0],
|
|
g_SPIpins[ui32Module][1]);
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Disable the IOM & the MISO input in SPI mode if used, for the given IOM module
|
|
//!
|
|
//! @param ui32Module is the module number of the IOM interface to be used.
|
|
//!
|
|
//! Uses during operation of the IOM to conserve power.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_iom_disable(uint32_t ui32Module)
|
|
{
|
|
//
|
|
// Check to make sure that MISO is defined and is actually being used.
|
|
//
|
|
if ( (AM_BSP_GPIO_UNDEF != g_SPIpins[ui32Module][0] ) &&
|
|
(1 == AM_BFRn(IOMSTR, ui32Module, CFG, IFCSEL) ) )
|
|
{
|
|
if ( am_hal_gpio_pin_config_read(g_SPIpins[ui32Module][0]) ==
|
|
(g_SPIpins[ui32Module][1]) )
|
|
{
|
|
am_hal_gpio_pin_config(g_SPIpins[ui32Module][0],
|
|
(g_SPIpins[ui32Module][1] &
|
|
(~AM_HAL_PIN_DIR_INPUT)));
|
|
}
|
|
}
|
|
am_hal_iom_disable(ui32Module);
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Enable the necessary pins for the given IOM module in I2C mode.
|
|
//!
|
|
//! @param ui32Module is the module number of the IOM interface to be used.
|
|
//!
|
|
//! Uses BSP pin definitions to configure the correct interface for the
|
|
//! selected IOM module to work in I2C mode.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
#if defined(AM_BSP_GPIO_IOM0_SCL) || defined(AM_BSP_GPIO_IOM1_SCL)
|
|
void
|
|
am_bsp_iom_i2c_pins_enable(uint32_t ui32Module)
|
|
{
|
|
switch(ui32Module)
|
|
{
|
|
#ifdef AM_BSP_GPIO_IOM0_SCL
|
|
case 0:
|
|
//
|
|
// Set pins high to prevent bus dips.
|
|
//
|
|
am_hal_gpio_out_bit_set(AM_BSP_GPIO_IOM0_SCL);
|
|
am_hal_gpio_out_bit_set(AM_BSP_GPIO_IOM0_SDA);
|
|
|
|
am_bsp_pin_enable(IOM0_SCL);
|
|
am_bsp_pin_enable(IOM0_SDA);
|
|
break;
|
|
#endif
|
|
|
|
#ifdef AM_BSP_GPIO_IOM1_SCL
|
|
case 1:
|
|
//
|
|
// Set pins high to prevent bus dips.
|
|
//
|
|
am_hal_gpio_out_bit_set(AM_BSP_GPIO_IOM1_SCL);
|
|
am_hal_gpio_out_bit_set(AM_BSP_GPIO_IOM1_SDA);
|
|
|
|
am_bsp_pin_enable(IOM1_SCL);
|
|
am_bsp_pin_enable(IOM1_SDA);
|
|
break;
|
|
#endif
|
|
|
|
//
|
|
// If we get here, the caller's selected IOM interface couldn't be
|
|
// found in the BSP GPIO definitions. Halt program execution for
|
|
// debugging.
|
|
//
|
|
default:
|
|
while(1);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Disable the necessary pins for the given IOM module in I2C mode.
|
|
//!
|
|
//! @param ui32Module is the module number of the IOM interface to be used.
|
|
//!
|
|
//! Uses BSP pin definitions to configure the correct interface for the
|
|
//! selected IOM module to work in I2C mode.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
#if defined(AM_BSP_GPIO_IOM0_SCL) || defined(AM_BSP_GPIO_IOM1_SCL)
|
|
void
|
|
am_bsp_iom_i2c_pins_disable(uint32_t ui32Module)
|
|
{
|
|
switch(ui32Module)
|
|
{
|
|
#ifdef AM_BSP_GPIO_IOM0_SCL
|
|
case 0:
|
|
am_bsp_pin_disable(IOM0_SCL);
|
|
am_bsp_pin_disable(IOM0_SDA);
|
|
break;
|
|
#endif
|
|
|
|
#ifdef AM_BSP_GPIO_IOM1_SCL
|
|
case 1:
|
|
am_bsp_pin_disable(IOM1_SCL);
|
|
am_bsp_pin_disable(IOM1_SDA);
|
|
break;
|
|
#endif
|
|
//
|
|
// If we get here, the caller's selected IOM interface couldn't be
|
|
// found in the BSP GPIO definitions. Halt program execution for
|
|
// debugging.
|
|
//
|
|
default:
|
|
while(1);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Prepare the MCU for low power operation.
|
|
//!
|
|
//! This function enables several power-saving features of the MCU, and
|
|
//! disables some of the less-frequently used peripherals. It also sets the
|
|
//! system clock to 24 MHz.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_low_power_init(void)
|
|
{
|
|
//
|
|
// Enable internal buck converters.
|
|
//
|
|
am_hal_mcuctrl_bucks_enable();
|
|
|
|
//
|
|
// Turn off the voltage comparator as this is enabled on reset.
|
|
//
|
|
am_hal_vcomp_disable();
|
|
|
|
//
|
|
// Run the RTC off the LFRC.
|
|
//
|
|
am_hal_rtc_osc_select(AM_HAL_RTC_OSC_LFRC);
|
|
|
|
//
|
|
// Stop the XTAL.
|
|
//
|
|
am_hal_clkgen_osc_stop(AM_HAL_CLKGEN_OSC_XT);
|
|
|
|
//
|
|
// Disable the RTC.
|
|
//
|
|
am_hal_rtc_osc_disable();
|
|
|
|
//
|
|
// Disable the bandgap.
|
|
//
|
|
am_hal_mcuctrl_bandgap_disable();
|
|
}
|
|
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Enable the TPIU and ITM for debug printf messages.
|
|
//!
|
|
//! This function enables TPIU registers for debug printf messages and enables
|
|
//! ITM GPIO pin to SWO mode. This function should be called after reset and
|
|
//! after waking up from deep sleep.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_debug_printf_enable(void)
|
|
{
|
|
am_hal_tpiu_config_t TPIUcfg;
|
|
|
|
if (g_ui32HALflags & AM_HAL_FLAGS_ITMSKIPENABLEDISABLE_M)
|
|
{
|
|
return;
|
|
}
|
|
//
|
|
// Enable the ITM and TPIU
|
|
//
|
|
TPIUcfg.ui32SetItmBaud = AM_HAL_TPIU_BAUD_1M;
|
|
am_hal_tpiu_enable(&TPIUcfg);
|
|
am_bsp_pin_enable(ITM_SWO);
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief Enable the TPIU and ITM for debug printf messages.
|
|
//!
|
|
//! This function disables TPIU registers for debug printf messages and
|
|
//! enables ITM GPIO pin to GPIO mode and prepares the MCU to go to deep sleep.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_debug_printf_disable(void)
|
|
{
|
|
if (g_ui32HALflags & AM_HAL_FLAGS_ITMSKIPENABLEDISABLE_M)
|
|
{
|
|
return;
|
|
}
|
|
am_hal_itm_not_busy();
|
|
am_hal_gpio_pin_config(AM_BSP_GPIO_ITM_SWO, AM_HAL_GPIO_OUTPUT);
|
|
am_hal_tpiu_disable();
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief ITM-based string print function.
|
|
//!
|
|
//! This function is used for printing a string via the ITM.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_itm_string_print(char *pcString)
|
|
{
|
|
am_hal_itm_print(pcString);
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! @brief UART-based string print function.
|
|
//!
|
|
//! This function is used for printing a string via the UART, which for some
|
|
//! MCU devices may be multi-module.
|
|
//!
|
|
//! @return None.
|
|
//
|
|
//*****************************************************************************
|
|
void
|
|
am_bsp_uart_string_print(char *pcString)
|
|
{
|
|
am_hal_uart_string_transmit_polled(0, pcString);
|
|
}
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// End Doxygen group.
|
|
//! @}
|
|
//
|
|
//*****************************************************************************
|