Initial commit of firmware
This commit is contained in:
88
Libs/platform/service/device_init/inc/sl_device_init_dcdc.h
Normal file
88
Libs/platform/service/device_init/inc/sl_device_init_dcdc.h
Normal file
@@ -0,0 +1,88 @@
|
||||
/***************************************************************************//**
|
||||
* @file
|
||||
* @brief Device initialization for DC/DC converter.
|
||||
*******************************************************************************
|
||||
* # License
|
||||
* <b>Copyright 2019 Silicon Laboratories Inc. www.silabs.com</b>
|
||||
*******************************************************************************
|
||||
*
|
||||
* SPDX-License-Identifier: Zlib
|
||||
*
|
||||
* The licensor of this software is Silicon Laboratories Inc.
|
||||
*
|
||||
* This software is provided 'as-is', without any express or implied
|
||||
* warranty. In no event will the authors be held liable for any damages
|
||||
* arising from the use of this software.
|
||||
*
|
||||
* Permission is granted to anyone to use this software for any purpose,
|
||||
* including commercial applications, and to alter it and redistribute it
|
||||
* freely, subject to the following restrictions:
|
||||
*
|
||||
* 1. The origin of this software must not be misrepresented; you must not
|
||||
* claim that you wrote the original software. If you use this software
|
||||
* in a product, an acknowledgment in the product documentation would be
|
||||
* appreciated but is not required.
|
||||
* 2. Altered source versions must be plainly marked as such, and must not be
|
||||
* misrepresented as being the original software.
|
||||
* 3. This notice may not be removed or altered from any source distribution.
|
||||
*
|
||||
******************************************************************************/
|
||||
#ifndef SL_DEVICE_INIT_DCDC_H
|
||||
#define SL_DEVICE_INIT_DCDC_H
|
||||
|
||||
#include "sl_status.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @addtogroup device_init
|
||||
* @{
|
||||
* @addtogroup device_init_dcdc DCDC Initialization
|
||||
* @brief Initialize the DC-DC converter.
|
||||
* @details
|
||||
* Configures the DC-DC converter. If the DC-DC converter is not to be
|
||||
* used, the configuration option `SL_DEVICE_INIT_DCDC_ENABLE` can be disabled,
|
||||
* and the converter will be powered off. On Series 1 devices, this option
|
||||
* should only be used when DVDD is externally powered.
|
||||
*
|
||||
* To enable the bypass switch and short the DC-DC converter input to
|
||||
* the DC-DC output, set the configuration option `SL_DEVICE_INIT_DCDC_BYPASS`.
|
||||
*
|
||||
* See **AN0948 Power Configurations and DC-DC** for further details about DC-DC
|
||||
* converter configuration and operation.
|
||||
*
|
||||
* - Series 1: [AN0948](https://www.silabs.com/documents/public/application-notes/an0948-power-configurations-and-dcdc.pdf)
|
||||
* - Series 2: [AN0948.2](https://www.silabs.com/documents/public/application-notes/an0948.2-efr32-series-2-power-configurations-and-dcdc.pdf)
|
||||
* @{
|
||||
*/
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Defines
|
||||
|
||||
/// @brief DC/DC Converter Type
|
||||
#define SL_DEVICE_INIT_DCDC_TYPE_BUCK 0 ///< Buck Type
|
||||
#define SL_DEVICE_INIT_DCDC_TYPE_BOOST 1 ///< Boost Type
|
||||
|
||||
/**
|
||||
* Initialize DCDC
|
||||
*
|
||||
* @details
|
||||
* Configure and start the DCDC
|
||||
*
|
||||
* @return Status code
|
||||
* @retval SL_STATUS_OK DC-DC converter initialized successfully
|
||||
*/
|
||||
sl_status_t sl_device_init_dcdc(void);
|
||||
|
||||
/**
|
||||
* @} device_init_dcdc
|
||||
* @} device_init
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // SL_DEVICE_INIT_DCDC_H
|
||||
Reference in New Issue
Block a user