FreeHIL
Loading...
Searching...
No Matches
FH_UART_Configs.h File Reference

File Map:
FH_Root, Section FH_Perif, FH_UART, FH_UART_Configs
In this file, different configurations of FH_UART could be set More...

#include "../../../../../FH_Embedded/FH_Setup/FH_DevicePeripherals/FH_DevicePeripherals.h"
#include "../../../../../FH_Embedded/FH_Root/FH_General/FH_ErrorInfo/FH_ErrorInfo.h"
#include "../../../../../FH_Embedded/FH_Setup/FH_RFCommunication/FH_RFCommunication_GlobalVariables.h"

Go to the source code of this file.

Macros

#define FH_UART01
#define FH_UART02
#define FH_UART03
#define FH_UART04
#define FH_UART05
#define FH_UART06
#define FH_UART07
#define FH_UART08
#define FH_UART_MinCommandSize_Init   1
#define FH_UART_MinCommandSize_Send   3
#define FH_UART_MinCommandSize_Receive   1
#define FH_UART_MinCommandSize_ReceiveW   6
#define FH_UART_MinCommandSize_ResetRB   1
#define FH_UART_MinCommandSize_SSD8   3
#define FH_UART_MinCommandSize_SSD16   4
#define FH_UART_MinCommandSize_SSD32   6
#define FH_UART_MinCommandSize_GSD8   1
#define FH_UART_MinCommandSize_GSD16   1
#define FH_UART_MinCommandSize_GSD32   1

Typedefs

typedef FH_ErrorInfo(* FH_UART_Init_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)
typedef FH_ErrorInfo(* FH_UART_Send_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)
typedef FH_ErrorInfo(* FH_UART_Receive_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataSize, uint8_t *FH_UART_Data)
typedef FH_ErrorInfo(* FH_UART_ReceiveW_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataSize, uint8_t *FH_UART_Data)
typedef FH_ErrorInfo(* FH_UART_ResetRB_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)
typedef FH_ErrorInfo(* FH_UART_SSD8_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)
typedef FH_ErrorInfo(* FH_UART_SSD16_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)
typedef FH_ErrorInfo(* FH_UART_SSD32_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)
typedef FH_ErrorInfo(* FH_UART_GSD8_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataLength, uint8_t *FH_UART_FH_UART_Data)
typedef FH_ErrorInfo(* FH_UART_GSD16_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataLength, uint8_t *FH_UART_FH_UART_Data)
typedef FH_ErrorInfo(* FH_UART_GSD32_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataLength, uint8_t *FH_UART_FH_UART_Data)

Enumerations

enum  FH_UART_Commands {
  FH_UART_Commands_Init = 0 , FH_UART_Commands_Send = 1 , FH_UART_Commands_Receive = 2 , FH_UART_Commands_ReceiveW = 3 ,
  FH_UART_Commands_ResetRB = 4 , FH_UART_Commands_SSD8 = 5 , FH_UART_Commands_SSD16 = 6 , FH_UART_Commands_SSD32 = 7 ,
  FH_UART_Commands_GSD8 = 8 , FH_UART_Commands_GSD16 = 9 , FH_UART_Commands_GSD32 = 10
}
enum  FH_UART_Commandelements_Init { UART_Init_PeripheralNumber = 0 }
enum  FH_UART_Commandelements_Send { UART_Send_PeripheralNumber = 0 , UART_Send_DataLength = 1 , UART_Send_Data = 2 }
enum  FH_UART_Commandelements_Receive { UART_Receive_PeripheralNumber = 0 }
enum  FH_UART_Commandelements_ReceiveW { UART_ReceiveW_PeripheralNumber = 0 , UART_ReceiveW_ExpectedDataLength = 1 , UART_ReceiveW_MaxTimerCount = 2 }
enum  FH_UART_Commandelements_ResetRB { UART_ResetRB_PeripheralNumber = 0 }
enum  FH_UART_Commandelements_SSD8 { UART_SSD8_PeripheralNumber = 0 , UART_SSD8_SharedDataLength = 1 , UART_SSD8_SharedData = 2 }
enum  FH_UART_Commandelements_SSD16 { UART_SSD16_PeripheralNumber = 0 , UART_SSD16_SharedDataLength = 1 , UART_SSD16_SharedData = 2 }
enum  FH_UART_Commandelements_SSD32 { UART_SSD32_PeripheralNumber = 0 , UART_SSD32_SharedDataLength = 1 , UART_SSD32_SharedData = 2 }
enum  FH_UART_Commandelements_GSD8 { UART_GSD8_PeripheralNumber = 0 }
enum  FH_UART_Commandelements_GSD16 { UART_GSD16_PeripheralNumber = 0 }
enum  FH_UART_Commandelements_GSD32 { UART_GSD32_PeripheralNumber = 0 }

