PWM.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 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>
#include <stddef.h>

#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

/* Add PWM_CMD_<commands> here */

typedef struct PWM_Config      *PWM_Handle;

typedef enum PWM_DutyMode {
    PWM_DUTY_COUNTS = 0,
    PWM_DUTY_SCALAR,
    PWM_DUTY_TIME
} PWM_DutyMode;

typedef enum PWM_Polarity {
    PWM_POL_ACTIVE_HIGH = 0,  
    PWM_POL_ACTIVE_LOW  = 1   
} PWM_Polarity;

typedef struct PWM_Params {
    uint32_t     period;         
    PWM_DutyMode dutyMode;       
    PWM_Polarity polarity;       
    uintptr_t    custom;         
} PWM_Params;

typedef void         (*PWM_CloseFxn)             (PWM_Handle handle);

typedef int          (*PWM_ControlFxn)           (PWM_Handle handle,
                                                  unsigned int cmd,
                                                  void *arg);

typedef unsigned int (*PWM_GetPeriodCountsFxn)   (PWM_Handle handle);

typedef unsigned int (*PWM_GetPeriodMicroSecsFxn)(PWM_Handle handle);

typedef void         (*PWM_InitFxn)              (PWM_Handle handle);

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

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

typedef struct PWM_FxnTable {
    PWM_CloseFxn                 closeFxn;

    PWM_ControlFxn               controlFxn;

    PWM_GetPeriodCountsFxn       getPeriodCountsFxn;

    PWM_GetPeriodMicroSecsFxn    getPeriodMicroSecsFxn;

    PWM_InitFxn                  initFxn;

    PWM_OpenFxn                  openFxn;

    PWM_SetDutyFxn               setDutyFxn;
} 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 PWM_control(PWM_Handle handle, unsigned int cmd, void *arg);

extern unsigned int PWM_getPeriodCounts(PWM_Handle handle);

extern unsigned int PWM_getPeriodMicroSecs(PWM_Handle handle);

extern void PWM_init(void);

extern PWM_Handle PWM_open(unsigned int index, PWM_Params *params);

extern void PWM_Params_init(PWM_Params *params);

extern void PWM_setDuty(PWM_Handle handle, uint32_t duty);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_PWM__include */