iot_pwm.h

Go to the documentation of this file.

/*
 * Common IO - basic V1.0.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * 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, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */
 
#ifndef _IOT_PWM_H_
#define _IOT_PWM_H_
 
#define IOT_PWM_SUCCESS                   ( 0 )    
#define IOT_PWM_INVALID_VALUE             ( 1 )    
#define IOT_PWM_NOT_CONFIGURED            ( 2 )    
#define IOT_PWM_FUNCTION_NOT_SUPPORTED    ( 3 )    
typedef struct IotPwmConfig
{
    uint32_t ulPwmFrequency; 
    uint8_t ucPwmDutyCycle;  
    uint8_t ucPwmChannel;    
} IotPwmConfig_t;
 
struct                      IotPwmDescriptor;
 
typedef struct IotPwmDescriptor * IotPwmHandle_t;
 
IotPwmHandle_t iot_pwm_open( int32_t lPwmInstance );
 
int32_t iot_pwm_set_config( IotPwmHandle_t const pxPwmHandle,
                            const IotPwmConfig_t xConfig );
 
IotPwmConfig_t * iot_pwm_get_config( IotPwmHandle_t const pxPwmHandle );
 
int32_t iot_pwm_start( IotPwmHandle_t const pxPwmHandle );
 
int32_t iot_pwm_stop( IotPwmHandle_t const pxPwmHandle );
 
int32_t iot_pwm_close( IotPwmHandle_t const pxPwmHandle );
 
#endif /* ifndef _IOT_PWM_H_ */