nuttx/arch/arm/src/stm32/stm32_hrtim.h

/************************************************************************************
 * arch/arm/src/stm32/stm32_hrtim.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_HRTIM_H
#define __ARCH_ARM_SRC_STM32_STM32_HRTIM_H

/************************************************************************************
 * Included Files
 ************************************************************************************/

#include <nuttx/config.h>

#include "chip.h"

#ifdef CONFIG_STM32_HRTIM1

#if defined(CONFIG_STM32_STM32F33XX)
#  include "chip/stm32f33xxx_hrtim.h"
#else
#  error
#endif

/************************************************************************************
 * Pre-processor definitions
 ************************************************************************************/

/************************************************************************************
 * Public Types
 ************************************************************************************/

/* HRTIM Timer X index */

enum stm32_hrtim_tim_e
{
  HRTIM_TIMER_MASTER = 0,
#ifdef CONFIG_STM32_HRTIM_TIMA
  HRTIM_TIMER_TIMA   = 1,
#endif
#ifdef CONFIG_STM32_HRTIM_TIMB
  HRTIM_TIMER_TIMB   = 2,
#endif
#ifdef CONFIG_STM32_HRTIM_TIMC
  HRTIM_TIMER_TIMC   = 3,
#endif
#ifdef CONFIG_STM32_HRTIM_TIMD
  HRTIM_TIMER_TIMD   = 4,
#endif
#ifdef CONFIG_STM32_HRTIM_TIME
  HRTIM_TIMER_TIME   = 5,
#endif
  HRTIM_TIMER_COMMON = 6
};

/* Source which can force the Tx1/Tx2 output to its inactive state */

enum stm32_hrtim_out_rst_e
{
  HRTIM_OUT_RST_UPDATE    = (1 << 0),
  HRTIM_OUT_RST_EXTEVNT10 = (1 << 1),
  HRTIM_OUT_RST_EXTEVNT9  = (1 << 2),
  HRTIM_OUT_RST_EXTEVNT8  = (1 << 3),
  HRTIM_OUT_RST_EXTEVNT7  = (1 << 4),
  HRTIM_OUT_RST_EXTEVNT6  = (1 << 5),
  HRTIM_OUT_RST_EXTEVNT5  = (1 << 6),
  HRTIM_OUT_RST_EXTEVNT4  = (1 << 7),
  HRTIM_OUT_RST_EXTEVNT3  = (1 << 8),
  HRTIM_OUT_RST_EXTEVNT2  = (1 << 9),
  HRTIM_OUT_RST_EXTEVNT1  = (1 << 10),
  HRTIM_OUT_RST_TIMEVNT9  = (1 << 11),
  HRTIM_OUT_RST_TIMEVNT8  = (1 << 12),
  HRTIM_OUT_RST_TIMEVNT7  = (1 << 13),
  HRTIM_OUT_RST_TIMEVNT6  = (1 << 14),
  HRTIM_OUT_RST_TIMEVNT5  = (1 << 15),
  HRTIM_OUT_RST_TIMEVNT4  = (1 << 16),
  HRTIM_OUT_RST_TIMEVNT3  = (1 << 17),
  HRTIM_OUT_RST_TIMEVNT2  = (1 << 18),
  HRTIM_OUT_RST_TIMEVNT1  = (1 << 19),
  HRTIM_OUT_RST_MSTCMP4   = (1 << 20),
  HRTIM_OUT_RST_MSTCMP3   = (1 << 21),
  HRTIM_OUT_RST_MSTCMP2   = (1 << 22),
  HRTIM_OUT_RST_MSTCMP1   = (1 << 23),
  HRTIM_OUT_RST_MSTPER    = (1 << 24),
  HRTIM_OUT_RST_CMP4      = (1 << 25),
  HRTIM_OUT_RST_CMP3      = (1 << 26),
  HRTIM_OUT_RST_CMP2      = (1 << 27),
  HRTIM_OUT_RST_CMP1      = (1 << 28),
  HRTIM_OUT_RST_PER       = (1 << 29),
  HRTIM_OUT_RST_RESYNC    = (1 << 30),
  HRTIM_OUT_RST_SOFT      = (1 << 31)
};

