HAL Q use cases ¶

Q Sequence Diagram ¶

$@startuml hide footbox participant "User Application" as part1 participant "System" as part2 participant "Q Driver" as part3 participant "PPP Driver" as part4 group #GreenYellow System initialization part1->part2 : HAL_Init() part1->part2 : Configure system clock end group #LimeGreen PPP Node Building group #FFB133 PPP driver group #lightblue Mandatory part1->part4 : HAL_PPP_FillNodeConfig() note right : Create all nodes to be used within Q end end group #FFB133 Q Building group #lightblue Mandatory part1->part3 : HAL_Q_Init(..., <b>&HAL_PPP_{mode}_DescOps/HAL_PPP_DescOps) note right : Q initialization according to PPP descriptor operation constant end group #lightblue Mandatory part1->part4 : HAL_Q_InsertNode() / HAL_Q_InsertNode_Head() / HAL_Q_InsertNode_Tail() note right : this operation can be repeated according to the Q node number to be inserted end group #LightYellow Optional part1->part4 : HAL_Q_RemoveNode() / HAL_Q_RemoveNode_Head() / HAL_Q_RemoveNode_Tail() note right : this operation can be repeated according to the Q node number to be removed end group #LightYellow Optional part1->part4 : HAL_Q_ReplaceNode() / HAL_Q_ReplaceNode_Head() / HAL_Q_ReplaceNode_Tail() note right : this operation can be repeated according to the Q node number to be replaced end group #LightYellow Optional part1->part4 : HAL_Q_InsertQ() / HAL_Q_InsertQ_Head() / HAL_Q_InsertQ_Tail() note right : this operation can be repeated according to the source Q number to be inserted within destination Q end group #LightYellow Optional part1->part4 : HAL_Q_SetCircularLinkQ() / HAL_Q_SetCircularLinkQ_Head() / HAL_Q_SetCircularLinkQ_Tail() note right : this operation is need when the Q is linear and the application needs circular Q end group #LightYellow Optional part1->part4 : HAL_Q_ClearCircularLinkQ() note right : this operation is need when the Q is circular and the application needs linear Q end end end @enduml$

Functions called: