98 lines
3.4 KiB
C
98 lines
3.4 KiB
C
|
/***********************************************************************************************//**
|
||
|
|
* \file cybsp.h
|
||
|
|
*
|
||
|
|
* \brief
|
||
|
|
* Basic API for setting up boards containing a Cypress MCU.
|
||
|
|
*
|
||
|
|
***************************************************************************************************
|
||
|
|
* \copyright
|
||
|
|
* Copyright 2018-2021 Cypress Semiconductor Corporation (an Infineon company) or
|
||
|
|
* an affiliate of Cypress Semiconductor Corporation
|
||
|
|
*
|
||
|
|
* SPDX-License-Identifier: Apache-2.0
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
**************************************************************************************************/
|
||
|
|
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#include "cy_result.h"
|
||
|
|
#include "cybsp_types.h"
|
||
|
|
#if defined(CYBSP_WIFI_CAPABLE) && defined(CY_USING_HAL)
|
||
|
|
#include "cyhal_sdio.h"
|
||
|
|
#endif
|
||
|
|
#if defined(COMPONENT_WICED_BLE) || defined(COMPONENT_WICED_DUALMODE)
|
||
|
|
#include "cybsp_bt_config.h"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \addtogroup group_bsp_errors Error Codes
|
||
|
|
* \{
|
||
|
|
* Error codes specific to the board.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** 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_errors */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \addtogroup group_bsp_functions Functions
|
||
|
|
* \{
|
||
|
|
* All functions exposed by the board.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Initialize all hardware on the board
|
||
|
|
* \returns CY_RSLT_SUCCESS if the board is successfully initialized, if there is
|
||
|
|
* a problem initializing any hardware it returns an error code specific
|
||
|
|
* to the hardware module that had a problem.
|
||
|
|
*/
|
||
|
|
cy_rslt_t cybsp_init(void);
|
||
|
|
|
||
|
|
#if defined(CYBSP_WIFI_CAPABLE) && defined(CY_USING_HAL)
|
||
|
|
|
||
|
|
#define CYBSP_WIFI_INTERFACE_TYPE CYBSP_SDIO_INTERFACE
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Get the initialized sdio object used for communicating with the WiFi Chip.
|
||
|
|
* \note This function should only be called after cybsp_init();
|
||
|
|
* \returns The initialized sdio object.
|
||
|
|
*/
|
||
|
|
cyhal_sdio_t* cybsp_get_wifi_sdio_obj(void);
|
||
|
|
#endif // defined(CYBSP_WIFI_CAPABLE)
|
||
|
|
|
||
|
|
#if defined(CYBSP_CUSTOM_SYSCLK_PM_CALLBACK)
|
||
|
|
//--------------------------------------------------------------------------------------------------
|
||
|
|
// cybsp_register_custom_sysclk_pm_callback
|
||
|
|
//
|
||
|
|
// Registers a power management callback that prepares the clock system for entering deep sleep mode
|
||
|
|
// and restore the clocks upon wakeup from deep sleep. The application should implement this
|
||
|
|
// function and define `CYBSP_CUSTOM_SYSCLK_PM_CALLBACK` if it needs to replace the default SysClk
|
||
|
|
// DeepSleep callback behavior with application specific logic.
|
||
|
|
// NOTE: This is called automatically as part of \ref cybsp_init
|
||
|
|
//--------------------------------------------------------------------------------------------------
|
||
|
|
cy_rslt_t cybsp_register_custom_sysclk_pm_callback(void);
|
||
|
|
#endif // defined(CYBSP_CUSTOM_SYSCLK_PM_CALLBACK)
|
||
|
|
|
||
|
|
/** \} group_bsp_functions */
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif // __cplusplus
|