/* Source which can force the Tx1/Tx2 output to its active state  */

enum stm32_hrtim_out_set_e
{
  HRTIM_OUT_SET_UPDATE    = (1 << 0),
  HRTIM_OUT_SET_EXTEVNT10 = (1 << 1),
  HRTIM_OUT_SET_EXTEVNT9  = (1 << 2),
  HRTIM_OUT_SET_EXTEVNT8  = (1 << 3),
  HRTIM_OUT_SET_EXTEVNT7  = (1 << 4),
  HRTIM_OUT_SET_EXTEVNT6  = (1 << 5),
  HRTIM_OUT_SET_EXTEVNT5  = (1 << 6),
  HRTIM_OUT_SET_EXTEVNT4  = (1 << 7),
  HRTIM_OUT_SET_EXTEVNT3  = (1 << 8),
  HRTIM_OUT_SET_EXTEVNT2  = (1 << 9),
  HRTIM_OUT_SET_EXTEVNT1  = (1 << 10),
  HRTIM_OUT_SET_TIMEVNT9  = (1 << 11),
  HRTIM_OUT_SET_TIMEVNT8  = (1 << 12),
  HRTIM_OUT_SET_TIMEVNT7  = (1 << 13),
  HRTIM_OUT_SET_TIMEVNT6  = (1 << 14),
  HRTIM_OUT_SET_TIMEVNT5  = (1 << 15),
  HRTIM_OUT_SET_TIMEVNT4  = (1 << 16),
  HRTIM_OUT_SET_TIMEVNT3  = (1 << 17),
  HRTIM_OUT_SET_TIMEVNT2  = (1 << 18),
  HRTIM_OUT_SET_TIMEVNT1  = (1 << 19),
  HRTIM_OUT_SET_MSTCMP4   = (1 << 20),
  HRTIM_OUT_SET_MSTCMP3   = (1 << 21),
  HRTIM_OUT_SET_MSTCMP2   = (1 << 22),
  HRTIM_OUT_SET_MSTCMP1   = (1 << 23),
  HRTIM_OUT_SET_MSTPER    = (1 << 24),
  HRTIM_OUT_SET_CMP4      = (1 << 25),
  HRTIM_OUT_SET_CMP3      = (1 << 26),
  HRTIM_OUT_SET_CMP2      = (1 << 27),
  HRTIM_OUT_SET_CMP1      = (1 << 28),
  HRTIM_OUT_SET_PER       = (1 << 29),
  HRTIM_OUT_SET_RESYNC    = (1 << 30),
  HRTIM_OUT_SET_SOFT      = (1 << 31)
};

/* Events that can reset TimerX Counter */

enum stm32_hrtim_tim_rst_e
{
  /* Timer owns events */

  HRTIM_RST_UPDT,
  HRTIM_RST_CMP4,
  HRTIM_RST_CMP2,

  /* Master Timer Events */

  HRTIM_RST_MSTCMP4,
  HRTIM_RST_MSTCMP3,
  HRTIM_RST_MSTCMP2,
  HRTIM_RST_MSTCMP1,
  HRTIM_RST_MSTPER,

  /* TimerX events */

  HRTIM_RST_TECMP4,
  HRTIM_RST_TECMP2,
  HRTIM_RST_TECMP1,
  HRTIM_RST_TDCMP4,
  HRTIM_RST_TDCMP2,
  HRTIM_RST_TDCMP1,
  HRTIM_RST_TCCMP4,
  HRTIM_RST_TCCMP2,
  HRTIM_RST_TCCMP1,
  HRTIM_RST_TBCMP4,
  HRTIM_RST_TBCMP2,
  HRTIM_RST_TBCMP1,
  HRTIM_RST_TACMP4,
  HRTIM_RST_TACMP2,
  HRTIM_RST_TACMP1,

