STM32L4xx_HAL_Driver  1.14.0
TSC Exported Types

Data Structures

struct  TSC_InitTypeDef
 TSC init structure definition. More...
 
struct  TSC_IOConfigTypeDef
 TSC IOs configuration structure definition. More...
 
struct  __TSC_HandleTypeDef
 TSC handle Structure definition. More...
 

Typedefs

typedef struct __TSC_HandleTypeDef TSC_HandleTypeDef
 TSC handle Structure definition. More...
 
typedef void(* pTSC_CallbackTypeDef) (TSC_HandleTypeDef *htsc)
 HAL TSC Callback pointer definition. More...
 

Enumerations

enum  HAL_TSC_StateTypeDef { HAL_TSC_STATE_RESET = 0x00UL, HAL_TSC_STATE_READY = 0x01UL, HAL_TSC_STATE_BUSY = 0x02UL, HAL_TSC_STATE_ERROR = 0x03UL }
 TSC state structure definition. More...
 
enum  TSC_GroupStatusTypeDef { TSC_GROUP_ONGOING = 0x00UL, TSC_GROUP_COMPLETED = 0x01UL }
 TSC group status structure definition. More...
 
enum  {
  TSC_GROUP1_IDX = 0x00UL, TSC_GROUP2_IDX, TSC_GROUP3_IDX, TSC_GROUP4_IDX,
  TSC_GROUP5_IDX, TSC_GROUP6_IDX, TSC_GROUP7_IDX, TSC_GROUP8_IDX,
  TSC_NB_OF_GROUPS
}
 
enum  HAL_TSC_CallbackIDTypeDef { HAL_TSC_CONV_COMPLETE_CB_ID = 0x00UL, HAL_TSC_ERROR_CB_ID = 0x01UL, HAL_TSC_MSPINIT_CB_ID = 0x02UL, HAL_TSC_MSPDEINIT_CB_ID = 0x03UL }
 HAL TSC Callback ID enumeration definition. More...
 

Detailed Description


Data Structure Documentation

◆ TSC_InitTypeDef

struct TSC_InitTypeDef

TSC init structure definition.

Definition at line 67 of file stm32l4xx_hal_tsc.h.

Data Fields
uint32_t AcquisitionMode

Acquisition mode This parameter can be a value of Acquisition Mode

uint32_t ChannelIOs

Channel IOs mask

uint32_t CTPulseHighLength

Charge-transfer high pulse length This parameter can be a value of CTPulse High Length

uint32_t CTPulseLowLength

Charge-transfer low pulse length This parameter can be a value of CTPulse Low Length

uint32_t IODefaultMode

IO default mode This parameter can be a value of IO Default Mode

FunctionalState MaxCountInterrupt

Max count interrupt activation This parameter can be set to ENABLE or DISABLE.

uint32_t MaxCountValue

Max count value This parameter can be a value of Max Count Value

uint32_t PulseGeneratorPrescaler

Pulse generator prescaler This parameter can be a value of Pulse Generator Prescaler

uint32_t SamplingIOs

Sampling IOs mask

uint32_t ShieldIOs

Shield IOs mask

FunctionalState SpreadSpectrum

Spread spectrum activation This parameter can be set to ENABLE or DISABLE.

uint32_t SpreadSpectrumDeviation

Spread spectrum deviation This parameter must be a number between Min_Data = 0 and Max_Data = 127

uint32_t SpreadSpectrumPrescaler

Spread spectrum prescaler This parameter can be a value of Spread Spectrum Prescaler

uint32_t SynchroPinPolarity

Synchro pin polarity This parameter can be a value of Synchro Pin Polarity

◆ TSC_IOConfigTypeDef

struct TSC_IOConfigTypeDef

TSC IOs configuration structure definition.

Definition at line 99 of file stm32l4xx_hal_tsc.h.

Data Fields
uint32_t ChannelIOs

Channel IOs mask

uint32_t SamplingIOs

Sampling IOs mask

uint32_t ShieldIOs

Shield IOs mask

◆ __TSC_HandleTypeDef

struct __TSC_HandleTypeDef

TSC handle Structure definition.

Definition at line 109 of file stm32l4xx_hal_tsc.h.

Data Fields

TSC_TypeDef * Instance
 
TSC_InitTypeDef Init
 
__IO HAL_TSC_StateTypeDef State
 
HAL_LockTypeDef Lock
 
__IO uint32_t ErrorCode
 
void(* ConvCpltCallback )(struct __TSC_HandleTypeDef *htsc)
 
void(* ErrorCallback )(struct __TSC_HandleTypeDef *htsc)
 
void(* MspInitCallback )(struct __TSC_HandleTypeDef *htsc)
 
