PWMTimerCC32XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2017, 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_PWMTimerCC32XX__include
#define ti_driver_pwm_PWMTimerCC32XX__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <ti/drivers/PWM.h>

/*
 *  PWMTimer port/pin defines for pin configuration.
 *
 *  The timer id (0, 1, 2, or 3) is stored in bits 31 - 28
 *  The timer half (0 = A, 1 = B) is stored in bits 27 - 24
 *  The GPIO port (0, 1, 2, or 3) is stored in bits 23 - 20
 *  The GPIO pin index within the port (0 - 7) is stored in bits 19 - 16
 *  The pin mode is stored in bits 11 - 8
 *  The pin number is stored in bits 7 - 0
 *
 *
 *    31 - 28     27 - 24      23 - 20        19 - 16       11 - 8   7 - 0
 *  -----------------------------------------------------------------------
 *  | Timer id | Timer half | GPIO port | GPIO pin index | pin mode | pin |
 *  -----------------------------------------------------------------------
 *
 *  The CC32XX has fixed GPIO assignments and pin modes for a given pin.
 *  A PWM pin mode for a given pin has a fixed timer/timer-half.
 */
#define PWMTimerCC32XX_T0A  (0x00 << 24)
#define PWMTimerCC32XX_T0B  (0x01 << 24)
#define PWMTimerCC32XX_T1A  (0x10 << 24)
#define PWMTimerCC32XX_T1B  (0x11 << 24)
#define PWMTimerCC32XX_T2A  (0x20 << 24)
#define PWMTimerCC32XX_T2B  (0x21 << 24)
#define PWMTimerCC32XX_T3A  (0x30 << 24)
#define PWMTimerCC32XX_T3B  (0x31 << 24)

#define PWMTimerCC32XX_GPIO0  (0x00 << 16)
#define PWMTimerCC32XX_GPIO1  (0x01 << 16)
#define PWMTimerCC32XX_GPIO2  (0x02 << 16)
#define PWMTimerCC32XX_GPIO3  (0x03 << 16)
#define PWMTimerCC32XX_GPIO4  (0x04 << 16)
#define PWMTimerCC32XX_GPIO5  (0x05 << 16)
#define PWMTimerCC32XX_GPIO6  (0x06 << 16)
#define PWMTimerCC32XX_GPIO7  (0x07 << 16)
#define PWMTimerCC32XX_GPIO8  (0x10 << 16)
#define PWMTimerCC32XX_GPIO9  (0x11 << 16)
#define PWMTimerCC32XX_GPIO10  (0x12 << 16)
#define PWMTimerCC32XX_GPIO11  (0x13 << 16)
#define PWMTimerCC32XX_GPIO12  (0x14 << 16)
#define PWMTimerCC32XX_GPIO13  (0x15 << 16)
#define PWMTimerCC32XX_GPIO14  (0x16 << 16)
#define PWMTimerCC32XX_GPIO15  (0x17 << 16)
#define PWMTimerCC32XX_GPIO16  (0x20 << 16)
#define PWMTimerCC32XX_GPIO17  (0x21 << 16)
#define PWMTimerCC32XX_GPIO18  (0x22 << 16)
#define PWMTimerCC32XX_GPIO19  (0x23 << 16)
#define PWMTimerCC32XX_GPIO20  (0x24 << 16)
#define PWMTimerCC32XX_GPIO21  (0x25 << 16)
#define PWMTimerCC32XX_GPIO22  (0x26 << 16)
#define PWMTimerCC32XX_GPIO23  (0x27 << 16)
#define PWMTimerCC32XX_GPIO24  (0x30 << 16)
#define PWMTimerCC32XX_GPIO25  (0x31 << 16)
#define PWMTimerCC32XX_GPIO26  (0x32 << 16)
#define PWMTimerCC32XX_GPIO27  (0x33 << 16)
#define PWMTimerCC32XX_GPIO28  (0x34 << 16)
#define PWMTimerCC32XX_GPIO29  (0x35 << 16)
#define PWMTimerCC32XX_GPIO30  (0x36 << 16)
#define PWMTimerCC32XX_GPIO31  (0x37 << 16)

#define PWMTimerCC32XX_GPIONONE  (0xFF << 16)

#define PWMTimerCC32XX_PIN_01  PWMTimerCC32XX_T3A | PWMTimerCC32XX_GPIO10 | 0x0300 
#define PWMTimerCC32XX_PIN_02  PWMTimerCC32XX_T3B | PWMTimerCC32XX_GPIO11 | 0x0301 
#define PWMTimerCC32XX_PIN_17  PWMTimerCC32XX_T0A | PWMTimerCC32XX_GPIO24 | 0x0510 
#define PWMTimerCC32XX_PIN_19  PWMTimerCC32XX_T1B | PWMTimerCC32XX_GPIO_NONE | 0x0812 
#define PWMTimerCC32XX_PIN_21  PWMTimerCC32XX_T1A | PWMTimerCC32XX_GPIO25 | 0x0914 
#define PWMTimerCC32XX_PIN_64  PWMTimerCC32XX_T2B | PWMTimerCC32XX_GPIO9 | 0x033F  
/* Add PWMTimerCC32XX_STATUS_* macros here */

/* Add PWMTimerCC32XX_CMD_* macros here */

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

typedef struct PWMTimerCC32XX_HWAttrsV2 {
    uint32_t pwmPin;                    
} PWMTimerCC32XX_HWAttrsV2;

typedef struct PWMTimerCC32XX_Object {
    Power_NotifyObj  postNotify;
    uint32_t         duty;              /* Current duty cycle in Duty_Unites */
    uint32_t         period;            /* Current period PERIOD_Units */
    PWM_Duty_Units   dutyUnits;         /* Current duty cycle unit */
    PWM_Period_Units periodUnits;       /* Current period unit */
    PWM_IdleLevel    idleLevel;         /* PWM idle level when stopped / not started */
    bool             pwmStarted;        /* Used to gate Power_set/releaseConstraint() calls */
    bool             isOpen;            /* open flag used to check if PWM is opened */
} PWMTimerCC32XX_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_driver_pwm_PWMTimerCC32XX__include */