  /* External Events */

  HRTIM_RST_EXTEVNT10,
  HRTIM_RST_EXTEVNT9,
  HRTIM_RST_EXTEVNT8,
  HRTIM_RST_EXTEVNT7,
  HRTIM_RST_EXTEVNT6,
  HRTIM_RST_EXTEVNT5,
  HRTIM_RST_EXTEVNT4,
  HRTIM_RST_EXTEVNT3,
  HRTIM_RST_EXTEVNT2,
  HRTIM_RST_EXTEVNT1
};

/* HRTIM Timer X prescaler */

enum stm32_hrtim_tim_prescaler_e
{
  HRTIM_PRESCALER_1,
  HRTIM_PRESCALER_2,
  HRTIM_PRESCALER_4,
  HRTIM_PRESCALER_8,
  HRTIM_PRESCALER_16,
  HRTIM_PRESCALER_32,
  HRTIM_PRESCALER_64,
  HRTIM_PRESCALER_128
};

/* HRTIM Timer Master/Slave mode */

enum stm32_hrtim_mode_e
{
  HRTIM_MODE_PRELOAD = (1 << 0),  /* Preload enable */
  HRTIM_MODE_HALF    = (1 << 1),  /* Half mode */
  HRTIM_MODE_RETRIG  = (1 << 2),  /* Re-triggerable mode */
  HRTIM_MODE_CONT    = (1 << 3),  /* Continuous mode */

  /* Only slave Timers */

  HRTIM_MODE_PSHPLL  = (1 << 7),  /* Push-Pull mode */
};

/* HRTIM Slave Timer auto-delayed mode
 * NOTE: details in STM32F334 Manual
 */

enum stm32_hrtim_autodelayed_e
{
  /* CMP2 auto-delayed mode */

  HRTIM_AUTODELAYED_CMP2_MODE1 = 1, /* DELCMP2 = 01 */
  HRTIM_AUTODELAYED_CMP2_MODE2 = 2, /* DELCMP2 = 10 */
  HRTIM_AUTODELAYED_CMP2_MODE3 = 3, /* DELCMP2 = 11 */

  /* CMP4 auto-delayed mode */

  HRTIM_AUTODELAYED_CMP4_MODE1 = (1 << 2), /* DELCMP4 = 01 */
  HRTIM_AUTODELAYED_CMP4_MODE2 = (2 << 2), /* DELCMP4 = 10 */
  HRTIM_AUTODELAYED_CMP4_MODE3 = (3 << 2), /* DELCMP4 = 11 */
};

/* HRTIM Slave Timer fault sources Lock */

enum stm32_hrtim_tim_fault_lock_e
{
  HRTIM_TIM_FAULT_RW   = 0,         /* Slave Timer fault source are read/write */
  HRTIM_TIM_FAULT_LOCK = (1 << 7)   /* Slave Timer fault source are read only */
};

/* HRTIM Slave Timer Fault configuration */

enum stm32_hrtim_tim_fault_src_e
{
  HRTIM_TIM_FAULT1 = (1 << 0),
  HRTIM_TIM_FAULT2 = (1 << 2),
  HRTIM_TIM_FAULT3 = (1 << 3),
  HRTIM_TIM_FAULT4 = (1 << 4),
  HRTIM_TIM_FAULT5 = (1 << 5)
};

/* HRTIM Fault Source */

enum stm32_hrtim_fault_src_e
{
  HRTIM_FAULT_SRC_PIN      = 0,
  HRTIM_FAULT_SRC_INTERNAL = 1
};

/* HRTIM External Event Source
 * NOTE: according to Table 82 from STM32F334XX Manual.
 */

enum stm32_hrtim_eev_src_e
{
  HRTIM_EEV_SRC_PIN    = 0,
  HRTIM_EEV_SRC_ANALOG = 1,
  HRTIM_EEV_SRC_TRGO   = 2,
  HRTIM_EEV_SRC_ADC    = 3
};

/* HRTIM Fault Polarity */

