 |
UNICENS V2.3.0-4567
User Manual and API Reference
|
Release History
V2.3.0
| Release Date: | 2019-06-28 |
| Supported INICs: | See conformity table (Package and Document information) |
Resolved Items
| Type | Description |
|---|---|
| Feature | Added new attribute debug_message_enable to structure Ucs_Rm_InitData_t which allows to make local resource building commands and responses visible to the network. |
| Feature | Introduced the new feature Network Supervisor which is replacing the previous Manager feature. The Network Supervisor introduces the following new API functions:Ucs_Supv_SetMode(), Ucs_Supv_ProgramNode(), Ucs_Supv_ProgramExit() The Network Supervisor introduces the following new attributes in the initialization structure: supv.report_mode_fptr, supv.diag_type, supv.diag_fdx_fptr, supv.diag_hdx_fptr, supv.prog_local_fptr, supv.prog_signature_fptr, supv.prog_event_fptr. |
| Feature | Added new function Ucs_Supv_ProgramCreateIS() to build binary data of INIC identification string. |
| Feature | Added new functions Ucs_Network_RegisterAliveCb() and Ucs_Network_UnRegisterAliveCb() to support the reception of alive messages. |
| Feature | Added new symbol UCS_NW_AVAIL_INFO_FALLBACK to structure Ucs_Network_AvailInfo_t. |
| Feature | Added new symbols UCS_RM_EP_DC_SOURCE and UCS_RM_EP_DC_SINK to structure Ucs_Rm_EndPointType_t. |
| Feature | Added new structure Ucs_Rm_DC_EndPoint_t. |
| Feature | Added new attribute static_connection in structure Ucs_Rm_Route_t. |
| Feature | Added new symbols UCS_XRM_RC_TYPE_DC_SOCKET and UCS_XRM_RC_TYPE_DC_CON in enum Ucs_Xrm_ResourceType_t. |
| Feature | Added new structure Ucs_Xrm_SocketType_t. |
| Change | Renamed attribute atd_enabled into atd in structure Ucs_Rm_Route_t. The attribute atd now comprises enabled and clk_config as own attributes. |
| Change | Due to the introduction of the Network Supervisor the attribute mgr was renamed to supv within the structure Ucs_InitData_t.Replaced the attribute mgr.enabled by supv.mode in the initialization structure. |
| Change | Due to the introduction of the Network Supervisor some API functions may return UCS_RET_ERR_NOT_SUPPORTED during a certain Network Supervisor Mode. Please refer to the chapter Network Supervisor - Getting Started. |
| Change | Due to the introduction of the Network Supervisor the application does no longer need to call certain API functions. The following API functions are removed:Ucs_Rm_Start(), Ucs_Rm_SetNodeAvailable(), Ucs_Rm_GetAttachedRoutes(), Ucs_Network_Startup(), Ucs_Network_Shutdown(), Ucs_Network_ForceNotAvailable(), Ucs_Ns_SynchronizeNode(), Ucs_Nd_Start(), Ucs_Nd_Stop(), Ucs_Nd_InitAll(), Ucs_Diag_StartFdxDiagnosis(), Ucs_Diag_StartHdxDiagnosis() |
| Change | Due to the introduction of the Network Supervisor the application does no longer need to assign certain callback functions. The following callback functions are removed from the initialization structure:nd.report_fptr, nd.eval_fptr |
| Change | Due to the introduction of the Network Supervisor the following types are removed from API:Ucs_Nd_ResCode_t, Ucs_Nd_CheckResult_t, Ucs_Nd_EvalCb_t, Ucs_Nd_ReportCb_t |
| Change | Removed symbols UCS_PRG_ST_CS_IS, UCS_PRG_ST_ERASE_EM and UCS_PRG_ST_CFG_READ in enum Ucs_Prg_SessionType_t. |
| Change | Renamed attribute data_length to data_size in structure Ucs_Prg_Command_t. |
| Change | Renamed attribute data to data_ptr in structure Ucs_Prg_Command_t. |
| Change | Changed signature of function Ucs_Network_GetNodesCount() to return a standard error type Ucs_Return_t. |
| Change | Changed signature of callback function type Ucs_Prg_ReportCb_t. Added new structure Ucs_Prg_Report_t to report programming result. |
| Change | Renamed attribute signature to signature_ptr in structure Ucs_Hdx_Report_t. |
| Change | Removed symbol UCS_FBP_RES_ALIVE in enum Ucs_Fbp_ResCode_t. Use the new function Ucs_Network_RegisterAliveCb() to receive alive messages. |
| Change | Removed parameters UCS_STREAM_PORT_CLK_CFG_8FS and UCS_STREAM_PORT_CLK_CFG_16FS in Ucs_Stream_PortClockConfig_t and added UCS_STREAM_PORT_CLK_CFG_NONE, which can be used as default for the ATD feature. |
| Defect | Fixed issue: Disabling route activity leads to destruction of resources at local node in loop forever. |
| Defect | Fixed issue: Callback function Ucs_Ns_ResultCb_t is not invoked whenever NULL value is given to the data pointer of expected result in the script. |
| Defect | Fixed issue: Undefined behavior during asynchronous calls of the ATD feature. |
| Defect | Fixed issue: Route build is started when only one node is available. |
| Defect | Fixed issue: Callback function Ucs_Rm_ReportCb_t is not invoked when route is set to inactive by using API Ucs_Rm_SetRouteActive(). |
| Defect | Fixed issue: Synchronous error UCS_RET_ERR_API_LOCKED occurs if application calls Ucs_Gpio_CreatePort() back to back. |
| Defect | Fixed issue: UCS_RES_ERR_TIMEOUT is returned as an asynchronous response of Ucs_Xrm_Stream_SetPortConfig(). |
| Defect | Fixed issue: Programming the local node does not work as intended. |
| Defect | Fixed issue: Not possible to program more than 255 bytes |
| Defect | Fixed issue: When ENC.Welcome.Result from a node is lost the node will be invisible for UNICENS. |
| Defect | Fixed issue: Node discovery stop is not happening after NET_OFF. |
| Defect | Fixed issue: Identification String of OS8121x Rev.B1A was not supported. |
| Defect | Fixed issue: Undefined behavior when terminating Management Library during full-duplex diagnosis. |
| Defect | Fixed issue: Missing range check for node position address in Ucs_Prog_Start(). |
| Defect | Fixed issue: Callback function debug_resource_status_fptr is not invoked. |
| Defect | Fixed issue: Node initialization scripts may be aborted unintentionally and might fail the next retry attempt. |
| Defect | Fixed issue: Documentation of function Ucs_Network_SetPacketFilterMode() states a restriction which is not true. |
| Defect | Fixed issue: Documentation of Protocol Library declares macros UCS_FOOTPRINT_DISABLE_AMS and UCS_NS_CONST that are not valid in Protocol Library. |
Known Issues
- Application messages sent to the target address UCS_ADDR_BROADCAST_BLOCKING will be sent to the target address UCS_ADDR_BROADCAST_UNBLOCKING. I.e., the blocking broadcast feature is disabled in this release.
V2.2.0
| Release Date: | 2018-10-08 |
| Supported INICs: | See conformity table (Package and Document information) |
Resolved Items
| Type | Description |
|---|---|
| Feature | Added new symbols UCS_STREAM_PORT_ALGN_TDM16BIT and UCS_STREAM_PORT_ALGN_TDM24BIT to support TDM. |
| Feature | Added new symbol UCS_STREAM_PORT_CLK_DLY_BDO to support TDM. |
| Feature | Added new function Ucs_Diag_StartFdxDiagnosis() to start the FullDuplexDiagnosis. |
| Feature | Added new function Ucs_Network_SetPacketFilterMode(). |
| Feature | Added new function Ucs_Ns_SynchronizeNode() which is available if mgr.enabled is false. |
| Feature | Added new configuration macro UCS_FOOTPRINT_DISABLE_AMS to disable AMS related code sections and data for a smaller memory footprint. |
| Feature | Added automatic script execution of Ucs_Rm_Node_t::init_script_list_ptr if mgr.enabled is true.Added new report codes UCS_MGR_REP_SCRIPT_FAILURE, UCS_MGR_REP_SCRIPT_SUCCESS and UCS_MGR_REP_IRRECOVERABLE notified in callback function mgr.report_fptr. |
| Feature | Added new enum symbol UCS_MGR_REP_WELCOMED notified as parameter code in callback function mgr.report_fptr. The parameter node_ptr now is only valid of the code UCS_MGR_REP_WELCOMED is notified. Otherwise it is NULL. |
| Feature | Replaced attribute node_address by signature_ptr in mgr.report_fptr. The callback function now provides the full signature of the node. |
| Feature | Added more detailed information in node scripting result callback function. Replaced result code UCS_NS_RES_ERROR by several more detailed codes in Ucs_Ns_ResultCode_t. Added new parameter error_info in result callback function. |
| Feature | Added MISRA-C-2004 Report and MISRA Deviation Matrix. |
| Feature | Added new configuration macro UCS_NS_CONST to reduce the RAM footprint. The configuration allows to store node scripts in ROM. |
| Feature | Added Ucs_Rm_Atd_t structure to Ucs_Rm_Route_t structure which needs to be filled for ATD calculation. |
| Feature | Added Ucs_Rm_StaticConnection_t structure to Ucs_Rm_Route_t structure which is needed for proxy channel usage and hidden Fallback mode enable parameter. |
| Feature | Added Ucs_Rm_DC_EndPoint_t structure , Ucs_Rm_EndPointType_t::UCS_RM_EP_DC_SOURCE and Ucs_Rm_EndPointType_t::UCS_RM_EP_DC_SINK to enable the build of half default created routes. |
| Change | Renamed BackChannelDiagnosis to HalfDuplexDiagnosis. API functions are Ucs_Diag_StartHdxDiagnosis() and Ucs_Diag_HdxReportCb_t. |
| Change | Added new callback function lld.reset_fptr which is mandatory for the Low-Level Driver. N.B., Ucs_Init() will fail if this function is not assigned. |
| Change | Removed superfluous parameter node_position in callback function network.status.cb_fptr. Removed bit 5 in related notification_mask and change_mask. |
| Change | Replaced the parameter node_ptr by node_address in the following functions and callback types: Ucs_Ns_Run(), Ucs_Ns_ResultCb_t, Ucs_Rm_SetNodeAvailable(), Ucs_Rm_GetNodeAvailable(). |
| Change | Renamed Ucs_Rm_Node_t::script_list_ptr to Ucs_Rm_Node_t::init_script_list_ptr. Renamed Ucs_Rm_Node_t::script_list_size to Ucs_Rm_Node_t::init_script_list_size. |
| Change | If mgr.enabled is false and a node is "welcomed", it is now required to call Ucs_Ns_SynchronizeNode() and wait for the result callback before calling one of the following functions for the related node_address: Ucs_Ns_Run(), Ucs_Network_SetPacketFilterMode(), Ucs_Rm_SetNodeAvailable(), Ucs_Gpio_xxx(), Ucs_I2c_xxx(). |
| Change | Renamed all attributes of Ucs_Ns_ConfigMsg_t structure to match the "lower case with underscore" style. |
| Change | Renamed macro UCS_ADDR_LOCAL_DEV to UCS_ADDR_LOCAL_NODE. |
| Change | Extended the range of macro UCS_XRM_NUM_JOBS and macro UCS_XRM_NUM_RESOURCES from 254 to 65534. |
| Change | Renamed the following types: Msg_MostTel_t - new name is Ucs_Message_t, Ucs_Xrm_MostSocket_t - new name is Ucs_Xrm_NetworkSocket_t, Ucs_Most_SocketDataType_t - new name is Ucs_Network_SocketDataType_t, Ucs_Most_PortAvail_t - new name is Ucs_Network_PortAvail_t, Ucs_Most_PortAvailInfo_t - new name is Ucs_Network_PortAvailInfo_t, Ucs_Xrm_Most_PortStatusCb_t - new name is Ucs_Xrm_NetworkPortStatusCb_t |
| Change | Renamed the following enum symbols: UCS_XRM_RC_TYPE_MOST_SOCKET - new name is UCS_XRM_RC_TYPE_NW_SOCKET, UCS_MOST_SCKT_SYNC_DATA - new name is UCS_NW_SCKT_SYNC_DATA, UCS_MOST_SCKT_AV_PACKETIZED - new name is UCS_NW_SCKT_AV_PACKETIZED, UCS_MOST_SCKT_QOS_IP - new name is UCS_NW_SCKT_QOS_IP, UCS_MOST_SCKT_DISC_FRAME_PHASE - new name is UCS_NW_SCKT_DISC_FRAME_PHASE, UCS_MOST_PORT_AVAIL - new name is UCS_NW_PORT_AVAIL, UCS_MOST_PORT_NOT_AVAIL - new name is UCS_NW_PORT_NOT_AVAIL, UCS_MOST_PRT_AVL_INF_REGULAR - new name is UCS_NW_PORT_AVAIL_INFO_REGULAR, UCS_MOST_PRT_AVL_INF_UNSTABLE - new name is UCS_NW_PORT_AVAIL_INFO_UNSTABLE, UCS_MOST_PRT_AVL_INF_STABLE - new name is UCS_NW_PORT_AVAIL_INFO_STABLE |
| Change | Changed signature of function Ucs_Cmd_DecodeMsg(). The function now returns a callback function. |
| Change | Changed return type of function Ucs_Cmd_AddMsgIdTable() and Ucs_Cmd_RemoveMsgIdTable() to Ucs_Return_t. |
| Change | Improved description of Ucs_AmsTx_Msg_t::destination_address and possible AMS transmission result codes. |
| Defect | Fixed issue: Manager may not detect one or multiple Remote Nodes in certain situations. |
| Defect | Fixed issue: Manager may not discover nodes after starting the network. Nodes are not initialized and routes are not built. |
| Defect | Fixed issue: Initial script for root node may fail if it is started before INIC.NetworkStatus.Status() announces the local node address. |
| Defect | Fixed issue: Race condition when building routes during network shutdown may lead to a route , there might be race conditions. Added exception: Error NetworkSocketCreate is handled uncritical. |
| Defect | Fixed GCC compiler warnings when compiling with option -Wconversion. |
V2.1.0
| Release Date: | 2017-05-26 |
| Supported INICs: | See conformity table (Package and Document information) |
Resolved Items
| Type | Description |
|---|---|
| Feature | Product released under BSD 3-Clause License. |
| Feature | Introduced so called "Manager" that forces the network to available, handles NodeDiscovery events and notifies the availability of nodes to the RoutingManagement. See related sections in API Reference or Getting Started. |
| Feature | Added Application Message API into Management Library. Added option to disable the Application Message Service within the initialization stucture. |
| Feature | Added new functions Ucs_Rm_GetAttachedRoutes() and Ucs_Rm_GetConnectionLabel(). |
| Feature | Added support for node scripting. |
| Feature | Added support for reusable description of XRM resources. |
| Feature | Extended Ucs_Rm_XrmResDebugCb_t callback function to provide additional information related to endpoint. |
| Feature | Added new callback function network.status.cb_fptr and option network.status.notification_mask. |
| Feature | Added new API function Ucs_Network_GetFrameCounter(). |
| Feature | Added new API function Ucs_Network_GetNodesCount(). |
| Feature | Added new configuration macro UCS_FOOTPRINT_TINY that decreases RAM/ROM footprint for tiny controllers. |
| Feature | Added new macros UCS_VERSION_MAJOR, UCS_VERSION_MINOR, UCS_VERSION_RELEASE and UCS_VERSION_BUILD. |
| Change | Renamed attribute disable_inic_watchdog to inic_watchdog_enabled in Ucs_General_InitData_t. |
| Change | Changed signature of the trace macros UCS_TR_INFO and UCS_TR_ERROR. Added new parameter ucs_user_ptr of type void * that replaced the existing one ucs_inst_id. |
| Change | Renamed Ucs_Xrm_ResourceDebugCb_t to Ucs_Rm_XrmResDebugCb_t and moved the reference debug_resource_status_fptr into Ucs_Rm_InitData_t. |
| Change | Removed API functions Ucs_I2c_SyncDevice() and Ucs_Gpio_SyncDevice(). |
| Defect | Fixed issue: Library crash when calling I2C API. |
| Defect | Fixed issue: Ucs_Rm_ReportCb_t() is not called after Ucs_Stop(). |
| Defect | Improved robustness and maintainability of routing management. |
| Defect | Removed unused symbol UCS_AMSTX_RES_ERR_BUF_INTERNAL in enum Ucs_AmsTx_Result_t. |
| Defect | Fixed wrong attribute names in AMS message structures of Getting Started. |
V2.0.0
| Release Date: | 2016-09-30 |
| Supported INICs: | See conformity table (Package and Document information) |
Resolved Items
| Type | Description |
|---|---|
| Note | Initial Version |