void(* MspDeInitCallback )(struct __TSC_HandleTypeDef *htsc)
 

Field Documentation

◆ ConvCpltCallback

void(* __TSC_HandleTypeDef::ConvCpltCallback) (struct __TSC_HandleTypeDef *htsc)

TSC Conversion complete callback

Definition at line 118 of file stm32l4xx_hal_tsc.h.

◆ ErrorCallback

void(* __TSC_HandleTypeDef::ErrorCallback) (struct __TSC_HandleTypeDef *htsc)

TSC Error callback

Definition at line 119 of file stm32l4xx_hal_tsc.h.

◆ ErrorCode

__IO uint32_t __TSC_HandleTypeDef::ErrorCode

I2C Error code

Definition at line 115 of file stm32l4xx_hal_tsc.h.

◆ Init

TSC_InitTypeDef __TSC_HandleTypeDef::Init

Initialization parameters

Definition at line 112 of file stm32l4xx_hal_tsc.h.

◆ Instance

TSC_TypeDef* __TSC_HandleTypeDef::Instance

Register base address

Definition at line 111 of file stm32l4xx_hal_tsc.h.

◆ Lock

HAL_LockTypeDef __TSC_HandleTypeDef::Lock

Lock feature

Definition at line 114 of file stm32l4xx_hal_tsc.h.

◆ MspDeInitCallback

void(* __TSC_HandleTypeDef::MspDeInitCallback) (struct __TSC_HandleTypeDef *htsc)

TSC Msp DeInit callback

Definition at line 122 of file stm32l4xx_hal_tsc.h.

◆ MspInitCallback

void(* __TSC_HandleTypeDef::MspInitCallback) (struct __TSC_HandleTypeDef *htsc)

TSC Msp Init callback

Definition at line 121 of file stm32l4xx_hal_tsc.h.

◆ State

__IO HAL_TSC_StateTypeDef __TSC_HandleTypeDef::State

Peripheral state

Definition at line 113 of file stm32l4xx_hal_tsc.h.

Typedef Documentation

◆ pTSC_CallbackTypeDef

typedef void(* pTSC_CallbackTypeDef) (TSC_HandleTypeDef *htsc)

HAL TSC Callback pointer definition.

pointer to an TSC callback function

Definition at line 165 of file stm32l4xx_hal_tsc.h.

◆ TSC_HandleTypeDef

TSC handle Structure definition.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
TSC_GROUP1_IDX 
TSC_GROUP2_IDX 
TSC_GROUP3_IDX 
TSC_GROUP4_IDX 
TSC_GROUP5_IDX 
TSC_GROUP6_IDX 
TSC_GROUP7_IDX 
TSC_GROUP8_IDX 
TSC_NB_OF_GROUPS 

Definition at line 127 of file stm32l4xx_hal_tsc.h.

128 {
129  TSC_GROUP1_IDX = 0x00UL,
133 #if defined(TSC_IOCCR_G5_IO1)
135 #endif
136 #if defined(TSC_IOCCR_G6_IO1)
138 #endif
139 #if defined(TSC_IOCCR_G7_IO1)
141 #endif
142 #if defined(TSC_IOCCR_G8_IO1)
144 #endif
146 };

◆ HAL_TSC_CallbackIDTypeDef

HAL TSC Callback ID enumeration definition.

Enumerator
HAL_TSC_CONV_COMPLETE_CB_ID 

TSC Conversion completed callback ID

HAL_TSC_ERROR_CB_ID 

TSC Error callback ID

HAL_TSC_MSPINIT_CB_ID 

TSC Msp Init callback ID

HAL_TSC_MSPDEINIT_CB_ID 

TSC Msp DeInit callback ID

Definition at line 152 of file stm32l4xx_hal_tsc.h.

◆ HAL_TSC_StateTypeDef

TSC state structure definition.

Enumerator
HAL_TSC_STATE_RESET 

TSC registers have their reset value

HAL_TSC_STATE_READY 

TSC registers are initialized or acquisition is completed with success

HAL_TSC_STATE_BUSY 

TSC initialization or acquisition is on-going

HAL_TSC_STATE_ERROR 

Acquisition is completed with max count error

Definition at line 47 of file stm32l4xx_hal_tsc.h.

◆ TSC_GroupStatusTypeDef

TSC group status structure definition.

Enumerator
TSC_GROUP_ONGOING 

Acquisition on group is on-going or not started

TSC_GROUP_COMPLETED 

Acquisition on group is completed with success (no max count error)

Definition at line 58 of file stm32l4xx_hal_tsc.h.

59 {
60  TSC_GROUP_ONGOING = 0x00UL,
61  TSC_GROUP_COMPLETED = 0x01UL
TSC_GroupStatusTypeDef
TSC group status structure definition.