STM32F33: Add COMP support

This commit is contained in:
raiden00pl 2017-03-19 18:36:44 +01:00
parent c760d00158
commit 651b8360c6
4 changed files with 1124 additions and 0 deletions

View File

@ -217,6 +217,10 @@ ifeq ($(CONFIG_DAC),y)
CHIP_CSRCS += stm32_dac.c
endif
ifeq ($(CONFIG_COMP),y)
CHIP_CSRCS += stm32_comp.c
endif
ifeq ($(CONFIG_STM32_1WIREDRIVER),y)
CHIP_CSRCS += stm32_1wire.c
endif

View File

@ -59,6 +59,7 @@
#include "stm32_adc.h"
//#include "stm32_bkp.h"
#include "stm32_can.h"
#include "stm32_comp.h"
#include "stm32_dbgmcu.h"
#include "stm32_dma.h"
#include "stm32_dac.h"

View File

@ -0,0 +1,838 @@
/****************************************************************************
* arch/arm/src/stm32/stm32_comp.c
*
* Copyright (C) 2017 Gregory Nutt. All rights reserved.
* Author: Mateusz Szafoni <raiden00@railab.me>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name NuttX 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
#include <errno.h>
#include <assert.h>
#include <debug.h>
#include <arch/board/board.h>
#include "chip.h"
#include "stm32_gpio.h"
#include "stm32_comp.h"
#ifdef CONFIG_STM32_COMP
/* Some COMP peripheral must be enabled */
/* Up to 7 comparators in STM32F2 Series */
#if defined(CONFIG_STM32_COMP1) || defined(CONFIG_STM32_COMP2) || \
defined(CONFIG_STM32_COMP3) || defined(CONFIG_STM32_COMP4) || \
defined(CONFIG_STM32_COMP5) || defined(CONFIG_STM32_COMP6) || \
defined(CONFIG_STM32_COMP7)
/* @TODO: support for STM32F30XX and STM32F37XX comparators */
#if defined(CONFIG_STM32_STM32F30XX) || defined(CONFIG_STM32_STM32F33XX) || \
defined(CONFIG_STM32_STM32F37XX)
/* Currently only STM32F33XX supported */
#if defined(CONFIG_STM32_STM32F30XX) || defined(CONFIG_STM32_STM32F37XX)
# error "Not supported yet"
#endif
#if defined(CONFIG_STM32_STM32F33XX)
# if defined(CONFIG_STM32_COMP1) || defined(CONFIG_STM32_COMP3) || \
defined(CONFIG_STM32_COMP5) || defined(CONFIG_STM32_COMP7)
# error "STM32F33 supports only COMP2, COMP4 and COMP6"
# endif
#endif
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* COMP2 default configuration **********************************************/
#ifdef CONFIG_STM32_COMP2
# ifndef COMP2_BLANLKING
# define COMP2_BLANKING COMP_BLANKING_DEFAULT
# endif
# ifndef COMP2_POL
# define COMP2_POL COMP_BLANKING_DEFAULT
# endif
# ifndef COMP2_INM
# define COMP2_INM COMP_INM_DEFAULT
# endif
# ifndef COMP2_OUTSEL
# define COMP2_OUTSEL COMP_OUTSEL_DEFAULT
# endif
# ifndef COMP2_LOCK
# define COMP2_LOCK COMP_LOCK_DEFAULT
# endif
#endif
/* COMP4 default configuration **********************************************/
#ifdef CONFIG_STM32_COMP4
# ifndef COMP4_BLANLKING
# define COMP4_BLANKING COMP_BLANKING_DEFAULT
# endif
# ifndef COMP4_POL
# define COMP4_POL COMP_BLANKING_DEFAULT
# endif
# ifndef COMP4_INM
# define COMP4_INM COMP_INM_DEFAULT
# endif
# ifndef COMP4_OUTSEL
# define COMP4_OUTSEL COMP_OUTSEL_DEFAULT
# endif
# ifndef COMP4_LOCK
# define COMP4_LOCK COMP_LOCK_DEFAULT
# endif
#endif
/* COMP6 default configuration **********************************************/
#ifdef CONFIG_STM32_COMP6
# ifndef COMP6_BLANLKING
# define COMP6_BLANKING COMP_BLANKING_DEFAULT
# endif
# ifndef COMP6_POL
# define COMP6_POL COMP_BLANKING_DEFAULT
# endif
# ifndef COMP6_INM
# define COMP6_INM COMP_INM_DEFAULT
# endif
# ifndef COMP6_OUTSEL
# define COMP6_OUTSEL COMP_OUTSEL_DEFAULT
# endif
# ifndef COMP6_LOCK
# define COMP6_LOCK COMP_LOCK_DEFAULT
# endif
#endif
/****************************************************************************
* Private Types
****************************************************************************/
#ifdef CONFIG_STM32_COMP1
static struct stm32_comp_s g_comp1priv =
{
.blanking = COMP1_BLANKING,
.pol = COMP1_POL,
.inm = COMP1_INM,
.out = COMP1_OUTSEL,
.lock = COMP1_LOCK,
.csr = STM32_COMP1_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP1_MODE,
.hyst = COMP1_HYST,
#endif
};
#endif
#ifdef CONFIG_STM32_COMP2
static struct stm32_comp_s g_comp2priv =
{
.blanking = COMP2_BLANKING,
.pol = COMP2_POL,
.inm = COMP2_INM,
.out = COMP2_OUTSEL,
.lock = COMP2_LOCK,
.csr = STM32_COMP2_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP2_MODE,
.hyst = COMP2_HYST,
#endif
};
#endif
#ifdef CONFIG_STM32_COMP3
static struct stm32_comp_s g_comp3priv =
{
.blanking = COMP3_BLANKING,
.pol = COMP3_POL,
.inm = COMP3_INM,
.out = COMP3_OUTSEL,
.lock = COMP3_LOCK,
.csr = STM32_COMP3_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP3_MODE,
.hyst = COMP3_HYST,
#endif
};
#endif
#ifdef CONFIG_STM32_COMP4
static struct stm32_comp_s g_comp4priv =
{
.blanking = COMP4_BLANKING,
.pol = COMP4_POL,
.inm = COMP4_INM,
.out = COMP4_OUTSEL,
.lock = COMP4_LOCK,
.csr = STM32_COMP4_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP4_MODE,
.hyst = COMP4_HYST,
#endif
};
#endif
#ifdef CONFIG_STM32_COMP5
static struct stm32_comp_s g_comp5priv =
{
.blanking = COMP5_BLANKING,
.pol = COMP5_POL,
.inm = COMP5_INM,
.out = COMP5_OUTSEL,
.lock = COMP5_LOCK,
.csr = STM32_COMP5_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP5_MODE,
.hyst = COMP5_HYST,
#endif
};
#endif
#ifdef CONFIG_STM32_COMP6
static struct stm32_comp_s g_comp6priv =
{
.blanking = COMP6_BLANKING,
.pol = COMP6_POL,
.inm = COMP6_INM,
.out = COMP6_OUTSEL,
.lock = COMP6_LOCK,
.csr = STM32_COMP6_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP6_MODE,
.hyst = COMP6_HYST,
#endif
};
#endif
#ifdef CONFIG_STM32_COMP7
static struct stm32_comp_s g_comp7priv =
{
.blanking = COMP7_BLANKING,
.pol = COMP7_POL,
.inm = COMP7_INM,
.out = COMP7_OUTSEL,
.lock = COMP7_LOCK,
.csr = STM32_COMP7_CSR,
#ifndef CONFIG_STM32_STM32F33XX
.mode = COMP7_MODE,
.hyst = COMP7_HYST,
#endif
};
#endif
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
static inline void comp_modify_csr(FAR struct stm32_comp_s *priv,
uint32_t clearbits, uint32_t setbits);
static inline uint32_t comp_getreg_csr(FAR struct stm32_comp_s *priv);
static inline void comp_putreg_csr(FAR struct stm32_comp_s *priv,
uint32_t value);
static bool stm32_complock_get(FAR struct stm32_comp_s *priv);
/****************************************************************************
* Private Data
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: comp_modify_csr
*
* Description:
* Modify the value of a 32-bit COMP CSR register (not atomic).
*
* Input Parameters:
* priv - A reference to the COMP structure
* clrbits - The bits to clear
* setbits - The bits to set
*
* Returned Value:
* None
*
****************************************************************************/
static inline void comp_modify_csr(FAR struct stm32_comp_s *priv,
uint32_t clearbits, uint32_t setbits)
{
uint32_t csr = priv->csr;
modifyreg32(csr, clearbits, setbits);
}
/****************************************************************************
* Name: comp_getreg_csr
*
* Description:
* Read the value of an COMP CSR register
*
* Input Parameters:
* priv - A reference to the COMP structure
*
* Returned Value:
* The current contents of the COMP CSR register
*
****************************************************************************/
static inline uint32_t comp_getreg_csr(FAR struct stm32_comp_s *priv)
{
uint32_t csr = priv->csr;
return getreg32(csr);
}
/****************************************************************************
* Name: comp_putreg_csr
*
* Description:
* Write a value to an COMP register.
*
* Input Parameters:
* priv - A reference to the COMP structure
* value - The value to write to the COMP CSR register
*
* Returned Value:
* None
*
****************************************************************************/
static inline void comp_putreg_csr(FAR struct stm32_comp_s *priv,
uint32_t value)
{
uint32_t csr = priv->csr;
putreg32(value, csr);
}
/****************************************************************************
* Name: stm32_comp_complock_get
*
* Description:
* Get COMP lock bit state
*
* Input Parameters:
* priv - A reference to the COMP structure
*
* Returned Value:
* True if COMP locked, false if not locked
*
****************************************************************************/
static bool stm32_complock_get(FAR struct stm32_comp_s *priv)
{
uint32_t regval;
regval = comp_getreg_csr(priv);
return ((regval & COMP_CSR_LOCK == 0) ? false : true);
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: stm32_compconfig
*
* Description:
* Configure comparator and used I/Os
*
* Input Parameters:
* priv - A reference to the COMP structure
*
* Returned Value:
* 0 on success, a negated errno value on failure
*
* REVISIT: Where to config comparator output pin ?
*
****************************************************************************/
int stm32_compconfig(FAR struct stm32_comp_s *priv)
{
uint32_t regval;
int index;
/* Get comparator index */
switch (priv->csr)
{
#ifdef CONFIG_STM32_COMP1
case STM32_COMP1_CSR:
index = 1;
break;
#endif
case STM32_COMP2_CSR:
index = 2;
break;
#ifdef CONFIG_STM32_COMP3
case STM32_COMP3_CSR:
index = 3;
break;
#endif
case STM32_COMP4_CSR:
index = 4;
break;
#ifdef CONFIG_STM32_COMP5
case STM32_COMP5_CSR:
index = 5;
break;
#endif
case STM32_COMP6_CSR:
index = 6;
break;
#ifdef CONFIG_STM32_COMP7
case STM32_COMP7_CSR:
index = 7;
break;
#endif
default:
return -EINVAL;
}
/* Configure non inverting input */
switch (index)
{
#ifdef CONFIG_STM32_COMP2
case 2:
stm32_configgpio(GPIO_COMP2_INP);
break;
#endif
#ifdef CONFIG_STM32_COMP4
case 4:
stm32_configgpio(GPIO_COMP4_INP);
break;
#endif
#ifdef CONFIG_STM32_COMP6
case 6:
stm32_configgpio(GPIO_COMP6_INP);
break;
#endif
default:
return -EINVAL;
}
/* Set Comparator inverting input */
switch (priv->inm)
{
case COMP_INMSEL_1P4VREF:
regval |= COMP_CSR_INMSEL_1P4VREF;
break;
case COMP_INMSEL_1P2VREF:
regval |= COMP_CSR_INMSEL_1P2VREF;
break;
case COMP_INMSEL_3P4VREF:
regval |= COMP_CSR_INMSEL_3P4VREF;
break;
case COMP_INMSEL_VREF:
regval |= COMP_CSR_INMSEL_VREF;
break;
case COMP_INMSEL_DAC1CH1:
regval |= COMP_CSR_INMSEL_DAC1CH1;
break;
case COMP_INMSEL_DAC1CH2:
regval |= COMP_CSR_INMSEL_DAC1CH2;
break;
case COMP_INMSEL_PIN:
{
/* INMSEL PIN configuration dependent on COMP index */
switch (index)
{
#ifdef CONFIG_STM32_COMP2
case 2:
{
stm32_configgpio(GPIO_COMP2_INM);
regval |= COMP_CSR_INMSEL_PA2;
break;
}
#endif
#ifdef CONFIG_STM32_COMP4
case 4:
{
/* COMP4_INM can be PB2 or PA4 */
stm32_configgpio(GPIO_COMP4_INM);
regval |= (GPIO_COMP4_INM == GPIO_COMP4_INM_1 ? COMP_CSR_INMSEL_PB2 : COMP_CSR_INMSEL_PA4);
break;
}
#endif
#ifdef CONFIG_STM32_COMP6
case 6:
{
/* COMP6_INM can be PB15 or PA4 */
stm32_configgpio(GPIO_COMP6_INM);
regval |= (GPIO_COMP6_INM == GPIO_COMP6_INM_1 ? COMP_CSR_INMSEL_PB15 : COMP_CSR_INMSEL_PA4);
break;
}
#endif
default :
return -EINVAL;
}
break;
}
default:
return -EINVAL;
}
/* Set Comparator output selection */
switch (priv->out)
{
case COMP_OUTSEL_NOSEL:
regval |= COMP_CSR_OUTSEL_NOSEL;
break;
case COMP_OUTSEL_BRKACTH:
regval |= COMP_CSR_OUTSEL_BRKACTH;
break;
case COMP_OUTSEL_BRK2:
regval |= COMP_CSR_OUTSEL_BRK2;
break;
case COMP_OUTSEL_T1OCC:
regval |= COMP_CSR_OUTSEL_T1OCC;
break;
case COMP_OUTSEL_T3CAP3:
regval |= COMP_CSR_OUTSEL_T3CAP3;
break;
case COMP_OUTSEL_T2CAP2:
regval |= COMP_CSR_OUTSEL_T2CAP2;
break;
case COMP_OUTSEL_T1CAP1:
regval |= COMP_CSR_OUTSEL_T1CAP1;
break;
case COMP_OUTSEL_T2CAP4:
regval |= COMP_CSR_OUTSEL_T2CAP4;
break;
case COMP_OUTSEL_T15CAP2:
regval |= COMP_CSR_OUTSEL_T15CAP2;
break;
case COMP_OUTSEL_T2OCC:
if (index == 2)
regval |= COMP2_CSR_OUTSEL_T2OCC;
else if (index == 6)
regval |= COMP6_CSR_OUTSEL_T2OCC;
break;
case COMP_OUTSEL_T16OCC:
regval |= COMP_CSR_OUTSEL_T16OCC;
break;
case COMP_OUTSEL_T3CAP1:
regval |= COMP_CSR_OUTSEL_T3CAP1;
break;
case COMP_OUTSEL_T15OCC:
regval |= COMP_CSR_OUTSEL_T15OCC;
break;
case COMP_OUTSEL_T16CAP1:
regval |= COMP_CSR_OUTSEL_T16CAP1;
break;
case COMP_OUTSEL_T3OCC:
regval |= COMP_CSR_OUTSEL_T3OCC;
break;
default:
return -EINVAL;
}
/* Set Comparator output polarity */
regval |= (priv->pol == COMP_POL_INVERTED ? COMP_CSR_POL : 0);
/* Set Comparator output blanking source */
switch (priv->blanking)
{
case COMP_BLANKING_DIS:
regval |= COMP_CSR_BLANKING_DIS;
break;
case COMP_BLANKING_T1OC5:
regval |= COMP_CSR_BLANKING_T1OC5;
break;
case COMP_BLANKING_T3OC4:
regval |= COMP_CSR_BLANKING_T3OC4;
break;
case COMP_BLANKING_T2OC3:
regval |= COMP_CSR_BLANKING_T2OC3;
break;
case COMP_BLANKING_T15OC1:
regval |= COMP_CSR_BLANKING_T15OC1;
break;
case COMP_BLANKING_T2OC4:
regval |= COMP_CSR_BLANKING_T2OC4;
break;
case COMP_BLANKING_T15OC2:
regval |= COMP_CSR_BLANKING_T15OC1;
break;
default:
return -EINVAL;
}
/* Save CSR register */
comp_putreg_csr(priv, regval);
/* Enable Comparator */
stm32_compenable(priv, true);
/* Lock Comparator if needed */
if (priv->lock == COMP_LOCK_RO)
stm32_complock(priv, true);
return OK;
}
/****************************************************************************
* Name: stm32_compinitialize
*
* Description:
* Initialize the COMP.
*
* Input Parameters:
* intf - The COMP interface number.
*
* Returned Value:
* Valid COMP device structure reference on succcess; a NULL on failure.
*
* Assumptions:
* 1. Clock to the COMP block has enabled,
* 2. Board-specific logic has already configured
*
****************************************************************************/
FAR struct stm32_comp_s* stm32_compinitialize(int intf)
{
FAR struct stm32_comp_s *priv;
int ret;
switch (intf)
{
#ifdef CONFIG_STM32_COMP1
case 1:
ainfo("COMP1 selected\n");
priv = &g_comp1priv;
break;
#endif
#ifdef CONFIG_STM32_COMP2
case 2:
ainfo("COMP2 selected\n");
priv = &g_comp2priv;
break;
#endif
#ifdef CONFIG_STM32_COMP3
case 3:
ainfo("COMP3 selected\n");
priv = &g_comp3priv;
break;
#endif
#ifdef CONFIG_STM32_COMP4
case 4:
ainfo("COMP4 selected\n");
priv = &g_comp4priv;
break;
#endif
#ifdef CONFIG_STM32_COMP5
case 5:
ainfo("COMP5 selected\n");
priv = &g_comp5priv;
break;
#endif
#ifdef CONFIG_STM32_COMP6
case 6:
ainfo("COMP6 selected\n");
priv = &g_comp6priv;
break;
#endif
#ifdef CONFIG_STM32_COMP7
case 7:
ainfo("COMP7 selected\n");
priv = &g_comp7priv;
break;
#endif
default:
aerr("ERROR: No COMP interface defined\n");
return NULL;
}
/* Configure selected comparator */
ret = stm32_compconfig(priv);
if (ret < 0)
{
aerr("ERROR: Failed to initialize COMP%d: %d\n", intf, ret);
errno = -ret;
return NULL;
}
return priv;
}
/****************************************************************************
* Name: stm32_compenable
*
* Description:
* Enable/disable comparator
*
* Input Parameters:
* priv - A reference to the COMP structure
* enable - enable/disable flag
*
* Returned Value:
* 0 on success, a negated errno value on failure
*
****************************************************************************/
int stm32_compenable(FAR struct stm32_comp_s *priv, bool enable)
{
bool lock;
ainfo("enable: %d\n", enable ? 1 : 0);
lock = stm32_complock_get(priv);
if (lock)
{
aerr("ERROR: Comparator locked!\n");
return -EPERM;
}
else
{
if (enable)
{
/* Enable the COMP */
comp_modify_csr(priv, COMP_CSR_COMPEN, 0);
}
else
{
/* Disable the COMP */
comp_modify_csr(priv, 0, COMP_CSR_COMPEN);
}
}
return OK;
}
/****************************************************************************
* Name: stm32_complock
*
* Description:
* Lock comparator CSR register
*
* Input Parameters:
* priv - A reference to the COMP structure
* enable - lock flag
*
* Returned Value:
* 0 on success, a negated errno value on failure
*
****************************************************************************/
int stm32_complock(FAR struct stm32_comp_s *priv, bool lock)
{
bool current;
current = stm32_complock_get(priv);
if (current)
{
if (lock == false)
{
aerr("ERROR: COMP LOCK can be cleared only by a system reset\n");
return -EPERM;
}
}
else
{
if (lock == true)
{
comp_modify_csr(priv, COMP_CSR_LOCK, 0);
priv->lock = COMP_LOCK_RO;
}
}
return OK;
}
#endif /* CONFIG_STM32_STM32F30XX || CONFIG_STM32_STM32F33XX ||
* CONFIG_STM32_STM32F37XX*/
#endif /* CONFIG_STM32_COMP2 || CONFIG_STM32_COMP4 ||
* CONFIG_STM32_COMP6 */
#endif /* CONFIG_STM32_COMP */

View File

@ -0,0 +1,281 @@
/************************************************************************************
* arch/arm/src/stm32/stm32_comp.h
*
* Copyright (C) 2017 Gregory Nutt. All rights reserved.
* Author: Mateusz Szafoni <raiden00@railab.me>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name NuttX 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 __ARCH_ARM_SRC_STM32_STM32_COMP_H
#define __ARCH_ARM_SRC_STM32_STM32_COMP_H
/************************************************************************************
* Included Files
************************************************************************************/
#include <nuttx/config.h>
#include "chip.h"
#if defined(CONFIG_STM32_STM32F30XX)
# error "COMP support for STM32F30XX not implemented yet"
#elif defined(CONFIG_STM32_STM32F33XX)
# include "chip/stm32f33xxx_comp.h"
#elif defined(CONFIG_STM32_STM32F37XX)
# error "COMP support for STM32F37XX ot implemented yet"
#endif
/************************************************************************************
* Pre-processor definitions
************************************************************************************/
#define COMP_BLANKING_DEFAULT COMP_BLANKING_DIS /* No blanking */
#define COMP_POL_DEFAULT COMP_POL_NONINVERT /* Output is not inverted */
#define COMP_INM_DEFAULT COMP_INMSEL_1P4VREF /* 1/4 of Vrefint as INM */
#define COMP_OUTSEL_DEFAULT COMP_OUTSEL_NOSEL /* Output not selected */
#define COMP_LOCK_DEFAULT COMP_LOCK_RO /* Do not lock CSR register */
#ifndef CONFIG_STM32_STM32F33XX
#define COMP_MODE_DEFAULT
#define COMP_HYST_DEFAULT
#define COMP_WINMODE_DEFAULT
#endif
/************************************************************************************
* Public Types
************************************************************************************/
/* Blanking source */
enum stm32_comp_blanking_e
{
COMP_BLANKING_DIS,
#if defined(CONFIG_STM32_STM32F33XX)
COMP_BLANKING_T1OC5,
COMP_BLANKING_T3OC4,
COMP_BLANKING_T2OC3,
COMP_BLANKING_T3OC3,
COMP_BLANKING_T15OC1,
COMP_BLANKING_T2OC4,
COMP_BLANKING_T15OC2,
#endif
};
/* Output polarisation */
enum stm32_comp_pol_e
{
COMP_POL_NONINVERT,
COMP_POL_INVERTED
};
/* Inverting input */
enum stm32_comp_inm_e
{
COMP_INMSEL_1P4VREF,
COMP_INMSEL_1P2VREF,
COMP_INMSEL_3P4VREF,
COMP_INMSEL_VREF,
COMP_INMSEL_DAC1CH1,
COMP_INMSEL_DAC1CH2,
COMP_INMSEL_PIN
};
/* Output selection */
enum stm32_comp_outsel_e
{
COMP_OUTSEL_NOSEL,
#if defined(CONFIG_STM32_STM32F33XX)
COMP_OUTSEL_BRKACTH,
COMP_OUTSEL_BRK2,
COMP_OUTSEL_T1OCC, /* COMP2 only */
COMP_OUTSEL_T3CAP3, /* COMP4 only */
COMP_OUTSEL_T2CAP2, /* COMP6 only */
COMP_OUTSEL_T1CAP1, /* COMP2 only */
COMP_OUTSEL_T2CAP4, /* COMP2 only */
COMP_OUTSEL_T15CAP2, /* COMP4 only */
COMP_OUTSEL_T2OCC, /* COMP6 only */
COMP_OUTSEL_T16OCC, /* COMP2 only */
COMP_OUTSEL_T3CAP1, /* COMP2 only */
COMP_OUTSEL_T15OCC, /* COMP4 only */
COMP_OUTSEL_T16CAP1, /* COMP6 only */
COMP_OUTSEL_T3OCC, /* COMP2 and COMP4 only */
#endif
};
/* CSR register lock state */
enum stm32_comp_lock_e
{
COMP_LOCK_RW,
COMP_LOCK_RO
};
#ifndef CONFIG_STM32_STM32F33XX
/* Hysteresis */
enum stm32_comp_hyst_e
{
COMP_HYST_DIS,
COMP_HYST_LOW,
COMP_HYST_MEDIUM,
COMP_HYST_HIGH
},
/* Power/Speed Modes */
enum stm32_comp_mode_e
{
COMP_MODE_HIGHSPEED,
COMP_MODE_MEDIUMSPEED,
COMP_MODE_LOWPOWER,
COMP_MODE_ULTRALOWPOWER
};
/* Window mode */
enum stm32_comp_winmode_e
{
COMP_WINMODE_DIS,
COMP_WINMODE_EN
};
#endif
/* Comparator configuration ***********************************************************/
struct stm32_comp_s
{
uint8_t blanking; /* Blanking source */
uint8_t pol; /* Output polarity */
uint8_t inm; /* Inverting input selection */
uint8_t out; /* Comparator output */
uint8_t lock; /* Comparator Lock */
uint32_t csr; /* Control and status register */
#ifndef CONFIG_STM32_STM32F33XX
uint8_t mode; /* Comparator mode */
uint8_t hyst; /* Comparator hysteresis */
/* @TODO: Window mode + INP selection */
#endif
};
/************************************************************************************
* Public Function Prototypes
************************************************************************************/
#ifndef __ASSEMBLY__
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Name: stm32_compconfig
*
* Description:
* Configure comparator and used I/Os
*
* Input Parameters:
* priv - A reference to the COMP structure
*
* Returned Value:
* 0 on success, a negated errno value on failure
*
****************************************************************************/
int stm32_compconfig(FAR struct stm32_comp_s *priv);
/****************************************************************************
* Name: stm32_compinitialize
*
* Description:
* Initialize the COMP.
*
* Input Parameters:
* intf - The COMP interface number.
*
* Returned Value:
* Valid COMP device structure reference on succcess; a NULL on failure.
*
* Assumptions:
* 1. Clock to the COMP block has enabled,
* 2. Board-specific logic has already configured
*
****************************************************************************/
FAR struct stm32_comp_s* stm32_compinitialize(int intf);
/****************************************************************************
* Name: stm32_compenable
*
* Description:
* Enable/disable comparator
*
* Input Parameters:
* priv - A reference to the COMP structure
* enable - enable/disable flag
*
* Returned Value:
* 0 on success, a negated errno value on failure
*
****************************************************************************/
int stm32_compenable(FAR struct stm32_comp_s *priv, bool enable);
/****************************************************************************
* Name: stm32_complock
*
* Description:
* Lock comparator CSR register
*
* Input Parameters:
* priv - A reference to the COMP structure
* enable - lock flag
*
* Returned Value:
* 0 on success, a negated errno value on failure
*
****************************************************************************/
int stm32_complock(FAR struct stm32_comp_s *priv, bool lock);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __ARCH_ARM_SRC_STM32_STM32_COMP_H */