Logo
UNICENS V2.1.0-3491
User Manual and API Reference

Provides network management functions. More...

Topics

 Referred Types
 Provides network management functions.
 

Data Structures

struct  Ucs_Network_InitData_t
 The network section of the UNICENS initialization data. More...
 

Callback Functions

typedef void(* Ucs_Network_StatusCb_t )(uint16_t change_mask, uint16_t events, Ucs_Network_Availability_t availability, Ucs_Network_AvailInfo_t avail_info, Ucs_Network_AvailTransCause_t avail_trans_cause, uint16_t node_address, uint8_t node_position, uint8_t max_position, uint16_t packet_bw, void *user_ptr)
 Function signature used for the Network Status callback function.
 
typedef void(* Ucs_Network_FrameCounterCb_t )(uint32_t reference, uint32_t frame_counter, bool frame_lock, Ucs_StdResult_t result, void *user_pointer)
 Function signature of result callback used by Ucs_Network_GetFrameCounter().
 

Functions

Ucs_Return_t Ucs_Network_Startup (Ucs_Inst_t *self, uint16_t packet_bw, uint16_t forced_na_timeout, Ucs_StdResultCb_t result_fptr)
 Starts up the MOST Network.
 
Ucs_Return_t Ucs_Network_Shutdown (Ucs_Inst_t *self, Ucs_StdResultCb_t result_fptr)
 Switches of the MOST Network.
 
Ucs_Return_t Ucs_Network_ForceNotAvailable (Ucs_Inst_t *self, bool force, Ucs_StdResultCb_t result_fptr)
 Triggers the INIC to force the NotAvailable state.
 
Ucs_Return_t Ucs_Network_GetFrameCounter (Ucs_Inst_t *self, uint32_t reference, Ucs_Network_FrameCounterCb_t result_fptr)
 Retrieves the Network Frame Counter, which is the number of frames since reset.
 
uint8_t Ucs_Network_GetNodesCount (Ucs_Inst_t *self)
 Retrieves the number of nodes within the MOST network.
 

Detailed Description

Provides network management functions.