hal_pwm.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _HAL_PWM_H_
#define _HAL_PWM_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "hal_target.h"
#include "hal_ll_tim.h"
 
#define HAL_PWM_MIN_DUTY_RATIO 0 
#define HAL_PWM_MAX_DUTY_RATIO 1 
typedef struct
{
    handle_t *hal_pwm_handle; 
    handle_t *drv_pwm_handle; 
    bool init_state;          
} hal_pwm_handle_register_t;
 
typedef struct
{
    hal_pin_name_t pin; 
    uint32_t freq_hz;   
} hal_pwm_config_t;
 
typedef struct
{
    handle_t handle;         
    hal_pwm_config_t config; 
} hal_pwm_t;
 
typedef enum
{
    HAL_PWM_SUCCESS = 0,  
    HAL_PWM_MODULE_ERROR, 
    HAL_PWM_WRONG_PIN,    
    HAL_PWM_ERROR = (-1) 
} hal_pwm_err_t;
 
void hal_pwm_configure_default( hal_pwm_config_t *config );
 
err_t hal_pwm_open( handle_t *handle, bool hal_obj_open_state );
 
err_t hal_pwm_set_freq( handle_t *handle, hal_pwm_config_t *config );
 
err_t hal_pwm_start( handle_t *handle );
 
err_t hal_pwm_set_duty( handle_t *handle, float duty_ratio );
 
err_t hal_pwm_stop( handle_t *handle );
 
err_t hal_pwm_close( handle_t *handle );
 
 // halpwmgroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_PWM_H_
// ------------------------------------------------------------------------- END