PWM.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_PWM__include
#define ti_drivers_PWM__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#define PWM_DUTY_FRACTION_MAX        ((uint32_t) ~0)

#define PWM_CMD_RESERVED             (32)

#define PWM_STATUS_RESERVED          (-32)

#define PWM_STATUS_SUCCESS           (0)

#define PWM_STATUS_ERROR             (-1)

#define PWM_STATUS_UNDEFINEDCMD      (-2)

#define PWM_STATUS_INVALID_PERIOD    (-3)

#define PWM_STATUS_INVALID_DUTY      (-4)

typedef enum PWM_Period_Units_ {
    PWM_PERIOD_US,    /* Period in microseconds */
    PWM_PERIOD_HZ,    /* Period in (reciprocal) Hertz
                         (for example 2MHz = 0.5us period) */
    PWM_PERIOD_COUNTS /* Period in timer counts */
} PWM_Period_Units;

typedef enum PWM_Duty_Units_ {
    PWM_DUTY_US,       /* Duty cycle in microseconds */
    PWM_DUTY_FRACTION, /* Duty as a fractional part of PWM_DUTY_FRACTION_MAX */
    PWM_DUTY_COUNTS    /* Duty in timer counts  */
} PWM_Duty_Units;

typedef enum PWM_IdleLevel_ {
    PWM_IDLE_LOW  = 0,
    PWM_IDLE_HIGH = 1,
} PWM_IdleLevel;

typedef struct PWM_Params_ {
    PWM_Period_Units periodUnits; 
    uint32_t         periodValue; 
    PWM_Duty_Units   dutyUnits;   
    uint32_t         dutyValue;   
    PWM_IdleLevel    idleLevel;   
    void            *custom;      
} PWM_Params;

typedef struct PWM_Config_ *PWM_Handle;

typedef void (*PWM_CloseFxn) (PWM_Handle handle);

typedef int_fast16_t (*PWM_ControlFxn) (PWM_Handle handle, uint_fast16_t cmd,
    void *arg);
typedef void (*PWM_InitFxn) (PWM_Handle handle);

typedef PWM_Handle (*PWM_OpenFxn) (PWM_Handle handle, PWM_Params *params);

typedef int_fast16_t (*PWM_SetDutyFxn) (PWM_Handle handle,
    uint32_t duty);

typedef int_fast16_t (*PWM_SetPeriodFxn) (PWM_Handle handle,
    uint32_t period);

typedef void (*PWM_StartFxn) (PWM_Handle handle);

typedef void (*PWM_StopFxn) (PWM_Handle handle);

typedef struct PWM_FxnTable_ {
    PWM_CloseFxn     closeFxn;
    PWM_ControlFxn   controlFxn;
    PWM_InitFxn      initFxn;
    PWM_OpenFxn      openFxn;
    PWM_SetDutyFxn   setDutyFxn;
    PWM_SetPeriodFxn setPeriodFxn;
    PWM_StartFxn     startFxn;
    PWM_StopFxn      stopFxn;
} PWM_FxnTable;

typedef struct PWM_Config_ {
    PWM_FxnTable const *fxnTablePtr;
    void               *object;
    void         const *hwAttrs;
} PWM_Config;

extern void PWM_close(PWM_Handle handle);

extern int_fast16_t PWM_control(PWM_Handle handle, uint_fast16_t cmd,
    void *arg);

extern void PWM_init(void);

extern PWM_Handle PWM_open(uint_least8_t index, PWM_Params *params);

extern void PWM_Params_init(PWM_Params *params);

extern int_fast16_t PWM_setDuty(PWM_Handle handle, uint32_t duty);

extern int_fast16_t PWM_setPeriod(PWM_Handle handle, uint32_t period);

extern void PWM_start(PWM_Handle handle);

extern void PWM_stop(PWM_Handle handle);

#ifdef __cplusplus
}
#endif
#endif /* ti_drivers_PWM__include */