Detailed Description

File Map:
FH_Root, Section FH_Perif, FH_UART, FH_UART_Configs
In this file, different configurations of FH_UART could be set

Attention
FH user could left this file intact

SPDX-License-Identifier: Apache-2.0

Copyright 2026 Vahid Hasirchi

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

For more information refer to FreeHIL.com

Definition in file FH_UART_Configs.h.

Macro Definition Documentation

◆ FH_UART01

#define FH_UART01

FH_UART01 - FH_UART08 shall be defined here to be utilized in different parts of the FH source code
FH_UART_MaxPeripheralNumber is the maximum number of the FH_UART

Definition at line 48 of file FH_UART_Configs.h.

◆ FH_UART02

#define FH_UART02

Definition at line 51 of file FH_UART_Configs.h.

◆ FH_UART03

#define FH_UART03

Definition at line 54 of file FH_UART_Configs.h.

◆ FH_UART04

#define FH_UART04

Definition at line 57 of file FH_UART_Configs.h.

◆ FH_UART05

#define FH_UART05

Definition at line 60 of file FH_UART_Configs.h.

◆ FH_UART06

#define FH_UART06

Definition at line 63 of file FH_UART_Configs.h.

◆ FH_UART07

#define FH_UART07

Definition at line 66 of file FH_UART_Configs.h.

◆ FH_UART08

#define FH_UART08

Definition at line 69 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_GSD16

#define FH_UART_MinCommandSize_GSD16   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the GSD16 command of UART Function, are defined here

Definition at line 195 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_GSD32

#define FH_UART_MinCommandSize_GSD32   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the GSD32 command of UART Function, are defined here

Definition at line 200 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_GSD8

#define FH_UART_MinCommandSize_GSD8   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the GSD8 command of UART Function, are defined here

Definition at line 190 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_Init

#define FH_UART_MinCommandSize_Init   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the Init command of UART Function, are defined here

Definition at line 150 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_Receive

#define FH_UART_MinCommandSize_Receive   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the Receive command of UART Function, are defined here

Definition at line 160 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_ReceiveW

#define FH_UART_MinCommandSize_ReceiveW   6

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the ReceiveW command of UART Function, are defined here

Definition at line 165 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_ResetRB

#define FH_UART_MinCommandSize_ResetRB   1

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the ResetRB command of UART Function, are defined here

Definition at line 170 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_Send

#define FH_UART_MinCommandSize_Send   3

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the Send command of UART Function, are defined here

Definition at line 155 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_SSD16

#define FH_UART_MinCommandSize_SSD16   4

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the SSD16 command of UART Function, are defined here

Definition at line 180 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_SSD32

#define FH_UART_MinCommandSize_SSD32   6

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the SSD32 command of UART Function, are defined here

Definition at line 185 of file FH_UART_Configs.h.

◆ FH_UART_MinCommandSize_SSD8

#define FH_UART_MinCommandSize_SSD8   3

Minimum size of the Data part in the message frame (FH_RFCommunication_Message) for the SSD8 command of UART Function, are defined here

Definition at line 175 of file FH_UART_Configs.h.

Typedef Documentation

◆ FH_UART_GSD16_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_GSD16_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataLength, uint8_t *FH_UART_FH_UART_Data)

FH_UART_GSD16_FuncPtrModel Function pointer definition

Definition at line 122 of file FH_UART_Configs.h.

◆ FH_UART_GSD32_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_GSD32_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataLength, uint8_t *FH_UART_FH_UART_Data)

FH_UART_GSD32_FuncPtrModel Function pointer definition

Definition at line 127 of file FH_UART_Configs.h.

◆ FH_UART_GSD8_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_GSD8_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataLength, uint8_t *FH_UART_FH_UART_Data)

FH_UART_GSD8_FuncPtrModel Function pointer definition

Definition at line 117 of file FH_UART_Configs.h.

◆ FH_UART_Init_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_Init_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)

FH_UART_Init_FuncPtrModel Function pointer definition