enum stm32_hrtim_fault_pol_e
{
  HRTIM_FAULT_POL_LOW  = 0,
  HRTIM_FAULT_POL_HIGH = 1
};

/* HRTIM External Event Polarity */

enum stm32_hrtim_eev_pol_e
{
  HRTIM_EEV_POL_HIGH = 0,       /* External Event is active high */
  HRTIM_EEV_POL_LOW  = 1        /* External Event is active low */
};

/* HRTIM External Event sensitivity */

enum stm32_hrtim_eev_sen_e
{
  HRTIM_EEV_SEN_LEVEL   = 0,    /* On active level defined by polarity  */
  HRTIM_EEV_SEN_RISING  = 1,    /* Rising edgne */
  HRTIM_EEV_SEN_FALLING = 2,    /* Falling edge */
  HRTIM_EEV_SEN_BOTH    = 3     /* Both edges */
};

/* External Event Sampling clock division */

enum stm32_hrtim_eev_sampling_e
{
  HRTIM_EEV_SAMPLING_d1 = 0,
  HRTIM_EEV_SAMPLING_d2 = 1,
  HRTIM_EEV_SAMPLING_d4 = 2,
  HRTIM_EEV_SAMPLING_d8 = 3
};

/* HRTIM External Event Mode.
 * NOTE: supported only for EEV1-5.
 */

enum stm32_hrtim_eev_mode_e
{
  HRTIM_EEV_MODE_NORMAL = 0,
  HRTIM_EEV_MODE_FAST   = 1     /* low latency mode */
};


/* External Event filter.
 * NOTE: supported only for EEV6-10.
 */

enum stm32_hrtim_eev_filter_e
{
  HRTIM_EEV_DISABLE    = 0,
  HRTIM_EEV_HRT_N2     = 1,
  HRTIM_EEV_HRT_N4     = 2,
  HRTIM_EEV_HRT_N8     = 3,
  HRTIM_EEV_EEVSd2_N6  = 4,
  HRTIM_EEV_EEVSd2_N8  = 5,
  HRTIM_EEV_EEVSd4_N6  = 6,
  HRTIM_EEV_EEVSd4_N8  = 7,
  HRTIM_EEV_EEVSd8_N6  = 8,
  HRTIM_EEV_EEVSd8_N8  = 9,
  HRTIM_EEV_EEVSd16_N5 = 10,
  HRTIM_EEV_EEVSd16_N6 = 11,
  HRTIM_EEV_EEVSd16_N8 = 12,
  HRTIM_EEV_EEVSd32_N5 = 13,
  HRTIM_EEV_EEVSd32_N6 = 14,
  HRTIM_EEV_EEVSd32_N8 = 15
};

/* Compare register index */

enum stm32_hrtim_cmp_index_e
{
  HRTIM_CMP1,
  HRTIM_CMP2,
  HRTIM_CMP3,
  HRTIM_CMP4
};

/* HRTIM Slave Timer Outputs */

enum stm32_outputs_e
{
  HRTIM_OUT_TIMA_CH1 = (1 << 0),
  HRTIM_OUT_TIMA_CH2 = (1 << 1),
  HRTIM_OUT_TIMB_CH1 = (1 << 2),
  HRTIM_OUT_TIMB_CH2 = (1 << 3),
  HRTIM_OUT_TIMC_CH1 = (1 << 4),
  HRTIM_OUT_TIMC_CH2 = (1 << 5),
  HRTIM_OUT_TIMD_CH1 = (1 << 6),
  HRTIM_OUT_TIMD_CH2 = (1 << 7),
  HRTIM_OUT_TIME_CH1 = (1 << 8),
  HRTIM_OUT_TIME_CH2 = (1 << 9)
};

/* DAC synchronization event */

enum stm32_hrtim_dacsync_e
{
  HRTIM_DACSYNC_DIS,
  HRTIM_DACSYNC_1,
  HRTIM_DACSYNC_2,
  HRTIM_DACSYNC_3
};

/* HRTIM Deadtime Locks */

