Simplify BSP contents

Remove some (Cypress-proprietary) BSP interfaces and hardware initialization
from the BSPs which is better implemented by a library or application firmware.
Move some remaining functionality from common to the individual targets.

Author: Kyle Kearney

targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062S2_43012/cybsp.c

@@ -1,9 +1,9 @@
 /***************************************************************************//**
-* \file CY8CKIT-062S2-43012/cybsp.c
+* \file cybsp.c
 *
 * Description:
-* Provides APIs for interacting with the hardware contained on the Cypress
-* CY8CKIT-062S2-43012 pioneer kit.
+* Provides initialization code for starting up the hardware contained on the 
+* Cypress board.
 *
 ********************************************************************************
 * \copyright
@@ -32,6 +32,15 @@
 extern "C" {
 #endif
 
+/* The sysclk deep sleep callback is recommended to be the last callback that
+* is executed before entry into deep sleep mode and the first one upon 
+* exit the deep sleep mode.
+* Doing so minimizes the time spent on low power mode entry and exit.
+*/
+#ifndef CYBSP_SYSCLK_PM_CALLBACK_ORDER
+    #define CYBSP_SYSCLK_PM_CALLBACK_ORDER  (255u)
+#endif
+
 #if defined(CYBSP_WIFI_CAPABLE)
 static cyhal_sdio_t sdio_obj;
 
@@ -41,6 +50,29 @@ cyhal_sdio_t* cybsp_get_wifi_sdio_obj(void)
 }
 #endif
 
+/**
+ * Registers a power management callback that prepares the clock system
+ * for entering deep sleep mode and restore the clocks upon wakeup from deep sleep.
+ * NOTE: This is called automatically as part of \ref cybsp_init
+ */
+static cy_rslt_t cybsp_register_sysclk_pm_callback(void)
+{
+    cy_rslt_t result = CY_RSLT_SUCCESS;
+    static cy_stc_syspm_callback_params_t cybsp_sysclk_pm_callback_param = {NULL, NULL};
+    static cy_stc_syspm_callback_t cybsp_sysclk_pm_callback = {
+        .callback = &Cy_SysClk_DeepSleepCallback,
+        .type = CY_SYSPM_DEEPSLEEP,
+        .callbackParams = &cybsp_sysclk_pm_callback_param,
+        .order = CYBSP_SYSCLK_PM_CALLBACK_ORDER
+    };
+
+    if (!Cy_SysPm_RegisterCallback(&cybsp_sysclk_pm_callback))
+    {
+        result = CYBSP_RSLT_ERR_SYSCLK_PM_CALLBACK;
+    }
+    return result;
+}
+
 cy_rslt_t cybsp_init(void)
 {
     /* Setup hardware manager to track resource usage then initialize all system (clock/power) board configuration */
@@ -52,38 +84,6 @@ cy_rslt_t cybsp_init(void)
         result = cybsp_register_sysclk_pm_callback();
     }
 
-#ifndef __MBED__
-    if (CY_RSLT_SUCCESS == result)
-    {
-        /* Initialize User LEDs */
-        /* Reserves: CYBSP_USER_LED1 */
-        result |= cybsp_led_init(CYBSP_USER_LED1);
-        /* Reserves: CYBSP_USER_LED2 */
-        result |= cybsp_led_init(CYBSP_USER_LED2);
-        /* Reserves: CYBSP_USER_LED3 */
-        result |= cybsp_led_init(CYBSP_USER_LED3);
-        /* Reserves: CYBSP_USER_LED4 */
-        result |= cybsp_led_init(CYBSP_USER_LED4);
-        /* Reserves: CYBSP_USER_LED5 */
-        result |= cybsp_led_init(CYBSP_USER_LED5);
-        /* Initialize User Buttons */
-        /* Reserves: CYBSP_USER_BTN1 */
-        result |= cybsp_btn_init(CYBSP_USER_BTN1);
-        /* Reserves: CYBSP_USER_BTN2 */
-        result |= cybsp_btn_init(CYBSP_USER_BTN2);
-
-        CY_ASSERT(CY_RSLT_SUCCESS == result);
-
-        /* Initialize retargetting stdio to 'DEBUG_UART' peripheral */
-        if (CY_RSLT_SUCCESS == result)
-        {
-           /* Reserves: CYBSP_DEBUG_UART_RX, CYBSP_DEBUG_UART_TX, CYBSP_DEBUG_UART_RTS, CYBSP_DEBUG_UART_CTS
-            *    corresponding SCB instance and one of available clock dividers */
-            result = cybsp_retarget_init();
-        }
-    }
-#endif /* __MBED__ */
-
 #if defined(CYBSP_WIFI_CAPABLE)
     /* Initialize SDIO interface. This must be done before other HAL API calls as some SDIO implementations require
      * specific peripheral instances.
@@ -107,8 +107,9 @@ cy_rslt_t cybsp_init(void)
 #endif /* defined(CYBSP_WIFI_CAPABLE) */
 
     /* CYHAL_HWMGR_RSLT_ERR_INUSE error code could be returned if any needed for BSP resource was reserved by
-    *   user previously. Please review the Device Configurator (design.modus) and the BSP reservation list
-    *   (cyreservedresources.list) to make sure no resources are reserved by both. */
+     * user previously. Please review the Device Configurator (design.modus) and the BSP reservation list
+     * (cyreservedresources.list) to make sure no resources are reserved by both.
+     */
     return result;
 }
 

targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062S2_43012/cybsp.h

@@ -1,9 +1,8 @@
 /***************************************************************************//**
-* \file CY8CKIT-062S2-43012/cybsp.h
+* \file cybsp.h
 *
-* Description:
-* Provides APIs for interacting with the hardware contained on the Cypress
-* CY8CKIT-062S2-43012 pioneer kit.
+* \brief
+* Basic API for setting up boards containing a Cypress MCU.
 *
 ********************************************************************************
 * \copyright
@@ -25,21 +24,25 @@
 
 #pragma once
 
+#include "cy_result.h"
 #include "cybsp_types.h"
-#include "cybsp_core.h"
 #if defined(CYBSP_WIFI_CAPABLE)
 #include "cyhal_sdio.h"
 #endif
-#ifndef __MBED__
-#include "cybsp_retarget.h"
-#include "cybsp_serial_flash.h"
-#include "cybsp_rgb_led.h"
-#endif /* __MBED__ */
 
 #if defined(__cplusplus)
 extern "C" {
 #endif
 
+/**
+* \addtogroup group_bsp_macros Macros
+* \{
+*/
+
+/** Failed to configure sysclk power management callback */
+#define CYBSP_RSLT_ERR_SYSCLK_PM_CALLBACK  (CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_BSP, 0))
+
+/** \} group_bsp_macros */
 
 /**
 * \addtogroup group_bsp_functions Functions