Definition at line 77 of file FH_UART_Configs.h.

◆ FH_UART_Receive_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_Receive_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataSize, uint8_t *FH_UART_Data)

FH_UART_Receive_FuncPtrModel Function pointer definition

Definition at line 87 of file FH_UART_Configs.h.

◆ FH_UART_ReceiveW_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_ReceiveW_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message, uint8_t *FH_UART_DataSize, uint8_t *FH_UART_Data)

FH_UART_ReceiveW_FuncPtrModel Function pointer definition

Definition at line 92 of file FH_UART_Configs.h.

◆ FH_UART_ResetRB_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_ResetRB_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)

FH_UART_ResetRB_FuncPtrModel Function pointer definition

Definition at line 97 of file FH_UART_Configs.h.

◆ FH_UART_Send_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_Send_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)

FH_UART_Send_FuncPtrModel Function pointer definition

Definition at line 82 of file FH_UART_Configs.h.

◆ FH_UART_SSD16_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_SSD16_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)

FH_UART_SSD16_FuncPtrModel Function pointer definition

Definition at line 107 of file FH_UART_Configs.h.

◆ FH_UART_SSD32_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_SSD32_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)

FH_UART_SSD32_FuncPtrModel Function pointer definition

Definition at line 112 of file FH_UART_Configs.h.

◆ FH_UART_SSD8_FuncPtrModel

typedef FH_ErrorInfo(* FH_UART_SSD8_FuncPtrModel) (FH_RFCommunication_Message *fh_RFCommunication_Message)

FH_UART_SSD8_FuncPtrModel Function pointer definition

Definition at line 102 of file FH_UART_Configs.h.

Enumeration Type Documentation

◆ FH_UART_Commandelements_GSD16

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the GSD16 command of UART Function, are defined here

Enumerator
UART_GSD16_PeripheralNumber 

Definition at line 287 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_GSD32

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the GSD32 command of UART Function, are defined here

Enumerator
UART_GSD32_PeripheralNumber 

Definition at line 295 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_GSD8

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the GSD8 command of UART Function, are defined here

Enumerator
UART_GSD8_PeripheralNumber 

Definition at line 279 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_Init

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the Init command of UART Function, are defined here

Enumerator
UART_Init_PeripheralNumber 

Definition at line 205 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_Receive

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the Receive command of UART Function, are defined here

Enumerator
UART_Receive_PeripheralNumber 

Definition at line 223 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_ReceiveW

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the ReceiveW command of UART Function, are defined here

Enumerator
UART_ReceiveW_PeripheralNumber 
UART_ReceiveW_ExpectedDataLength 
UART_ReceiveW_MaxTimerCount 

Definition at line 231 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_ResetRB

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the ResetRB command of UART Function, are defined here

Enumerator
UART_ResetRB_PeripheralNumber 

Definition at line 241 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_Send

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the Send command of UART Function, are defined here

Enumerator
UART_Send_PeripheralNumber 
UART_Send_DataLength 
UART_Send_Data 

Definition at line 213 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_SSD16

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the SSD16 command of UART Function, are defined here

Enumerator
UART_SSD16_PeripheralNumber 
UART_SSD16_SharedDataLength 
UART_SSD16_SharedData 

Definition at line 259 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_SSD32

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the SSD32 command of UART Function, are defined here

Enumerator
UART_SSD32_PeripheralNumber 
UART_SSD32_SharedDataLength 
UART_SSD32_SharedData 

Definition at line 269 of file FH_UART_Configs.h.

◆ FH_UART_Commandelements_SSD8

Different elements of the Data part in the message frame (FH_RFCommunication_Message) for the SSD8 command of UART Function, are defined here

Enumerator
UART_SSD8_PeripheralNumber 
UART_SSD8_SharedDataLength 
UART_SSD8_SharedData 

Definition at line 249 of file FH_UART_Configs.h.

◆ FH_UART_Commands

Different commands for UART Function

Enumerator
FH_UART_Commands_Init 
FH_UART_Commands_Send 
FH_UART_Commands_Receive 
FH_UART_Commands_ReceiveW 
FH_UART_Commands_ResetRB 
FH_UART_Commands_SSD8 
FH_UART_Commands_SSD16 
FH_UART_Commands_SSD32 
FH_UART_Commands_GSD8 
FH_UART_Commands_GSD16 
FH_UART_Commands_GSD32 

Definition at line 132 of file FH_UART_Configs.h.