PWMTiva.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_driver_pwm_PWMTiva__include
#define ti_driver_pwm_PWMTiva__include

#ifdef __cplusplus
extern "C" {
#endif

#include <ti/drivers/PWM.h>

/* Add PWMTiva_STATUS_* macros here */

#define PWMTiva_CMD_CHANGE_GEN_PERIOD        PWM_CMD_RESERVED + 0

/* BACKWARDS COMPATIBILITY */
#define PWMTiva_CHANGE_GEN_PERIOD  PWMTiva_CMD_CHANGE_GEN_PERIOD
/* BACKWARDS COMPATIBILITY */

/* Number of PWM peripherals available on a device */
#define PWMTiva_NUM_PWM_PERIPHERALS      2

/* Number of signal generator blocks per PWM peripheral */
#define PWMTiva_NUM_PWM_GENERATORS       4

/* PWM function table pointer */
extern const PWM_FxnTable PWMTiva_fxnTable;

typedef struct PWMTiva_HWAttrs {
    uint32_t baseAddr;                  
    uint32_t pwmOutput;                 
    uint32_t pwmGenOpts;                
} PWMTiva_HWAttrs;

typedef struct PWMTiva_Status {
    uint16_t genPeriods[PWMTiva_NUM_PWM_GENERATORS];
    uint8_t  cyclesPerMicroSec;
    uint8_t  prescalar;
    uint8_t  activeOutputs;
} PWMTiva_Status;

typedef struct PWMTiva_Object {
    PWMTiva_Status *pwmStatus;
    uint16_t        pwmDuty;
    uint8_t         pwmOutputBit;
    uint8_t         dutyMode;            /* Units in which duty is specified */
} PWMTiva_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_driver_pwm_PWMTiva__include */