enum stm32_deadtime_lock_e
{
  HRTIM_DT_VALUE_LOCK = (1 << 0), /* Lock Deadtime value */
  HRTIM_DT_SIGN_LOCK  = (1 << 1)  /* Lock Deadtime sign */
};

/* HRTIM Deadtime types  */

enum stm32_deadtime_edge_e
{
  HRTIM_DT_RISING = 0,
  HRTIM_DT_FALLING = 1
};

/* Chopper start pulsewidth */

enum stm32_chopper_start_e
{
  HRTIM_CHP_START_16,
  HRTIM_CHP_START_32,
  HRTIM_CHP_START_48,
  HRTIM_CHP_START_64,
  HRTIM_CHP_START_80,
  HRTIM_CHP_START_96,
  HRTIM_CHP_START_112,
  HRTIM_CHP_START_128,
  HRTIM_CHP_START_144,
  HRTIM_CHP_START_160,
  HRTIM_CHP_START_176,
  HRTIM_CHP_START_192,
  HRTIM_CHP_START_208,
  HRTIM_CHP_START_224,
  HRTIM_CHP_START_256
};

/* Chopper duty cycle */

enum stm32_chopper_duty_e
{
  HRTIM_CHP_DUTY_0,
  HRTIM_CHP_DUTY_1,
  HRTIM_CHP_DUTY_2,
  HRTIM_CHP_DUTY_3,
  HRTIM_CHP_DUTY_4,
  HRTIM_CHP_DUTY_5,
  HRTIM_CHP_DUTY_6,
  HRTIM_CHP_DUTY_7
};

/* Chopper carrier frequency */

enum stm32_chopper_freq_e
{
  HRTIM_CHP_FREQ_d16,
  HRTIM_CHP_FREQ_d32,
  HRTIM_CHP_FREQ_d48,
  HRTIM_CHP_FREQ_d64,
  HRTIM_CHP_FREQ_d80,
  HRTIM_CHP_FREQ_d96,
  HRTIM_CHP_FREQ_d112,
  HRTIM_CHP_FREQ_d128,
  HRTIM_CHP_FREQ_d144,
  HRTIM_CHP_FREQ_d160,
  HRTIM_CHP_FREQ_d176,
  HRTIM_CHP_FREQ_d192,
  HRTIM_CHP_FREQ_d208,
  HRTIM_CHP_FREQ_d224,
  HRTIM_CHP_FREQ_d240,
  HRTIM_CHP_FREQ_d256
};

/*  */

struct hrtim_dev_s
{
#ifdef CONFIG_HRTIM
  /* Fields managed by common upper half HRTIM logic */

  uint8_t hd_ocount; /* The number of times the device has been opened */
  sem_t hd_closesem; /* Locks out new opens while close is in progress */
#endif

  /* Fields provided by lower half HRTIM logic */

  FAR void *hd_priv; /* Used by the arch-specific logic */
  bool initialized;  /* true: HRTIM driver has been initialized */
};

/************************************************************************************
 * Public Function Prototypes
 ************************************************************************************/

#ifndef __ASSEMBLY__
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif

/****************************************************************************
 * Name: stm32_hrtiminitialize
 *
 * Description:
 *   Initialize the HRTIM.
 *
 * Input Parameters:
 *  None
 *
 * Returned Value:
 *   Valid HRTIM device structure reference on succcess; a NULL on failure.
 *
 * Assumptions:
 *   1. Clock to the HRTIM block has enabled,
 *   2. Board-specific logic has already configured
 *
 ****************************************************************************/

FAR struct hrtim_dev_s* stm32_hrtiminitialize(void);

/****************************************************************************
 * Name: hrtim_register
 ****************************************************************************/

int hrtim_register(FAR const char *path, FAR struct hrtim_dev_s *dev);

#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __ASSEMBLY__ */

#endif /* CONFIG_STM32_HRTIM1 */
#endif /* __ARCH_ARM_SRC_STM32_STM32_HRTIM_H */