TUART1_STM32F429 Class Reference

STM32F429 on-chip UART1 hardware abstraction layer class. More...

#include <UART1_STM32F429.h>

Inheritance diagram for TUART1_STM32F429:

Collaboration diagram for TUART1_STM32F429:

Classes
struct	TSend_Buffer
	Send buffer structure datatype definition. More...

Public Member Functions
VOID	Init ()
	Object initialisation method. More...
VOID	Done ()
	Object finalisation method. More...
VOID	Start_RX_Operation ()
	Start RX operation. More...
VOID	Stop_RX_Operation ()
	Stop RX operation. More...
VOID	Start_TX_Operation ()
	Start TX operation. More...
VOID	Stop_TX_Operation ()
	Stop TX operation. More...
VOID	Interrupt_Enable (U32 u32_Priority)
	Enable interrupt method. More...
VOID	Interrupt_Disable ()
	Disable interrupt method. More...
VOID	Interrupt ()
	Interrupt service method. More...
Public Member Functions inherited from TCommunication_Link
	TCommunication_Link ()
	Class constructor method. More...
	~TCommunication_Link ()
	Class destructor method. More...
VOID	Init ()
	Initialisation method. More...
VOID	Done ()
	Finalisation method. More...
virtual VOID	PIO_Init ()=0
	PIO initialisation method. More...
virtual VOID	PIO_Done ()=0
	PIO reinitialisation as GPIO method. More...
VOID	Start ()
	Start operation method. More...
VOID	Stop ()
	Stop operation method. More...
VOID	Interrupt_Enable (U32 u32_Priority)
	Interrupt enabale method. More...
VOID	Interrupt_Disable ()
	Interrupt disable method. More...
VOID	Interrupt ()
	Data receive and data transmitted interrupt service method. More...
VOID	RX_Interrupt ()
	Data receive interrupt service method. More...
VOID	TX_Interrupt ()
	Data transmitted interrupt service method. More...
VOID	Log_Recieved_Byte_Count ()
	Log recieved byte count. More...
VOID	Log_Empty_Data_Error ()
	Log empty data error. No data received but interrupt was generated. More...
VOID	Log_Frame_Error ()
	Log frame error. More...
VOID	Log_Overrun_Error ()
	Log buffer overrun error. More...
VOID	Log_Parity_Error ()
	Log parity error. More...
VOID	Log_Noise_Error ()
	Log noise error. More...
U64	Get_Empty_Data_Error_Count ()
	Get rec empty data error count. More...
U64	Get_Recieved_Byte_Count ()
	Get recieved byte count. More...
U64	Get_Frame_Error_Count ()
	Get frame error count. More...
U64	Get_Overrun_Error_Count ()
	Get buffer overrun error count. More...
U64	Get_Parity_Error_Count ()
	Get parity error count. More...
U64	Get_Noise_Error_Count ()
	Get noise error count. More...
virtual VOID	Execute_1ms ()
	1 ms cyclic execution method More...
virtual VOID	Execute ()
	Background cyclic execution method. More...
Public Member Functions inherited from TCommunication_Data_Link
	TCommunication_Data_Link ()
	Class constructor method. More...
VOID	Connect_Data_Link (TCommunication_Data_Link *object_New_Data_Link)
	Connect data link method. More...
VOID	Disconnect_Data_Link ()
	Disconnect data link method. More...

Protected Member Functions
virtual VOID	Communication_Data_Transmit (U8 u8_Transmit_Value)
	Transmit data method. More...
Protected Member Functions inherited from TCommunication_Link
virtual VOID	Set_Transmit_Mode ()
	Set transmit mode method. More...
virtual VOID	Set_Receive_Mode ()
	Set receive mode method. More...
Protected Member Functions inherited from TCommunication_Data_Link
virtual VOID	Communication_Data_Receive (U8 u8_Receive_Value)
	Communication data receive method. More...
virtual VOID	Communication_Block_Data_Receive (VOID *void_Receive_Data)
	Communication data receive method. More...
virtual VOID	Communication_Block_Data_Transmit (VOID *void_Receive_Data)
	Communication data transmit method. More...

Private Attributes
BOOL	bool_RX_Operation_Enabled
	RX operation enabled status flag. More...
