openblt/Target/Demo/ARMCM4_XMC4_XMC4700_Relax_K.../Boot/Libraries/XMCLib/src/xmc_ledts.c

384 lines
14 KiB
C

/**
* @file xmc_ledts.c
* @date 2017-02-25
*
* @cond
*********************************************************************************************************************
* XMClib v2.1.12 - XMC Peripheral Driver Library
*
* Copyright (c) 2015-2017, Infineon Technologies AG
* 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 the copyright holders 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 HOLDER 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.
*
* To improve the quality of the software, users are encouraged to share modifications, enhancements or bug fixes with
* Infineon Technologies AG dave@infineon.com).
*********************************************************************************************************************
*
* Change History
* --------------
*
* 2015-02-20:
* - Initial draft <br>
* - New API added: XMC_LEDTS_SetActivePADNo() <br>
*
* 2015-06-20:
* - Removed version macros and declaration of GetDriverVersion API
*
* 2017-02-25:
* - XMC_LEDTS_InitGlobal() fixed compilation warnings
*
* <b>Detailed description of file:</b><br>
* APIs for the functional blocks of LEDTS have been defined:<br>
* -- GLOBAL (APIs prefixed with LEDTS_GLOBAL_) <br>
* -- Clock configuration, Function/Event configuration, Interrupt configuration
*
* @endcond
*
*/
/*********************************************************************************************************************
* HEADER FILES
********************************************************************************************************************/
#include <xmc_ledts.h>
#if defined(LEDTS0)
#include "xmc_scu.h"
/*********************************************************************************************************************
* MACROS
********************************************************************************************************************/
#define XMC_LEDTS_CLOCK_NOT_RUNNING 0U
/*********************************************************************************************************************
* ENUMS
********************************************************************************************************************/
/*********************************************************************************************************************
* DATA STRUCTURES
********************************************************************************************************************/
/*********************************************************************************************************************
* GLOBAL DATA
********************************************************************************************************************/
/*********************************************************************************************************************
* LOCAL/UTILITY ROUTINES
********************************************************************************************************************/
/*********************************************************************************************************************
* API IMPLEMENTATION
********************************************************************************************************************/
/**
* Initialization of global register
*/
XMC_LEDTS_STATUS_t XMC_LEDTS_InitGlobal(XMC_LEDTS_t *const ledts, const XMC_LEDTS_GLOBAL_CONFIG_t *config)
{
XMC_ASSERT("XMC_LEDTS_InitGlobal:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
XMC_ASSERT("XMC_LEDTS_InitGlobal:Null Pointer", (config != (XMC_LEDTS_GLOBAL_CONFIG_t *)NULL));
if (ledts == XMC_LEDTS0)
{
#if defined(CLOCK_GATING_SUPPORTED)
XMC_SCU_CLOCK_UngatePeripheralClock(XMC_SCU_PERIPHERAL_CLOCK_LEDTS0);
#endif
#if defined(PERIPHERAL_RESET_SUPPORTED)
XMC_SCU_RESET_DeassertPeripheralReset(XMC_SCU_PERIPHERAL_RESET_LEDTS0);
#endif
}
#if defined(LEDTS1)
else if (ledts == XMC_LEDTS1)
{
#if defined(CLOCK_GATING_SUPPORTED)
XMC_SCU_CLOCK_UngatePeripheralClock(XMC_SCU_PERIPHERAL_CLOCK_LEDTS1);
#endif
#if defined(PERIPHERAL_RESET_SUPPORTED)
XMC_SCU_RESET_DeassertPeripheralReset(XMC_SCU_PERIPHERAL_RESET_LEDTS1);
#endif
}
#endif
#if defined(LEDTS2)
else if (ledts == XMC_LEDTS2)
{
#if defined(CLOCK_GATING_SUPPORTED)
XMC_SCU_CLOCK_UngatePeripheralClock(XMC_SCU_PERIPHERAL_CLOCK_LEDTS2);
#endif
#if defined(PERIPHERAL_RESET_SUPPORTED)
XMC_SCU_RESET_DeassertPeripheralReset(XMC_SCU_PERIPHERAL_RESET_LEDTS2);
#endif
}
#endif
else
{
XMC_ASSERT("XMC_LEDTS_InitGlobal:Invalid Module Pointer", 0);
}
if((ledts->GLOBCTL & LEDTS_GLOBCTL_CLK_PS_Msk) != XMC_LEDTS_CLOCK_NOT_RUNNING)
{
return XMC_LEDTS_STATUS_RUNNING;
}
ledts->GLOBCTL = config->globctl;
return XMC_LEDTS_STATUS_SUCCESS;
}
/**
* Initialization of registers for LED-driving function
*/
XMC_LEDTS_STATUS_t XMC_LEDTS_InitLED(XMC_LEDTS_t *const ledts, const XMC_LEDTS_LED_CONFIG_t *config)
{
XMC_ASSERT("XMC_LEDTS_LED_Init:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
XMC_ASSERT("XMC_LEDTS_LED_Init:Null Pointer", (config != (XMC_LEDTS_LED_CONFIG_t *)NULL));
if((ledts->GLOBCTL & LEDTS_GLOBCTL_CLK_PS_Msk) != XMC_LEDTS_CLOCK_NOT_RUNNING)
{
return XMC_LEDTS_STATUS_RUNNING;
}
ledts->FNCTL &= ~(LEDTS_FNCTL_COLLEV_Msk | LEDTS_FNCTL_NR_LEDCOL_Msk);
ledts->FNCTL |= (config->fnctl);
/* Enable LED function */
ledts->GLOBCTL |= LEDTS_GLOBCTL_LD_EN_Msk;
return XMC_LEDTS_STATUS_SUCCESS;
}
/**
* Initialization of registers for basic Touch-Sense control function
*/
XMC_LEDTS_STATUS_t XMC_LEDTS_InitTSBasic(XMC_LEDTS_t *const ledts, const XMC_LEDTS_TS_CONFIG_BASIC_t *config)
{
uint32_t reg;
XMC_ASSERT("XMC_LEDTS_TS_Basic_Init:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
XMC_ASSERT("XMC_LEDTS_TS_Basic_Init:Null Pointer", (config != (XMC_LEDTS_TS_CONFIG_BASIC_t *)NULL));
if((ledts->GLOBCTL & LEDTS_GLOBCTL_CLK_PS_Msk) != XMC_LEDTS_CLOCK_NOT_RUNNING)
{
return XMC_LEDTS_STATUS_RUNNING;
}
reg = ~(LEDTS_FNCTL_ACCCNT_Msk | LEDTS_FNCTL_TSCCMP_Msk | LEDTS_FNCTL_TSCTRR_Msk | LEDTS_FNCTL_TSCTRSAT_Msk |
LEDTS_FNCTL_NR_TSIN_Msk);
ledts->FNCTL &= (reg);
ledts->FNCTL |= (config->fnctl);
/* Enable TS function */
ledts->GLOBCTL |= LEDTS_GLOBCTL_TS_EN_Msk;
return XMC_LEDTS_STATUS_SUCCESS;
}
/**
* Initialization of registers for advanced Touch-Sense control function
*/
XMC_LEDTS_STATUS_t XMC_LEDTS_InitTSAdvanced (XMC_LEDTS_t *const ledts, const XMC_LEDTS_TS_CONFIG_ADVANCED_t *config)
{
uint32_t reg;
XMC_ASSERT("XMC_LEDTS_TS_Advanced_Init:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
XMC_ASSERT("XMC_LEDTS_TS_Advanced_Init:Null Pointer", (config != (XMC_LEDTS_TS_CONFIG_ADVANCED_t *)NULL));
if((ledts->GLOBCTL & LEDTS_GLOBCTL_CLK_PS_Msk) != XMC_LEDTS_CLOCK_NOT_RUNNING)
{
return XMC_LEDTS_STATUS_RUNNING;
}
reg = ~(LEDTS_GLOBCTL_MASKVAL_Msk | LEDTS_GLOBCTL_FENVAL_Msk);
ledts->GLOBCTL &= (reg);
ledts->GLOBCTL |= (config->globctl);
reg = ~(LEDTS_FNCTL_PADT_Msk | LEDTS_FNCTL_PADTSW_Msk | LEDTS_FNCTL_EPULL_Msk | LEDTS_FNCTL_TSOEXT_Msk);
ledts->FNCTL &= (reg);
ledts->FNCTL |= (config->fnctl);
return XMC_LEDTS_STATUS_SUCCESS;
}
/**
* Starts LEDTS-counter
*/
void XMC_LEDTS_StartCounter(XMC_LEDTS_t *const ledts, const uint16_t prescaler)
{
XMC_ASSERT("XMC_LEDTS_Start_Counter:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
ledts->GLOBCTL |= prescaler<<16U;
}
/**
* Stops LEDTS-counter
*/
void XMC_LEDTS_StopCounter(XMC_LEDTS_t *const ledts)
{
XMC_ASSERT("XMC_LEDTS_Stop_Counter:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
ledts->GLOBCTL &= 0x0000FFFF;
}
/**
* Reads time interrupt flags
*/
uint32_t XMC_LEDTS_ReadInterruptFlag(XMC_LEDTS_t *const ledts)
{
XMC_ASSERT("XMC_LEDTS_ReadInterruptFlag:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
return (ledts->EVFR & 0xF);
}
/**
* Set the active pad number
*/
void XMC_LEDTS_SetActivePADNo(XMC_LEDTS_t *const ledts, XMC_LEDTS_NUMBER_TS_INPUT_t pad_num)
{
uint32_t reg;
XMC_ASSERT("XMC_LEDTS_SetActivePADNo:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
reg = ledts->FNCTL;
reg &= ~(LEDTS_FNCTL_PADT_Msk);
reg |= (uint32_t)pad_num;
ledts->FNCTL = reg;
}
/**
* Clears interrupt indication flags
*/
void XMC_LEDTS_ClearInterruptFlag(XMC_LEDTS_t *const ledts, uint32_t interrupt_mask)
{
XMC_ASSERT("XMC_LEDTS_ClearInterruptFlag:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
ledts->EVFR = (interrupt_mask << LEDTS_EVFR_CTSF_Pos);
}
/**
* Programming of registers to output pattern on an LED column in LED matrix
*/
void XMC_LEDTS_SetLEDLinePattern(XMC_LEDTS_t *const ledts, XMC_LEDTS_LED_COLUMN_t column, const uint8_t pattern)
{
uint32_t reg;
uint8_t reg_index = ((uint8_t)column) >> 2;
uint8_t bit_shift_count = ((uint8_t)column & 0x03) * 8;
XMC_ASSERT("XMC_LEDTS_Set_LED_Line_Pattern:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
reg = ledts->LINE[reg_index];
reg &= (~(0xff << bit_shift_count));
reg |= pattern << bit_shift_count;
ledts->LINE[reg_index] = reg;
}
/**
* Programming of registers to adjust brightness of an LED column in LED matrix
*/
void XMC_LEDTS_SetColumnBrightness(XMC_LEDTS_t *const ledts, XMC_LEDTS_LED_COLUMN_t column, const uint8_t brightness)
{
uint32_t reg;
uint8_t reg_index = ((uint8_t)column) >> 2;
uint8_t bit_shift_count = ((uint8_t)column & 0x03) * 8;
XMC_ASSERT("XMC_LEDTS_Set_Column_Brightness:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
reg = ledts->LDCMP[reg_index];
reg &= (~(0xff << bit_shift_count));
reg |= brightness << bit_shift_count;
ledts->LDCMP[reg_index] = reg;
}
/**
* Programming of registers to set common oscillation window size for touch-sense inputs
*/
void XMC_LEDTS_SetCommonOscillationWindow(XMC_LEDTS_t *const ledts, const uint8_t common_size)
{
uint32_t reg;
XMC_ASSERT("XMC_LEDTS_Set_Common_Oscillation_Window:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
reg = ledts->LDCMP[1];
reg &= ~LEDTS_LDCMP1_CMP_LDA_TSCOM_Msk;
reg |= (common_size << LEDTS_LDCMP1_CMP_LDA_TSCOM_Pos);
ledts->LDCMP[1] = reg;
}
/**
* Checking the previous active function or LED column status
*/
uint32_t XMC_LEDTS_ReadFNCOL(XMC_LEDTS_t *const ledts)
{
uint32_t fncol_read;
XMC_ASSERT("XMC_LEDTS_Read_FNCOL:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
fncol_read = ledts->FNCTL & LEDTS_FNCTL_FNCOL_Msk;
fncol_read >>= LEDTS_FNCTL_FNCOL_Pos;
return fncol_read;
}
/**
* Set the number of LED column Enabled
*/
void XMC_LEDTS_SetNumOfLEDColumns(XMC_LEDTS_t *const ledts, uint8_t count)
{
XMC_ASSERT("XMC_LEDTS_SetNumOfLEDColumns:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
ledts->FNCTL &= ~(LEDTS_FNCTL_NR_LEDCOL_Msk);
ledts->FNCTL |= (count << LEDTS_FNCTL_NR_LEDCOL_Pos);
}
/**
* Reading recorded number of oscillation counts
*/
uint16_t XMC_LEDTS_ReadTSVAL(XMC_LEDTS_t *const ledts)
{
uint16_t no_of_oscillations;
XMC_ASSERT("XMC_LEDTS_Read_TSVAL:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
no_of_oscillations = (ledts->TSVAL & 0xFFFF);
return no_of_oscillations;
}
/**
* Programming of registers to adjust the size of oscillation window
*/
void XMC_LEDTS_SetOscillationWindow(XMC_LEDTS_t *const ledts, XMC_LEDTS_NUMBER_TS_INPUT_t touchpad, const uint8_t size)
{
uint32_t reg;
uint8_t reg_index = ((uint8_t)touchpad) >> 2;
uint8_t bit_shift_count = ((uint8_t)touchpad & 0x03) * 8;
XMC_ASSERT("XMC_LEDTS_Set_Oscillation_Window:Wrong Module Pointer", XMC_LEDTS_CHECK_KERNEL_PTR(ledts));
reg = ledts->TSCMP[reg_index];
reg &= (~(0xff << bit_shift_count));
reg |= size << bit_shift_count;
ledts->TSCMP[reg_index] = reg;
}
#endif /* LEDTS0 */