ecap/v0/ecap.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Texas Instruments Incorporated
 *
 * 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 ECAP_V0_H_
#define ECAP_V0_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_ecap.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define ECAP_CAPTURE_MODE               (0U)
 
#define ECAP_APWM_MODE                  (1U)
 
#define ECAP_CAPTURE_EVENT_1            ((uint32_t)0x08U)
 
#define ECAP_CAPTURE_EVENT_2            ((uint32_t)0x0cU)
 
#define ECAP_CAPTURE_EVENT_3            ((uint32_t)0x10U)
 
#define ECAP_CAPTURE_EVENT_4            ((uint32_t)0x14U)
 
#define ECAP_CAPTURE_EVENT1_STOP        ((uint32_t)0x00U)
 
#define ECAP_CAPTURE_EVENT2_STOP        ((uint32_t)0x01U)
 
#define ECAP_CAPTURE_EVENT3_STOP        ((uint32_t)0x02U)
 
#define ECAP_CAPTURE_EVENT4_STOP        ((uint32_t)0x03U)
 
#define ECAP_APWM_ACTIVE_HIGH           (0U)
 
#define ECAP_APWM_ACTIVE_LOW            (1U)
 
#define ECAP_COUNTER_STOP               (0U)
 
#define ECAP_COUNTER_FREE_RUNNING       (1U)
 
#define ECAP_SYNC_IN_DISABLE            ((uint32_t)0U)
 
#define ECAP_ENABLE_COUNTER             ((uint32_t)1U)
 
#define ECAP_SYNC_IN                    ((uint32_t)0x0U)
 
#define ECAP_PRD_EQ                     ((uint32_t)0x1U)
 
#define ECAP_SYNC_OUT_DISABLE           ((uint32_t)0x2U)
 
#define ECAP_CEVT1_INT                  (ECAP_ECEINT_CEVT1)
 
#define ECAP_CEVT2_INT                  (ECAP_ECEINT_CEVT2)
 
#define ECAP_CEVT3_INT                  (ECAP_ECEINT_CEVT3)
 
#define ECAP_CEVT4_INT                  (ECAP_ECEINT_CEVT4)
 
#define ECAP_CNTOVF_INT                 (ECAP_ECEINT_CTROVF)
 
#define ECAP_PRDEQ_INT                  (ECAP_ECEINT_CTR_PRD)
 
#define ECAP_CMPEQ_INT                  (ECAP_ECEINT_CTR_CMP)
 
#define ECAP_GLOBAL_INT                 (ECAP_ECFLG_INT)
 
#define ECAP_CAPTURE_EVENT_RISING       (0U)
 
#define ECAP_CAPTURE_EVENT_FALLING      (1U)
 
#define ECAP_CAPTURE_EVENT_RESET_COUNTER_NO_RESET     (0U)
 
#define ECAP_CAPTURE_EVENT_RESET_COUNTER_RESET        (1U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void ECAP_captureLoadingEnable(uint32_t baseAddr);
 
void ECAP_captureLoadingDisable(uint32_t baseAddr);
 
void ECAP_prescaleConfig(uint32_t baseAddr, uint32_t prescale);
 
void ECAP_operatingModeSelect(uint32_t baseAddr, uint32_t modeSelect);
 
uint32_t ECAP_timeStampRead(uint32_t baseAddr, uint32_t capEvtFlag);
 
void ECAP_counterConfig(uint32_t baseAddr, uint32_t countVal);
 
void ECAP_captureEvtPolarityConfig(uint32_t baseAddr, uint32_t capEvt1pol,
                               uint32_t capEvt2pol, uint32_t capEvt3pol,
                               uint32_t capEvt4pol);
 
void ECAP_captureEvtCntrRstConfig(uint32_t baseAddr, uint32_t counterRst1,
                                 uint32_t counterRst2, uint32_t counterRst3,
                                 uint32_t counterRst4);
 
void ECAP_continousModeConfig(uint32_t baseAddr);
 
void ECAP_oneShotModeConfig(uint32_t baseAddr, uint32_t stopVal);
 
void ECAP_oneShotReArm(uint32_t baseAddr);
 
void ECAP_APWM_polarityConfig(uint32_t baseAddr, uint32_t flag);
 
void ECAP_counterControl(uint32_t baseAddr, uint32_t flag);
 
void ECAP_syncInOutSelect(uint32_t baseAddr, uint32_t syncIn, uint32_t syncOut);
 
void ECAP_APWM_captureConfig(uint32_t baseAddr, uint32_t compareVal, uint32_t periodVal);
 
void ECAP_APWM_shadowCaptureConfig(uint32_t baseAddr, uint32_t compareVal, uint32_t periodVal);
 
void ECAP_counterPhaseValConfig(uint32_t baseAddr, uint32_t cntPhaseVal);
 
void ECAP_globalIntrClear(uint32_t baseAddr);
 
void ECAP_intrEnable(uint32_t baseAddr, uint32_t flag);
 
void ECAP_intrDisable(uint32_t baseAddr, uint32_t flag);
 
uint32_t ECAP_getIntrStatus(uint32_t baseAddr, uint32_t flag);
 
void ECAP_intrStatusClear(uint32_t baseAddr, uint32_t flag);
 
uint32_t ECAP_peripheralIdGet(uint32_t baseAddr);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef ECAP_V0_H_ */