BOOL	bool_TX_Operation_Enabled
	TX operation enabled status flag. More...
volatile BOOL	bool_Transmiting_Active
	Transmiting active status flag. More...
volatile TSend_Buffer	struct_Send_Buffer [UART1_TX_BUFFER_SIZE]
	Buffer for data transmitting. More...
volatile U16	u16_Buffer_Count
	Count for struct_Send_Buffer. More...
volatile U16	u16_Transmission_Data_Index
	Count data index for transmiting. More...

Additional Inherited Members
Protected Attributes inherited from TCommunication_Link
TExecution_Profile	object_Execution_Profile
	Execution profile object. More...
Protected Attributes inherited from TCommunication_Data_Link
TCommunication_Data_Link *	object_Data_Link = (TCommunication_Data_Link*)NULL
	Pointer to the data link object. More...

Detailed Description

STM32F429 on-chip UART1 hardware abstraction layer class.

Member Function Documentation

Communication_Data_Transmit()

VOID TUART1_STM32F429::Communication_Data_Transmit ( U8  u8_Transmit_Value )

protectedvirtual

Transmit data method.

---

Note

This method adds data to the internal queue.

Parameters

[in]

u8_Transmit_Value

- Value for transmitting

Returns

None

Override

Not allowed

Attention

None

Todo:

ANVILEX KM: Rework waiting for empying of the buffer.

Todo:

ANVILEX KM: Optimise this loop to prevent getting current timestamp if buffer is not full

Todo:

ANVILEX KM: Timeout must be based on actual transmition speed to prevent freeze background task execution.

Todo:

ANVILEX KM: Log error

Todo:

ANVILEX KM: This code is not requered, UART interrupt can not be entered twice. Candidat to remove.

Todo:

ANVILEX KM: May be we need add waiting for emptying buffer hier

Todo:

ANVILEX KM: This code is not requered, UART interrupt can not be entered twice. Candidat to remove.

Reimplemented from TCommunication_Data_Link.

References TUART1_STM32F429::TSend_Buffer::bool_Data_Status, bool_Transmiting_Active, bool_TX_Operation_Enabled, TSystem_Timer_Base::Get_Actual_Time(), Increment_Overflowed(), Interrupt_Disable(), Interrupt_Enable(), TSystem_Timer_Base::Is_Timeout_ms(), object_System_Timer, TCommunication_Link::Set_Transmit_Mode(), struct_Send_Buffer, u16_Buffer_Count, TUART1_STM32F429::TSend_Buffer::u8_Data, and UART1_TX_BUFFER_SIZE.

Here is the call graph for this function:

Done()

VOID TUART1_STM32F429::Done

(

)

Object finalisation method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References TCommunication_Link::PIO_Done(), Stop_RX_Operation(), and Stop_TX_Operation().

Here is the call graph for this function:

Init()

VOID TUART1_STM32F429::Init

(

)

Object initialisation method.

---

Note

None

Returns

None

Override

Not allowed

Attention

None

References __UART_BRR_SAMPLING16, TUART1_STM32F429::TSend_Buffer::bool_Data_Status, bool_RX_Operation_Enabled, bool_Transmiting_Active, bool_TX_Operation_Enabled, TCPU_STM32F429::Get_PCLK2_Frequency(), TCommunication_Link::Init(), object_System_CPU, TCommunication_Link::PIO_Init(), TCommunication_Link::Set_Receive_Mode(), struct_Send_Buffer, u16_Buffer_Count, u16_Transmission_Data_Index, TUART1_STM32F429::TSend_Buffer::u8_Data, and UART1_TX_BUFFER_SIZE.

Here is the call graph for this function:

Interrupt()

VOID TUART1_STM32F429::Interrupt

(

)

Interrupt service method.

---

Note

None

Returns

None

Override

Not allowed / Requered / Optional

Attention

None

References TUART1_STM32F429::TSend_Buffer::bool_Data_Status, bool_RX_Operation_Enabled, bool_Transmiting_Active, bool_TX_Operation_Enabled, TCommunication_Data_Link::Communication_Data_Receive(), false, Increment_Overflowed(), TCommunication_Link::Log_Frame_Error(), TCommunication_Link::Log_Noise_Error(), TCommunication_Link::Log_Parity_Error(), TCommunication_Link::Log_Recieved_Byte_Count(), TCommunication_Link::Set_Receive_Mode(), struct_Send_Buffer, u16_Transmission_Data_Index, and UART1_TX_BUFFER_SIZE.

