drv_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 _DRV_PWM_H_
#define _DRV_PWM_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_name.h"
#include "hal_pwm.h"
 
typedef enum
{
    PWM_SUCCESS = 0,    
    PWM_ERROR = (-1)    
} pwm_err_t;
 
typedef struct
{
    pin_name_t pin;    
    uint32_t freq_hz;  
} pwm_config_t;
 
 
typedef struct
{
    handle_t handle;        
    pwm_config_t config;    
} pwm_t;
 
void pwm_configure_default( pwm_config_t *config );
 
err_t pwm_open( pwm_t *obj, pwm_config_t *config );
 
err_t pwm_set_freq( pwm_t *obj, uint32_t freq_hz );
 
err_t pwm_start( pwm_t *obj );
 
err_t pwm_set_duty( pwm_t *obj, float duty_ratio );
 
err_t pwm_stop( pwm_t *obj );
 
err_t pwm_close( pwm_t *obj );
 
 // drvpwmgroup
 // drvgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _DRV_PWM_H_
// ------------------------------------------------------------------------- END