From d2e42029ec04c3f224580f8007cdfbbfe0fc47a6 Mon Sep 17 00:00:00 2001 From: Fulup Ar Foll Date: Fri, 26 May 2017 18:45:56 +0200 Subject: Initial Commit --- ucs2-lib/doc/html/group___g___u_c_s___l_l_d.html | 150 +++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 ucs2-lib/doc/html/group___g___u_c_s___l_l_d.html (limited to 'ucs2-lib/doc/html/group___g___u_c_s___l_l_d.html') diff --git a/ucs2-lib/doc/html/group___g___u_c_s___l_l_d.html b/ucs2-lib/doc/html/group___g___u_c_s___l_l_d.html new file mode 100644 index 0000000..04e08ad --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___l_l_d.html @@ -0,0 +1,150 @@ + + + + + +UNICENS: Low-Level Driver + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
Logo +
UNICENS V2.1.0-3491
+
User Manual and API Reference
+ +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Topics | +Callback Functions
+
+
Low-Level Driver
+
+
+ +

Provides an interface for Port Message Exchange with the INIC. +More...

+ + + + + + + + +

+Topics

 Low-Level Driver API
 Function pointers to be used by the low-level driver.
 
 Referred Types
 Referred types used by the low-level driver interface.
 
+ + + + + + + + + + + + + + + + +

+Callback Functions

typedef void(* Ucs_Lld_StartCb_t )(Ucs_Lld_Api_t *api_ptr, void *inst_ptr, void *lld_user_ptr)
 Notifies the LLD to start transmitting and receiving messages.
 
typedef void(* Ucs_Lld_StopCb_t )(void *lld_user_ptr)
 Notifies the LLD to stop/abort transmitting and receiving messages.
 
typedef void(* Ucs_Lld_ResetInicCb_t )(void *lld_user_ptr)
 Notifies the LLD to reset the INIC.
 
typedef void(* Ucs_Lld_RxMsgAvailableCb_t )(void *lld_user_ptr)
 Callback function which is invoked as soon as port message objects are available again.
 
typedef void(* Ucs_Lld_TxTransmitCb_t )(Ucs_Lld_TxMsg_t *msg_ptr, void *lld_user_ptr)
 Callback function which is invoked to transmit a single message to the INIC.
 
+

Detailed Description

+

Provides an interface for Port Message Exchange with the INIC.

+

UNICENS provides a certain set of functions which are only dedicated to the low-level driver. The low-level driver API is a set of functions which shall be used by the low-level driver. The low-level driver callbacks is a set of function that shall be implemented by the low-level driver. The low-level driver callbacks shall be assigned to the UNICENS initialization structure. During initialization UNICENS invokes the callback start_fptr and passes the low-level driver API as pointer to Ucs_Lld_Api_t.

+
+
+ + + + + + -- cgit 1.2.3-korg