Here is the call graph for this function:

Interrupt_Disable()

VOID TUART1_STM32F429::Interrupt_Disable

(

)

Disable interrupt method.

---

Note

None

Returns

None

Override

Not allowed / Requered / Optional

Attention

None

Referenced by Communication_Data_Transmit(), Stop_RX_Operation(), and Stop_TX_Operation().

Here is the caller graph for this function:

Interrupt_Enable()

VOID TUART1_STM32F429::Interrupt_Enable

(

U32

u32_Priority

)

Enable interrupt method.

---

Note

None

Parameters

[in]

u32_Priority

- Interrupt priority

Returns

None

Override

Not allowed / Requered / Optional

Attention

None

Referenced by Communication_Data_Transmit(), Start_RX_Operation(), and Start_TX_Operation().

Here is the caller graph for this function:

Start_RX_Operation()

VOID TUART1_STM32F429::Start_RX_Operation

(

)

Start RX operation.

---

Note

Calling this method enables RX operation of the UART.

Returns

None

Override

Not allowed

Attention

None

References bool_RX_Operation_Enabled, and Interrupt_Enable().

Here is the call graph for this function:

Start_TX_Operation()

VOID TUART1_STM32F429::Start_TX_Operation

(

)

Start TX operation.

---

Note

Calling this method enables RX operation of the UART.

Returns

None

Override

Not allowed

Attention

None

References bool_TX_Operation_Enabled, and Interrupt_Enable().

Here is the call graph for this function:

Stop_RX_Operation()

VOID TUART1_STM32F429::Stop_RX_Operation

(

)

Stop RX operation.

---

Note

Calling this method enables RX operation of the UART.

Returns

None

Override

Not allowed

Attention

None

References bool_RX_Operation_Enabled, bool_TX_Operation_Enabled, Interrupt_Disable(), and true.

Referenced by Done().

Here is the call graph for this function:

Here is the caller graph for this function:

Stop_TX_Operation()

VOID TUART1_STM32F429::Stop_TX_Operation

(

)

Stop TX operation.

---

Note

Calling this method enables RX operation of the UART.

Returns

None

Override

Not allowed

Attention

None

References bool_RX_Operation_Enabled, bool_TX_Operation_Enabled, Interrupt_Disable(), and true.

Referenced by Done().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool_RX_Operation_Enabled

BOOL TUART1_STM32F429::bool_RX_Operation_Enabled

private

RX operation enabled status flag.

Referenced by Init(), Interrupt(), Start_RX_Operation(), Stop_RX_Operation(), and Stop_TX_Operation().

bool_Transmiting_Active

volatile BOOL TUART1_STM32F429::bool_Transmiting_Active

private

Transmiting active status flag.

Referenced by Communication_Data_Transmit(), Init(), and Interrupt().

bool_TX_Operation_Enabled

BOOL TUART1_STM32F429::bool_TX_Operation_Enabled

private

TX operation enabled status flag.

Referenced by Communication_Data_Transmit(), Init(), Interrupt(), Start_TX_Operation(), Stop_RX_Operation(), and Stop_TX_Operation().

struct_Send_Buffer

volatile TSend_Buffer TUART1_STM32F429::struct_Send_Buffer[UART1_TX_BUFFER_SIZE]

private

Buffer for data transmitting.

Referenced by Communication_Data_Transmit(), Init(), and Interrupt().

u16_Buffer_Count

volatile U16 TUART1_STM32F429::u16_Buffer_Count

private

Count for struct_Send_Buffer.

Referenced by Communication_Data_Transmit(), and Init().

u16_Transmission_Data_Index

volatile U16 TUART1_STM32F429::u16_Transmission_Data_Index

private

Count data index for transmiting.

Referenced by Init(), and Interrupt().

---

The documentation for this class was generated from the following files:

• ConOpSys/Targets/STM32F429/UART1_STM32F429.h
• ConOpSys/Targets/STM32F429/UART1_STM32F429.cpp