Multimedia and Control Networking Technology MOST NetServices V3.0.x History Sheet Document Information: Version: 3.0.x-7 Date: 2012-01-31 MOST® Media Oriented Systems Transport Copyright © 1998 - 2012 SMSC MOST NetServices V3.0.x V3.0.x-SR-2 Further Information For more information on SMSC’s automotive products, including integrated circuits, software, and MOST development tools and modules, visit our web site: http://www.smsc-ais.com. Direct contact information is available at: http://www.smsc-ais.com/offices. SMSC Europe GmbH Bannwaldallee 48 76185 Karlsruhe GERMANY SMSC 80 Arkay Drive Hauppauge, New York 11788 USA Technical Support Contact information for technical support is available at: http://www.smsc-ais.com/contact. Legend Copyright © 1998 - 2012 SMSC. All rights reserved. Please make sure that all information within a document marked as ‘Confidential’ or ‘Restricted Access’ is handled solely in accordance with the agreement pursuant to which it is provided, and is not reproduced or disclosed to others without the prior written consent of SMSC. The confidential ranking of a document can be found in the footer of every page. This document supersedes and replaces all information previously supplied. The technical information in this document loses its validity with the next edition. Although the information is believed to be accurate, no responsibility is assumed for inaccuracies. Specifications and other documents mentioned in this document are subject to change without notice. SMSC reserves the right to make changes to this document and to the products at any time without notice. Neither the provision of this information nor the sale of the described products conveys any licenses under any patent rights or other intellectual property rights of SMSC or others. There are a number of patents and patents pending on the MOST technology and other technologies. No rights under these patents are conveyed without any specific agreement between the users and the patent owners. The products may contain design defects or errors known as anomalies, including but not necessarily limited to any which may be identified in this document, which may cause the product to deviate from published descriptions. Anomalies are described in errata sheets available upon request. SMSC products are not designed, intended, authorized or warranted for use in any life support or other application where product failure could cause or contribute to personal injury or severe property damage. Any and all such uses without prior written approval of an officer of SMSC will be fully at your own risk. MediaLB, SMSC and MOST are registered trademarks of Standard Microsystems Corporation (“SMSC”) or its subsidiaries. Other names mentioned may be trademarks of their respective holders. SMSC disclaims and excludes any and all warranties, including without limitation any and all implied warranties of merchantability, fitness for a particular purpose, title, and against infringement and the like, and any and all warranties arising from any course of dealing or usage of trade. In no event shall SMSC be liable for any direct, incidental, indirect, special, punitive, or consequential damages; or for lost data, profits, savings or revenues of any kind; regardless of the form of action, whether based on contract; tort; negligence of SMSC or others; strict liability; breach of warranty; or otherwise; whether or not any remedy of buyer is held to have failed of its essential purpose, and whether or not SMSC has been advised of the possibility of such damages. History Sheet Page 2 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 MOST NetServices V3.0.x-SR-2 Copyright © 1998 - 2012 SMSC All rights reserved Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 3 MOST NetServices V3.0.x V3.0.x-SR-2 Document History Version Date Section Comment on Changes 3.0.x-7 2012-01-31 General 2 General 3 General General 4 General 5 General 6 General 7 Initial version for V3.0.x-SR-2 New chapter Initial version for V3.0.x-SR-1 New chapter Reformatted document Initial version for V3.0.3 New chapter Initial version for V3.0.2 New chapter Initial version for V3.0.1 New chapter Initial version for V3.0.0 New chapter (YYYY-MM-DD) 3.0.x-6 2011-01-05 3.0.x-5 3.0.x-4 2010-06-17 2010-06-10 3.0.x-3 2009-11-12 3.0.x-2 2009-04-29 3.0.x-1 2008-12-19 History Sheet Page 4 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 References Reference [M6.1] [M6.2] [M6.3] [M5.1] [M5.2] [M5.3] [M5.4] [M5.5] [M4.1] [M4.2] [M4.3] [M4.4] [M4.5] [M3.1] [M3.2] [M3.3] [M3.4] [M3.5] [M2.1] [M2.2] [M2.3] [M2.4] [M2.5] [M1.1] [M1.2] [M1.3] [M1.4] [AN1.1] [AN1.2] [FB1.1] [R1] [E1] Document User Manual Layer I, for NS V3.0.x-SR-2 User Manual Layer II, for NS V3.0.x-SR-2 User Manual MOST High Protocol Service, for NS V3.0.x-SR-2 User Manual Layer I, for NS V3.0.x-SR-1 User Manual Layer II, for NS V3.0.x-SR-1 User Manual MOST High Protocol Service, for NS V3.0.x-SR-1 User Manual Packetizer for MOST High, for NS V3.0.x-SR-1 User Manual Parallelized MOST Driver, for NS V3.0.x-SR-1 User Manual Layer I, for NS V3.0.3 User Manual Layer II, for NS V3.0.3 User Manual MOST High Protocol Service, for NS V3.0.3 User Manual Packetizer for MOST High, for NS V3.0.3 User Manual Parallelized MOST Driver, for NS V3.0.3 User Manual Layer I, for NS V3.0.2 User Manual Layer II, for NS V3.0.2 User Manual MOST High Protocol Service, for NS V3.0.2 User Manual Packetizer for MOST High, for NS V3.0.2 User Manual Parallelized MOST Driver, for NS V3.0.2 User Manual Layer I, for NS V3.0.1 User Manual Layer II, for NS V3.0.1 User Manual MOST High Protocol Service, for NS V3.0.1 User Manual Packetizer for MOST High, for NS V3.0.1 User Manual Parallelized MOST Driver, for NS V3.0.1 User Manual Layer I, for NS V3.0.0 User Manual Layer II, for NS V3.0.0 User Manual MOST High Protocol Service, for NS V3.0.0 User Manual Packetizer for MOST High, for NS V3.0.0 Application Note “MBM Usage API” Application Note “MLOG Usage API” MOST FBlock Debug Messages “MOST_FBlock_DbgMsg_MNS_Vxx_xx_xx-x.pdf” ReadMe File for NS V2.5.0.Alpha5 Errata Sheet V3.0.x Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 Document Version 3.0.x-6 3.0.x-6 3.0.x-6 3.0.x-5 3.0.x-5 3.0.x-5 3.0.x-3 3.0.x-3 3.0.x-4 3.0.x-4 3.0.x-4 3.0.x-2 3.0.x-2 3.0.x-3 3.0.x-3 3.0.x-3 3.0.x-1 3.0.x-2 3.0.x-2 3.0.x-2 3.0.x-2 3.0.x-1 3.0.x-1 3.0.x-1 3.0.x-1 3.0.x-1 3.0.x-1 1.2.0-2 1.0.0-1 3.0.4-2 2.5.0-6 3.0.x-3 History Sheet Page 5 MOST NetServices V3.0.x V3.0.x-SR-2 Table of Contents 1 INTRODUCTION ...............................................................................................................................8 2 VERSION 3.0.X-SR-2 .......................................................................................................................9 2.1 MOST Specification Conformance ................................................................................................9 2.2 Supported Hardware......................................................................................................................9 2.3 Included Patches ...........................................................................................................................9 2.4 Switchable Patches .....................................................................................................................10 2.5 Changes between V3.0.x-SR-1 and V3.0.x-SR-2 .......................................................................10 2.5.1 Layer I ...................................................................................................................................10 2.5.2 Layer II ..................................................................................................................................12 2.5.3 MOST High Protocol Service ...............................................................................................13 3 VERSION 3.0.X-SR-1 .....................................................................................................................14 3.1 MOST Specification Conformance ..............................................................................................14 3.2 Supported Hardware....................................................................................................................14 3.3 Included Patches .........................................................................................................................14 3.4 Switchable Patches .....................................................................................................................15 3.5 Changes between V3.0.3 and V3.0.x-SR-1 ................................................................................15 3.5.1 Layer I ...................................................................................................................................15 3.5.2 Layer II ..................................................................................................................................17 3.5.3 MOST High Protocol Service ...............................................................................................18 3.5.4 Packetizer for MOST High Service.......................................................................................19 3.5.5 Add-On Parallelized MOST Driver .......................................................................................19 4 VERSION 3.0.3 ...............................................................................................................................20 4.1 MOST Specification Conformance ..............................................................................................20 4.2 Supported Hardware....................................................................................................................20 4.3 Changes between V3.0.2 and V3.0.3 ..........................................................................................21 4.3.1 Layer I ...................................................................................................................................21 4.3.2 Layer II ..................................................................................................................................23 4.3.3 MOST High Protocol Service ...............................................................................................25 4.3.4 Packetizer for MOST High Service.......................................................................................26 4.3.5 Add-On Parallelized MOST Driver .......................................................................................26 5 VERSION 3.0.2 ...............................................................................................................................27 5.1 MOST Specification Conformance ..............................................................................................27 5.2 Supported Hardware....................................................................................................................27 5.3 Changes between V3.0.1 and V3.0.2 ..........................................................................................28 5.3.1 Layer I ...................................................................................................................................28 5.3.2 Layer II ..................................................................................................................................29 5.3.3 MOST High Protocol Service ...............................................................................................30 5.3.4 Packetizer for MOST High Service.......................................................................................31 5.3.5 Add-On Parallelized MOST Driver .......................................................................................31 5.3.6 Appendix to V3.0.2 ...............................................................................................................32 5.3.6.1 5.3.6.2 6 Removed Callback Function MhpTxConStatus() ............................................................................ 32 Removed Callback Function MhpRxConStatus()............................................................................ 33 VERSION 3.0.1 ...............................................................................................................................34 6.1 MOST Specification Conformance ..............................................................................................34 6.2 Supported Hardware....................................................................................................................34 6.3 Changes between V3.0.0 and V3.0.1 ..........................................................................................35 6.3.1 Layer I ...................................................................................................................................35 6.3.2 Layer II ..................................................................................................................................36 6.3.3 MOST High Protocol Service ...............................................................................................37 History Sheet Page 6 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 6.3.4 6.3.5 7 Packetizer for MOST High Service.......................................................................................38 Add-On Parallelized MOST Driver .......................................................................................38 VERSION 3.0.0 ...............................................................................................................................39 7.1 MOST Specification Conformance ..............................................................................................39 7.2 Supported Hardware....................................................................................................................39 7.3 Changes between V2.1.x-SR-1 and V3.0.0 ................................................................................40 7.3.1 Changes between V2.5.0.Alpha5 and V3.0.0 ......................................................................40 7.3.1.1 7.3.1.2 7.3.1.3 7.3.1.4 7.3.2 7.3.2.1 7.3.2.2 7.3.2.3 7.3.2.4 Layer I............................................................................................................................................. 40 Layer II............................................................................................................................................ 43 MOST High Protocol Service .......................................................................................................... 44 Packetizer for MOST High Service ................................................................................................. 44 Changes between V2.1.x-SR-1 and V2.5.0.Alpha5 .............................................................45 Layer I............................................................................................................................................. 45 Layer II............................................................................................................................................ 47 MOST High Protocol Service .......................................................................................................... 48 Packetizer for MOST High Service ................................................................................................. 48 APPENDIX A: SWITCHABLE PATCHES .............................................................................................49 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 7 MOST NetServices V3.0.x V3.0.x-SR-2 1 Introduction MOST NetServices V3.0.x is supporting the MOST Specification framework Rev3.0 and is available for both speed grades MOST50 and MOST150. Network MOST25 INIC OS81050 OS81060 MOST50 OS81082 OS81092 MOST150 OS81110 MOST Specification MOST NetServices Rev2.5 V2.1.x Rev3.0 V3.0.x MOST NetServices V2.1.x is designed to be compliant to MOST Specification Rev2.5 and is not scope of this document (please refer to the History File of MNS V2.1.x to get more details). History Sheet Page 8 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 2 Version 3.0.x-SR-2 This service release for MOST NetServices version 3.0.x is based on version 3.0.x-SR-1 and includes beside minor bug fixes and improvements the patches, which are listed in the Errata Sheet V3.0.x-3 [E1]. This chapter describes all API changes compared to the previous version. In one and the same MOST system this service release can be used together with other MOST NetServices V3.0.x versions in a coexistent way, since the demanded behavior and compliance to the respective specification can be configured by configuration files. 2.1 MOST Specification Conformance This version of MOST NetServices is implemented according to following specifications: MOST Specification: MOST High Protocol Specification: FBlock NetBlock Specification: FBlock NetworkMaster Specification: FBlock ET Specification: FBlock DebugMessages Specification: General FBlock Specification: Rev. 3.0E2 Rev. 2.3.1 Rev. 3.0.2 Rev. 3.0.2 Rev. 3.0.2 Rev. 1.0.1 Rev. 3.0.3 This service release is believed to have no impact on MOST Compliance verification. 2.2 Supported Hardware This version of MOST NetServices supports the following hardware and firmware combinations: Network INIC MOST150 OS81110 MOST50 OS81092 OS81082 Hardware Revision Firmware Version MOST NetServices Version 1.2.0 1.2.1 C, D 1.2.2 3.0.x-SR-2 1.2.3 C1C 1.6.4 B, C 1.5.0 2.3 Included Patches Erratum V3.0.x-SR-1 Fixed in Version 0300XX-006 X - 0300XX-007 X 3.0.x-SR-2 - 0300XX-008 X 3.0.x-SR-2 - 0300XX-009 X 3.0.x-SR-2 - Comment Fixed by new firmware OS81092 Rev.C1C Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 9 MOST NetServices V3.0.x V3.0.x-SR-2 2.4 Switchable Patches Please refer to “Appendix A: Switchable Patches on page 49” to see, what macros are introduced to control switchable patches. 2.5 Changes between V3.0.x-SR-1 and V3.0.x-SR-2 This section provides you a guideline, how to upgrade from version 3.0.x-SR-1. The complete API and features are described in the respective user manuals [M6.1], [M6.2] and [M6.3]. 2.5.1 Layer I The complete API is described in the respective user manual [M6.1]. Modification New macros in adjust1.h: Modified macros in adjust1.h: Removed macros in adjust1.h: New configuration fields: Modified configuration fields: Removed configuration fields: New API functions: Modified API functions: Removed API functions: New callback functions: Modified callback functions: Removed callback functions: History Sheet Page 10 Description • ADS_OPT1 • MBM_ALIGN_OPT1 • MBM_ALIGN_OPT2 • SCMPM_MIN • MDP_DEFAULT_RETRY: default value changed to 10 • PMS_RX_SEG_PREALLOC_SIZE: default changed to 4096 • MAX_MSG_TX_DATA • MAX_MSG_RX_DATA • DECLARE_LEGACY_SWITCHES • DECLARE_LEGACY_API • scm.packet.port_id • scm.packet.clock_mode • scm.packet.interrupt_threshold • scm.packet.mode allows additional modes -• DataRequestStatus() • PmsTriggerMlbAnalyzer() -• MsgGetTxPtr() • MsgGetRxInPtr() • wads.mdp_state_fptr • scm.spdif_status_fptr • scm.on_error_fptr: NSR_E_PACKET_IN and NSR_E_PACKET_OUT are substituted by new error codes on feature „Automatic Connection Handling for Packet Data Sockets“. • msg.tx_status_fptr: new error code XMIT_AR_FAILED -- Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Summary of new features and significant changes: Description • Support of S/PDIF feature (OS81110 only; requires a specifc 1 firmware ) • Extension of SCM_PM_AUTO_MODE: - support of SPI port - now also selectable if I2C is used as default port - support of intelligent packet data channels on MediaLB - new module: scmpm.c • New API to send a trigger message for the MediaLB Analyzer • Extension in PACKET_COMMUNICATION_ONLY mode: Notification of NIState, NCState, NodeAddress and EUI48 • Messages from EHC to INIC are now discarded while the Physical Layer Test is executed (HF 007170-1). • The error signal NSR_E_REATTACH is eliminated now after calling StopNetServices() (HF 007571-2). • MOST Debug Message "MBM Buffer Allocation Failed" is sent with a minimum time gap of 200 ms to avoid a transmission deadlock (HF 007618-1). • Robustness increased against race conditions on initial FIFO synchronization on INIC startup (HF 006971-1). • Avoiding buffer consumption due to groupcast transmissions during NetOff (HF 008057-1). • New signal reported by callback function msg.tx_status_fptr(): XMIT_AR_FAILED if the address resolution failed (was previously just signaled at API of AH module). • The callback functions of Layer I are now available in a new file “ns_cb_l1.c”. • File pmsa.inc is renamed to pmsa.c. • File rules_ad.h is renamed to rules1_ad.h. • Implemented errata: 0300XX-007, 0300XX-008, 0300XX-009 1 For more information on the INIC firmware that supports this feature, please contact the technical support available at: http://www.smsc-ais.com/contact Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 11 MOST NetServices V3.0.x V3.0.x-SR-2 2.5.2 Layer II The complete API is described in the respective user manual [M6.2]. Modification New macros in adjust2.h: Modified / removed macros in adjust2.h: New / removed / modified API functions: Modified structures at API: New / modified callback functions: Removed callback functions: Summary of new features and significant changes: Description • CMD_MAX_MSG_TX_SZ substitutes the removed macro of Layer I: MAX_MSG_TX_DATA MAX_MSG_RX_DATA ---• • • • • • • • History Sheet Page 12 ET_SharedRxTxMsgBuf_Query() is obsolete. NmSaveConfigResult() and NmSaveConfigResultAck() NmSaveConfigError() and NmSaveConfigErrorAck() ET.CodingErrors.Set: Wrong error message revised (param 'timeout') (HF 007252-1). Now ET_ADD6 can be selected without defining NETWORKMASTER_LOCAL (HF 006297-2). Added reserved transmission buffer for AddressHandler module to avoid potential deadlocks. New file: rules2_ad.h Removed function NWM.SaveConfiguration according FBlock NetworkMaster specification Rev. 3.0.2 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 2.5.3 MOST High Protocol Service The complete API is described in the respective user manual [M6.3]. Modification New macros in adjustmh.h: Modified / removed macros in adjustmh.h New / modified API functions: Removed API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions (of previous PMHT module): Summary of new features and significant changes: Description • PMHT_ADD1 --• • • • • • • • • • • • • • • • • MhpPerfTimeout() MhpSetAvrgIntRate() MhpSetAvrgIntRateRx() MhpSetAvrgIntRateTx() MhpHighResTimeout() MhpPerfTimerStart() (if using the PMHT module) Now MhpGetBufIntf() has to use the API function MsgGetTxPtrExt() instead of MsgGetTxPtr(). Return value of MhpTxStatus() changed from bool to byte. MhpHighResTimerStart() MhpTxControlRange() The PMHT module is now part of the standard deliverables and allows frame interleaved transmission of multiple MHP connections in the DSO (Data source; sender of MHP data). A newly introduced return value of MhpTxStatus() can be used to close the connection immediately. Automatic re-initialization of MHP module when using PACKET_COMMUNICATION_ONLY mode (HF 007209-2). Added reserved Tx buffer for WADS and MHP to avoid unresponsive MHP during extensive control message transmission (HF 007734-1). The MOST debug message “MHP Silent Termination” is extended by the direction info (HF 007862-1). Bugfix to avoid that the MHP DSI may enter a state, in which an inactive connection may block all other Rx connections (HF 007396-1). New file: rulesmh_ad.h Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 13 MOST NetServices V3.0.x V3.0.x-SR-2 3 Version 3.0.x-SR-1 This service release for MOST NetServices version 3.0.x is based on version 3.0.3 and includes all bug fixes and improvements, which are listed in the Errata Sheet V3.0.x-2 [E1]. This chapter describes all API changes compared to the previous version. In one and the same MOST system this service release can be used together with other MOST NetServices V3.0.x versions in a coexistent way, since the demanded behavior and compliance to the respective specification can be configured by configuration files. 3.1 MOST Specification Conformance This version of MOST NetServices is implemented according to following specifications: MOST Specification: MOST High Protocol Specification: FBlock NetBlock Specification: FBlock NetworkMaster Specification: FBlock ET Specification: FBlock DebugMessages Specification: General FBlock Specification: Rev. 3.0E2 Rev. 2.3 Rev. 3.0.1 Rev. 3.0.1 Rev. 3.0.1 Rev. 1.0.1 Rev. 3.0.2 3.2 Supported Hardware This version of MOST NetServices supports the following hardware and firmware combinations: Network MOST150 MOST50 INIC OS81110 OS81092 OS81082 Hardware Revision Firmware Version MOST NetServices Version 1.2.0 C, D 1.2.1 1.2.2 3.0.x-SR-1 C1A 1.6.2 C1B 1.6.3 B, C 1.5.0 3.3 Included Patches Erratum Fixed V3.0.3 in Version Comment Substituted by 0300XX-004. 0300XX-001 X - 0300XX-002 X 3.0.x-SR-1 - 0300XX-003 X 3.0.x-SR-1 - 0300XX-004 X 3.0.x-SR-1 - 0300XX-005 X 3.0.x-SR-1 - History Sheet Page 14 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 3.4 Switchable Patches Please refer to “Appendix A: Switchable Patches” to see, what macros are introduced to control switchable patches. 3.5 Changes between V3.0.3 and V3.0.x-SR-1 This section provides you a guideline, how to upgrade from version 3.0.3. The complete API and features are described in the respective user manuals [M5.1], [M5.2], [M5.3], [M5.4] and [M5.5]. 3.5.1 Layer I The complete API is described in the respective user manual [M5.1]. Modification New macros in adjust1.h: Modified macros in adjust1.h: Removed macros in adjust1.h: New / modified / removed configuration fields: New API functions: Modified API functions: Removed API functions: New callback functions: Modified callback functions: Removed callback functions: Description • MSG_TX_USER_PAYLOAD_EXT_CB • DATA_TX_USER_PAYLOAD_EXT_CB • MNS_TM_WD_EXTENDED_TIMEOUT • MDM_APP_NUM_FUNC_IDS -• VMSV_MIN -• • • • • • • • -• • • • • -- MdmSetDbgLevelApp() MdmGetDbgLevelApp() MdmRegisterFuncIdApp() MdmUnregisterFuncIdApp() MdmGetDbgLevelListApp() MbmGetUsageTopExt() and _MbmGetUsageTopExt() MostEmergencyCondition() MdmMsgSendApp() msg.free_tx_payload_ext_fptr wads.free_data_tx_payload_ext_fptr mdm.app_config_fptr general.on_error_fptr: new error code: NSR_E_INVALID_WATCHDOG_MODE_CONFIG Callback TScmGetSourceCB on ScmGetSource(): New possible error code: NSR_E_SRC_INFO_TEMP_NOT_AVAIL Removed obsolete error codes: NSR_E_SRC_INTERNAL, NSR_E_SRC_COMM, NSR_E_SRC_INIT, NSR_E_TIMEOUT Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 15 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Summary of new features and significant changes: History Sheet Page 16 Description • New header files: ams_pv.h, mbm_pv.h, mis_pv.h, mns_pv.h, pms_pv.h, vmsv_pv.h, wads_pv.h, wmcs_pv.h, wscm_pv.h • If MEP_MIN is not defined, incoming MEP messages are now simply ignored instead of throwing an assertion. • Introduced a preprocessor check that avoids the combination of PMS_RX_SEG_PREALLOC_SIZE and MSG_RX_USER_PAYLOAD • New alternative callback functions (wAMS and wADS) for usage in combination with external TX payload buffer • Support of new available sequential streaming data formats (introduced with OS81092 RevC1B). • Removed unnecessary stuffing bytes in FIFO Data Header (FDH of Port Message Protocol). • Improvement of existing sync/reset recovery mechanism: The MOST NetServices are now able to detect continuous FIFO Status timeouts separately for each FIFO. • Extension of MDM module (MOST Debug Messages): Now, the MOST NetServices provide built-in administration and configuration of debug levels for all application specific Debug Message Function IDs. • The API function MdmMsgSendApp() uses now the standard error mask as return value. • New validity check of PML field for all received control messages. • Extended MCM FIFO Status timeout on extensive Mid-LevelRetries (erratum 0201XX-052) • New MBM Usage API debug function to retrieve peak-level values. • The API function MostEmergencyCondition() got a new argument. Besides shutting down the network the API function is now suitable to reset the emergency condition, too. • Bugfix: The API function MostGetNCState() returned always NCS_NOT_OK if the FBlock NetworkMaster is deployed locally. • Implemented erratum: 0300XX-002 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 3.5.2 Layer II The complete API is described in the respective user manual [M5.2]. Modification New macros in adjust2.h: Modified macros in adjust2.h: Removed macros in adjust2.h: New / removed / modified API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions: Summary of new features and significant changes: Description • DM_MIN • NUM_FBLOCKS_APP • NUM_FBLOCKS_SHADOW_APP -• CONFIGSTATE_NOTOK_DELAY_TIME • NETWORKMASTER_INSTID • ET_ADD7 • NUM_FBLOCKS • NUM_FBLOCKS_SHADOW --• • • -• • • • • • • • ET_SystemState_Request() DmAdjAppDbgMsgStatus() DmAdjAppDbgMsgError() ET_ActivateSlaveMode_Request() Whenever the Command Interpreter needs to return a message with OPType ErrorAck, ProcessingAck or ResultAck, but the SenderHandle was not included in the request (length < 2), the respecting OPTypes without Ack are used (Error, Processing, Result). Avoiding multiple calls of callback function CmdRxFilter(), in case of FBlockID/InstID wildcards. New FBlock: FBlock DebugMessages. Provides an API to change the debug level for application’s debug messages during runtime. In callback function NbGetDeviceInfo() the application can now also generate any other error message than “wrong parameter”. Macro NUM_FBLOCKS is replaced by NUM_FBLOCKS_APP. The new value NUM_FBLOCKS_APP must neither count NetBlock, nor FBlock ET nor FBlock DebugMessages. Macro NUM_FBLOCKS_SHADOW is replaced by NUM_FBLOCKS_SHADOW_APP. The new value NUM_FBLOCKS_SHADOW_APP must not count the NetworkMaster Shadow. Removed following unused functions and operations in FBlock ET according to the latest specification Rev3.0.1: o Function ET.DiagTimeout o Function ET.ActivateSlaveMode (made ET_ADD7 obsolete) o Operation ET.ShutDown.StartAck o Operation ET.SendMessage.StartResultAck o Operation ET.Reset.StartAck Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 17 MOST NetServices V3.0.x V3.0.x-SR-2 3.5.3 MOST High Protocol Service The complete API is described in the respective user manual [M5.3]. Modification New / modified / removed macros in adjustmh.h: New / modified / removed API functions: Modified structures at API: New / modified / removed callback functions: Summary of new features and significant changes: Description ----• • • • History Sheet Page 18 MHP file structure was changed: Removed: mosthigh.h New: mhp.h, mhp_ad.h, mhp_pb.h, mhp_pv.h Any RequestConnection command using an unresolved functional address is now sent to target address 0x0FF0 (DebugAddress) instead of previously 0x0000. API improved to avoid that a connection gets locked if MhpOpenCon() or MhpGetTxPtrCon() is called multiple times without calling MhpSend() in between. Implemented errata: 0300XX-003, 0300XX-004, 0300XX-005 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 3.5.4 Packetizer for MOST High Service The complete API is described in the respective user manual [M5.4]. Modification New / modified / removed macros in adjustp.h: New / modified / removed API functions: New / modified / removed callback functions: Summary of new features and significant changes: Description ---• Bugfix: Concurrent MHP and Packetizer Connections can now use the same FBlockID and InstID. 3.5.5 Add-On Parallelized MOST Driver This section describes the delta within both Add-On modules PMHT and AAM. The complete API is described in the respective user manual [M5.5]. Modification New / modified macros in adjustmh.h: Removed macros in adjustmh.h: New / modified / removed API functions: Modified structures at API: New / modified / removed callback functions: Summary of new features and significant changes in PMHT: Description -• PMHT_INTERLEAVE_LEVEL ---• • • • PMHT file structure was changed: Removed: mosthigh.h New: pmht.h, pmht_ad.h, pmht_pb.h, pmht_pv.h RequestConnection commands using an unresolved functional address are now sent to target address 0x0FF0 (DebugAddress) instead of previously 0x0000. API improved to avoid that a connection gets locked, if MhpOpenCon() or MhpGetTxPtrCon() is called multiple times without calling MhpSend() in between. Implemented errata: 0300XX-003, 0300XX-005 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 19 MOST NetServices V3.0.x V3.0.x-SR-2 4 Version 3.0.3 4.1 MOST Specification Conformance This version of MOST NetServices is implemented according to following specifications: MOST Specification: MOST High Protocol Specification: FBlock NetBlock Specification: FBlock NetworkMaster Specification: FBlock ET Specification: General FBlock Specification: Rev. 3.0E2 Rev. 2.3 Rev. 3.0.1 Rev. 3.0.1 Rev. 3.0.1 Rev. 3.0.2 4.2 Supported Hardware This version of MOST NetServices supports the following hardware and firmware combinations: Network MOST150 MOST50 INIC OS81110 OS81092 OS81082 History Sheet Page 20 Hardware Revision Firmware Version MOST NetServices Version 1.1.1 C, D 1.2.0 3.0.3 B1A 1.6.1 C1A 1.6.2 B, C 1.5.0 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 4.3 Changes between V3.0.2 and V3.0.3 This section provides you a guideline, how to upgrade from version 3.0.2. The complete API and features are described in the respective user manuals [M4.1], [M4.2], [M4.3], [M4.4], and [M4.5]. 4.3.1 Layer I The complete API is described in the respective user manual [M4.1]. Modification New macros in adjust1.h: Modified macros in adjust1.h: Removed macros in adjust1.h: New configuration fields: Modified configuration fields: Removed configuration fields: New API functions: Modified API functions: Removed API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions: Description • MDM_LEVEL • MDM_RSVD_MNS • MDM_RSVD_APP • MDM_NUM_BUF • MDM_MAX_MSG_SIZE_APP • MDP_DEFAULT_RETRY • MEP_DEFAULT_RETRY • Changed configuration macro ADS_RX_PREALLOC: Default value changed from 0 to 1. Applications using I2C only should set the value to 0 to avoid unnecessary waste of memory! • MDP_DEFAULT_RETRY_PRIO • MEP_DEFAULT_RETRY_PRIO -• Member ‘data’ of structure TNetServicesConfig is renamed to ‘wads’ to avoid potential conflict with keyword ‘data’ on some compilers. -• MdmMsgSendApp() • MostEmergencyCondition() • MostCountCodingErrors(): removed parameter: deadtime • PmsPrepareMepHeaderExt(): parameter retry changed (number of retries is now located in bits 0..3). • MostSetWatchdogMode() • MostGetPermissionToWake() • MostReadPM() • MostResetPM() • Changed structure TDataTx: The deprecated field Priority is removed. • Structure MbmUsage: new field: num • msg.rx_error_fptr • lld.stop_interfaces_fptr • vmsv.msval_diag_result_fptr: In case of result MSVAL_DIAG_FAILED the info field is no longer applicable. • general.on_error_fptr: new event: NSR_E_MCM_RX_CHANNEL -- Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 21 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Summary of new features and significant changes: History Sheet Page 22 Description • New module (MDM) providing a convenient API to transmit MOST Debug Messages (FBlockID 0x09). • MOST NetServices now fire MOST Debug Messages on certain conditions. • Improvements of retimed bypass mode for physical layer compliance tests. • Adaptation to modified INIC behavior (OS81110 FW 1.1.0) in respect to Sudden Signal Off Detection, according to MOST Specification Rev 3.0 E1 (HF 004673-1). • Sample application improved: It now supports the use case “MediaLB on default” (APP_DEF_IFACE_MEDIALB). • Segmentation errors generated by MNS are now sent without retries. • Bugfix in use case “NetBlock.Boundary = 0”. • PmsTxStarted() is now also available in operation mode PACKET_COMMUNICATION_ONLY. • Unblocking broadcast messages (target 0x03FF) are now also transmitted to the own RX queue (same behavior as for blocking broadcast messages). • Discarding messages in AMS Rx-Q after transition to NET_INIT. This avoids that messages stored in HW buffers are enqueued in AMS Rx Queue after transition to NET_OFF. • Bugfix: StopNetServices() now leads to events on_stop_netservices_fptr() and stop_interfaces_fptr() reliably under all conditions. • Enhanced MbmUsage API to be able to monitor the sum of simultaneously used TX and RX buffers. • ScmCreateSocket(): A Discrete Frame Isochronous Phase Channel can now also be created on MediaLB (type SCM_TYPE_ISODFPHASE ). • Minor bugfixes and implementation of following Errata items: 0201XX-059, 0201XX-060, and 0201XX-064 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 4.3.2 Layer II The complete API is described in the respective user manual [M4.2]. Modification New macros in adjust2.h: Modified macros in adjust2.h: Removed macros in adjust2.h: New / removed / modified API functions: Modified structures at API: New callback functions: Modified callback functions: Description • NTF_EXT • CAPABILITY_TO_WAKE • ET_ADD8 • Macro NTF_ADD1_OPTYPE is renamed to NTF_EXT_OPTYPE. • CMD_LEN_CHECK_14BIT • CMD_ADD1, CMD_ADD2, CMD_ADD3, CMD_ADD4, CMD_ADD5, CMD_ADD3_OPT1 • NB_ADD6 • CB_NB_xxx • CB_NM_xxx • NTF_ADD1, NTF_ADD2, NTF_ADD3, NTF_ADD4 • ADDRH_SEARCH_METHOD -• • • • • • • • • Removed callback functions: • • • • • • • • • Now the InstID of FBlock ET must be considered in the customizable array InstIDsDefault[] (in file T_FBlock.tab), independent on size CMD_NUM_WILDCARDS. In all previous releases this was required and allowed only in case of CMD_NUM_WILDCARDS == 0. ET_NtfMatrixSize_Query() ET_FBlockInfo_Query() ET_ECLTrigger_Request() ET_ECLInitiatorState_Query() NmOwnConfigInvalidResultAck() NmOwnConfigInvalidErrorAck() ET_DSO_Request(): new parameter: tgt_addr, and new possible return value: ET_DSO_NEXTPACKET CmdRxFilter(): The function may now also be called if argument tx_ptr is NULL. NbShutDownDevice() has a return value now. ET_AutoWakeup_Request(): removed parameter: attenuation CmdRxFilter2() NbShutdownResultAck() and NbShutdownErrorAck() NbNotificationStatus() and NbNotificationError() NbNtfCheckStatus() and NbNtfCheckError() NbPermissionToWakeStatus() NbPermissionToWakeError() ET_VoltageLevels_Query() Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 23 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Summary of new features and significant changes: History Sheet Page 24 Description • Configuration of Layer II modules is simplified. • New interface to support the use case ‘FBlock ET is used without Notification Service (NTF_MIN)’ • FBlock ET updated according Rev3.0.1 New functions: FBlockInfo, Version, ECLTrigger, ECLInitiatorState Removed functions: VoltageLevels, ResetTests • NetBlock updated according Rev3.0.1 New functions: none Removed functions: PermissionToWake, Notification, NotificationCheck • Filter for messages from devices using an invalid node address (0x300 .. 0x4FF) is now bypassing NetBlock messages in the NetworkMaster device (if NETWORKMASTER_LOCAL is defined). • New sample file: crc32_sample.c. It is intended to be used as sample to generate the checksum for the response onto ET.DSI.StartResult. • Interface to expand T_ET.TAB by usage of macros NS_INC_ET_DSI_FUNC_TAB and NS_INC_ET_DSI_OP_TAB. • Minor bugfixes and implementation of following Errata items: 0201XX-061 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 4.3.3 MOST High Protocol Service The complete API is described in the respective user manual [M4.3]. Modification New macros in adjustmh.h: Modified macros in adjustmh.h: Removed macros in adjustmh.h: New / modified / removed API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions: Summary of new features and significant changes: Description • MHP_TIME_TX_RETRY_DELAY • MHP_MAX_PACKET_SIZE • MHP_NO_COPY_ENABLE • MHP_TX_OPT_COPY2 • MHP_RX_OPT_COPY1 ---• • -• • • • • • • • • MhpTxStatus(): new: MHP_TX_CLOSE, MHP_TX_LEN_ZERO, MHP_TX_LEN_TOO_BIG removed: MHP_TX_ERROR_TOKEN MhpRxComplete(): expanded meaning of MHP_RX_CLOSE Simplified configuration. MhpTxStatus() and MhpRxComplete() are now also called on transition to NetOff or re-initialization of the MHP module if a connection was pending. This event is signaled by MHP_TX_CLOSE or MHP_RX_CLOSE. Robustness of receiver increased by additional plausibility checks for the FrameID. Invalid MHP Frames are ignored if... - the current received Frame ID is greater than the maximum Frame ID of the current block - the maximum Frame ID of the current received Frame is unequal the maximum Frame ID announced in the "0-Frame" - Plausibility is checked to avoid invalid buffer access because of invalid scale value (Erratum 0201XX-063) Bugfix in MHP address resolution. Robustness of transmitter increased: - Validation of parameters after calling of MhpTxStatus(). Timer t_Retrans can be customized in block acknowledge mode. Revision of multiple frame request handling. Avoiding transmission of duplicate frames. At MOST150 one MHP Frame can now transport up to 1516 bytes payload (depending on capabilities of the IO interface). Minor bugfixes Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 25 MOST NetServices V3.0.x V3.0.x-SR-2 4.3.4 Packetizer for MOST High Service The complete API is described in the respective user manual [M4.4]. Modification New / modified / removed macros in adjustp.h: Removed macros in adjustp.h New / modified / removed API functions: New / modified / removed callback functions: Summary of new features and significant changes: Description -• -- PACKET_TX_INTF_DEFAULT --- 4.3.5 Add-On Parallelized MOST Driver This section describes the delta within both Add-On modules PMHT and AAM. The complete API is described in the respective user manual [M4.5]. Modification New macros in adjustmh.h: Modified macros in adjustmh.h: Removed macros in adjustmh.h: New / modified / removed API functions: Modified structures at API: New callback functions: Removed callback functions: Modified callback functions: Summary of new features and significant changes in PMHT: Description • MHP_TIME_TX_RETRY_DELAY • MHP_MAX_PACKET_SIZE • MHP_NO_COPY_ENABLE • MHP_TX_OPT_COPY2 ----• • • • • • • History Sheet Page 26 MhpTxStatus(): new event MHP_TX_CLOSE Configuration of PMHT module is simplified. MhpTxStatus() is now also called on transition to NetOff or reinitialization of the PMHT module if a connection was pending. This event is signaled by MHP_TX_CLOSE. Bugfix in MHP address resolution. Robustness of transmitter increased: - Validation of parameters after calling of MhpTxStatus(). Timer t_Retrans can be customized in block acknowledge mode. At MOST150 one MHP Frame can now transport up to 1516 bytes payload (depending on capabilities of the IO interface). Minor bugfixes Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 5 Version 3.0.2 5.1 MOST Specification Conformance This version of MOST NetServices is implemented according to following specifications: MOST Specification: MOST High Protocol Specification: FBlock NetBlock Specification: FBlock NetworkMaster Specification: FBlock ET Specification: General FBlock Specification: Rev. 3.0 Rev. 2.3 Rev. 3.0 Rev. 3.0 Rev. 3.0 Rev. 3.0.1 5.2 Supported Hardware This version of MOST NetServices supports the following hardware and firmware combinations: Network INIC MOST150 OS81110 MOST50 OS81092 OS81082 Hardware Revision Firmware Version MOST NetServices Version 1.0.0 C 0.99.11 3.0.2 B1A 1.6.1 B 1.5.0 MOST NetServices V3.0.2 is intended to be used with OS81110 HW Rev.C, Firmware V0.99.11. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 27 MOST NetServices V3.0.x V3.0.x-SR-2 5.3 Changes between V3.0.1 and V3.0.2 This section provides you a guideline, how to upgrade from version 3.0.1. The complete API and features are described in the respective user manuals [M3.1], [M3.2], [M3.3], [M3.4], and [M3.5]. 5.3.1 Layer I The complete API is described in the respective user manual [M3.1]. Modification New macros in adjust1.h: Modified macros in adjust1.h: Removed macros in adjust1.h: New / modified configuration fields: Removed configuration fields: New API functions: Modified API functions: Description • MSG_RX_SEG_COOPERATIVE (MOST50 only) • MSG_RX_SEG_INIC_ONLY (MOST50 only) • MSG_RX_SEG_EHC_ONLY (MOST50 only) • MOST_INIC_ID • MNS_MEM_CPY • MNS_MEM_SET • PMS_RX_OPT3 • PMS_RX_OPT3_CHADDR • MBM_MSG_RSVD_TX: Default value changed from 5 to 10 • MDP_DEFAULT_RETRY_PRIO and MEP_DEFAULT_RETRY_PRIO: Default values changed to 0x10 --• • • • • • • • Removed API functions: Modified structures at API: New callback functions: Modified callback functions: • • • -• • Removed callback functions: History Sheet Page 28 • general.remote_access PmsGetRxBufMcm() PmsGetRxBufMdp() MnsGetNetServicesVersion() MostSetDevMode() returns ERR_PARAM now, if the parameter is neither MNS_SLAVE nor MNS_MASTER. ScmOpenPort(): Macros to configure the data format on the Streaming Port are renamed to be compliant with MISRA rules 1.4 and 5.1: SCM_PORT_CFG_STREAM_* SCM_STREAM_FRMT_* ScmCreateSocket(): - parameter "data_sample_freq_ref", new values for 8 kHz, 16 kHz, 88.2 kHz, 176.4 kHz - parameter “iso_packet_size”, two new values to support DTCP over MOST and IP ScmGetMuteMode() may return a new value: SCM_MUTE_MODE_OFF_EXT ScmGetNodeDelay() DataSetTransPriority() Field Priority of structure TDataTx is no longer used and overruled with 0x00 by MNS. general.on_error_fptr: New error codes: NSR_E_BIST_MEM_CONTENT, NSR_E_WRONG_PROTOCOL_CFG Callback on ScmDestroySocket() and ScmDestroySocketExt(): Macro NSR_E_DSY_NET_UNLOCKED renamed to NSR_E_DYS_NET_UNLOCKED scm.node_delay_changed_fptr Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Summary of new features and significant changes: Description • Increased control message and data packet throughput in combination with decreased CPU load • OS81092 is supported now. That includes that both API functions MostReadConfString() and MostReadPM() support now also the usage of a ROM INIC. • Clean-up of functions that were required for MOST25 only • Plausibility check for robustness on received MDP messages to recognize corrupt packet length information. • Removed unnecessary ASSERT prints in function MsgRxOutTrigger() if parameter msg.rx_burst is configured greater than one. • New sample frequency values available on use case DiscreteFrame Isochronous Streaming data: 8 kHz, 16 kHz, 88.2 kHz, 176.4 kHz • New valid range of Isochronous Packet size to support DTCP over MOST and DTCP over IP • Support for debug messages to target address 0x0FF0, includes API macros MSG_TGT_DEBUG and FBLOCK_DEBUG • Minor bug-fixes and implementation of following Errata items: 0201XX-054, 0201XX-055 5.3.2 Layer II The complete API is described in the respective user manual [M3.2]. Modification New / modified macros in adjust2.h: Removed macros in adjust2.h: New / removed / modified API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions: Summary of new features and significant changes: Description -• • --• • -• • • CMD_ADD6 (the feature is always enabled now) Wildcard entries of type A and B are obsolete and no longer supported. These wildcards are implicitly covered by feature CMD_ADD6 (which is now the standard behavior). 1 ET_ADD5 ET_PhysicalLayerTest_Status() ET_MOSTRemoteReset_Request() ET_NetInterfaceState_Query() Implementation of FBlock ET according FBlock specification Rev3.0 Bug-fix to avoid that multiple calls of ET.CodingErrors.Get lead to a reattach of INIC. 1 This switch was not available in all variants. Since function ET.RemoteReset has been introduced in the standard variant, the switch is obsolete now and function ET.RemoteReset is available in all variants. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 29 MOST NetServices V3.0.x V3.0.x-SR-2 5.3.3 MOST High Protocol Service The complete API is described in the respective user manual [M3.3]. Modification New macros in adjustmh.h: Modified macros in adjustmh.h: Removed macros in adjustmh.h: New API functions: Modified API functions: Removed API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions: Summary of new features and significant changes: Description • MHP_TX_OPT_COPY2 • MHP_RX_OPT_COPY1 • MHP_MEM_CPY -• MHP_TX_CONSTATUS • MHP_RX_CONSTATUS • MhpOpenCon() • MhpSend(): provides a return value now -• Structure TMhpTx: new field: HoldConOpt -• MhpTxStatus() is no longer called in the context of MhpSend(). The result of MhpSend() is now reported by the return value. Therefore following events are no longer applicable: MHP_TX_AH_BUSY, MHP_TX_LEN_ZERO, MHP_TX_LEN_TOO_BIG • MhpDebugInfoTx(): new event: MHP_DBG_CON_HOLD • MhpTxConStatus() • MhpRxConStatus() • Performance optimizations leading to increased data packet throughput in combination with significantly decreased CPU load. • It is now possible to open a connection without the need to transmit user data. • It is now possible to configure a connection on sender side, so that the connection is kept in hold state automatically. It can be configured to be closed on timeout or can be kept open till it is closed only on request by application or any connection failure. • Reduced complexity by removing redundant events: Two callback functions are removed in MNS V3.x, as they are redundant to the existing callback functions MhpTxStatus(), MhpDebugInfoTx(), MhpRxComplete() and MhpDebugInfoRx(). Details about mapping are described in sections 5.3.6.1 and 5.3.6.2. • Robustness improved in MHP receiver: - Plausibility check against corrupt packet length information - The timer t_receive is refreshed only on valid Null- or data frames. - Avoiding potential division by zero, if the NDF field was set to zero by the DSO • Implemented Errata item: 0201XX-053 Note: By activating any of the optimization modes on sender side (i.e., MHP_NO_COPY_ENABLE or MHP_TX_OPT_COPY2), the data throughput might be increased significantly depending on the system environment, by decreasing the CPU load. Therefore, a change of configuration leads to the need to re-configure the default value of the average interrupt rate (please refer to [M3.3], section 4.3) and might have impact onto the range of speed regulation (see [M3.3] section 6.10). It is recommended to enable these optimizations (= default). The possibility to disable them may be removed in a future version. History Sheet Page 30 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 5.3.4 Packetizer for MOST High Service The complete API is described in the respective user manual [M3.4]. Modification New / modified / removed macros in adjustp.h: New / modified / removed API functions: New / modified / removed callback functions: Summary of new features and significant changes: Description ----- 5.3.5 Add-On Parallelized MOST Driver This section describes the delta within both Add-On modules PMHT and AAM. The complete API is described in the respective user manual [M3.5]. Modification New macros in adjustmh.h: Modified macros in adjustmh.h: Removed macros in adjustmh.h: New API functions: Modified API functions: Removed API functions: Modified structures at API: New callback functions: Removed callback functions: Modified callback functions: Summary of new features and significant changes in PMHT: Description • MHP_TX_OPT_COPY2 • MHP_MEM_CPY -• MHP_TX_CONSTATUS • • -• -• • • • • • MhpOpenCon() MhpSend(): provides a return value now Structure TMhpTx: new field: HoldConOpt MhpTxConStatus() MhpTxStatus() is no longer called in the context of MhpSend(). The result of MhpSend() is now reported by the return value. Therefore following events are no longer applicable: MHP_TX_AH_BUSY, MHP_TX_LEN_ZERO, MHP_TX_LEN_TOO_BIG Performance optimizations leading to increased data packet throughput in combination with significantly decreased CPU load. It is now possible to open connections by the PMHT API without the need to transmit user data. It is now possible to configure a connection by using the PMHT API, so that the connection is kept in hold state automatically. It can be configured to be closed on timeout or can be kept open till it is closed only on request by application or any connection failure. Reduced complexity by removing redundant events: MhpTxConStatus() is removed in MNS V3.x, as it is redundant to the existing callback functions MhpTxStatus(), and MhpDebugInfoTx().Details about mapping are described in section 5.3.6.1. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 31 MOST NetServices V3.0.x V3.0.x-SR-2 5.3.6 Appendix to V3.0.2 5.3.6.1 Removed Callback Function MhpTxConStatus() Events that were previously reported by the redundant callback function MhpTxConStatus() can also be derived from MhpTxStatus(), the return value of MhpSend() and/or MhpDebugInfoTx(), according to the following mapping table: Previous MhpTxConStatus() MHP_TX_CON_AH_BUSY MHP_TX_CON_LEN_ZERO MHP_TX_CON_LEN_TOO_BIG MhpTxStatus() *) MHP_TX_AH_BUSY *) MHP_TX_LEN_ZERO *) MHP_TX_LEN_TOO_BIG MHP_TX_CON_BUILD_START - MHP_TX_CON_BUILD_ERROR MHP_TX_ERROR_BUILDCON MHP_TX_ERROR_PRIO MHP_TX_ERROR_NDF MHP_TX_ERROR_SCALE MHP_TX_CON_BUILD_READY - MHP_TX_CON_ERROR MHP_TX_CON_END_START MHP_TX_CON_END_READY MHP_TX_CON_HOLD_PAS MHP_TX_ERROR_NAC MHP_TX_END_READY - MHP_TX_CON_HOLD_ACT - MHP_TX_CON_CONTINUE - MHP_TX_CON_PROGRESS - MHP_TX_CON_ERROR_TOKEN MHP_TX_ERROR_TOKEN MHP_TX_ERROR_KILLED (if pending transmission) or MHP_TX_KILLED_RX (on non pending transmission) MHP_TX_CONFIG_NOTOK MHP_TX_ERROR_NOBUF MHP_TX_CON_KILLED MHP_TX_CON_CONFIG_NOTOK MHP_TX_CON_ERROR_NOBUF MhpDebugInfoTx() MHP_DBG_STATE_TX TX_GETBUF_REQ MHP_DBG_STCON_TX - "prio" MHP_DBG_STCON_TX - "ndf" MHP_DBG_STCON_TX - "scale" MHP_DBG_STATE_TX TX_GETBUF_READY MHP_DBG_STATE_TX - TX_LOOP_END MHP_DBG_STATE_TX - TX_WAIT On each state transition: MHP_DBG_STATE_TX - TX_HOLD New debug event in V3.0.2: In the case that the connection is hold by the DSO while the MHP TX section is servicing another connection: MHP_DBG_CON_HOLD MHP_DBG_STATE_TX - "previous state" MHP_DBG_STATE_TX TX_CHECK_FRAME - *) In V3.0.2 equivalent events are now signaled as return value of MhpSend(). History Sheet Page 32 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 5.3.6.2 Removed Callback Function MhpRxConStatus() Events that were previously reported by the redundant callback function MhpRxConStatus() can also be derived from MhpRxComplete() and/or MhpDebugInfoRx() according to the following mapping table: MhpRxConStatus() MHP_RX_CON_BUF MHP_RX_CON_TABLE MHP_RX_CON_PRIO MhpRxComplete() - MHP_RX_CON_BUILD_READY - MHP_RX_CON_HOLD_PAS MHP_RX_CON_PROGRESS MHP_RX_CLOSE (typical) or MHP_RX_ERROR_KILLED (DSO killed the connection) - MHP_RX_CON_BUILD_START - MHP_RX_CON_END_TX MHP_RX_ERROR_NOREADY MHP_RX_CON_ERROR MHP_RX_ERROR_NFRAME MHP_RX_ERROR_FRAME MHP_RX_CON_HOLD_ACT - MHP_RX_CON_KILLED MHP_RX_KILLED_RX MHP_RX_CON_CONTINUE - MHP_RX_CON_ERROR_NOBUF MHP_RX_ERROR_NOBUF MhpDebugInfoRx() MHP_DBG_REQCON_RX MHP_DBG_REQCON_RX - *) MHP_DBG_STATE_RX RX_WAIT_NFRAME - *) - *) MHP_DBG_STATE_RX RX_WAIT_READY MHP_DBG_STATE_RX RX_NORM_OP MHP_DBG_STATE_RX RX_NORM_OP MHP_DBG_STATE_RX RX_NORM_OP MHP_DBG_STATE_RX RX_HOLD MHP_DBG_STATE_RX "previous state" - *) New debug events for these three cases are neither available nor planned. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 33 MOST NetServices V3.0.x V3.0.x-SR-2 6 Version 3.0.1 6.1 MOST Specification Conformance This version of MOST NetServices is implemented according to following specifications: MOST Specification: MOST High Protocol Specification: FBlock NetBlock Specification: FBlock NetworkMaster Specification: FBlock ET Specification: General FBlock Specification: Rev. 3.0 Rev. 2.3 Rev. 3.0 Rev. 3.0 Rev. 2.6.1 Rev. 3.0.1 6.2 Supported Hardware This version of MOST NetServices supports the following hardware and firmware combinations: Network MOST150 INIC OS81110 Hardware Revision Firmware Version MOST NetServices Version C 1.0.0 3.0.1 MOST NetServices V3.0.1 is intended to be used with OS81110 HW Rev.C, Firmware V1.0.0. The usage in combination with other INIC derivatives or firmware versions is not qualified yet. History Sheet Page 34 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 6.3 Changes between V3.0.0 and V3.0.1 This section provides you a guideline, how to upgrade from version 3.0.0. The complete API and features are described in the respective user manuals [M2.1], [M2.2], [M2.3], [M2.4], and [M2.5]. 6.3.1 Layer I The complete API is described in the respective user manual [M2.1]. Modification New macros in adjust1.h: Modified macros in adjust1.h: Removed macros in adjust1.h: New / removed / modified configuration fields: New API functions: Removed API functions: Modified API functions: Description • PACKET_ON_SECOND_HOST • PMS_RX_SEG_PREALLOC_SIZE (range changed to satisfy the feature “Size-Prefixed Segmented Transfer“) ---• • • • Modified structures at API: New callback functions: Removed / modified callback functions: Summary of new features and significant changes: -• -• • MostSetLockTime() MostGetLockTime() MsgSend() now notifies XMIT_PROTECTED_MODE and frees the buffer, when it is called while EHC is detached from INIC The macros representing the return value of function MostGetState() are modified as follows: NET_ON MNS_NET_ON NET_NOTAVAIL MNS_NET_NOTAVAIL on_stop_netservices_fptr Redesign of namespaces leads to a reduction of used prefixes by 27 (including changes in all layers) Support of Size-Prefixed Segmented Transfer for Application Messages (TelID 0x4) Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 35 MOST NetServices V3.0.x V3.0.x-SR-2 6.3.2 Layer II The complete API is described in the respective user manual [M2.2]. Modification New macros in adjust2.h: Modified macros in adjust2.h: Removed macros in adjust2.h: New / removed / modified API functions: Modified structures at API: New callback functions: Modified callback functions: Removed callback functions: Summary of new features and significant changes: History Sheet Page 36 Description -• SIZE_DEVICE_TAB renamed to ADDRH_SIZE_DEVICE_TAB • DEVICE_TAB_NONVOLATILE renamed to ADDRH_DEVICE_TAB_NONVOLATILE • ET_ADD1 • ET_ADD2 • ET_ADD3 --• • • • • ET_DSIDSOCount_Request() Following macros that are used by both callback functions FBlockIDsChanged() and SystemCommunicationInit() are renamed as follows: STATUS_NOTOK NWM_CFG_STATUS_NOTOK STATUS_OK NWM_CFG_STATUS_OK STATUS_INVALID NWM_CFG_STATUS_INVALID STATUS_NEW NWM_CFG_STATUS_NEW STATUS_NEWEXT NWM_CFG_STATUS_NEWEXT ET_ManufacturerTimings_Query() FBlock Enhanced Testability according FBlock specification Rev2.6.1 Simplified configuration of FBlock ET Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 6.3.3 MOST High Protocol Service The complete API is described in the respective user manual [M2.3]. Modification New macros in adjustmh.h: Modified macros in adjustmh.h: Removed macros in adjustmh.h: New / removed / modified API functions: Modified structures at API: New / removed callback functions: Modified callback functions: Description • MHP_NO_COPY_ENABLE -• MHP_TX_DELAY_DUMMY_PACKET -• -- New parameter in TMhpTx: TotalPacketLength • New event signaled by MhpTxStatus(): MHP_TX_LEN_TOO_BIG New event signaled by MhpTxConStatus(): MHP_TX_CON_LEN_TOO_BIG Optimization (feature MHP_NO_COPY_ENABLE) to save one copy process and up to 966 bytes RAM size. The size of an MHP packet is no longer limited to 64 kByte. The API on sender side allows now to transmit data packets up to 3,9 GByte (4,294,901,760 byte). Extension of StartConnection command according MHP Specification Rev2.3 is supported to be able to use maximum block sizes of up to 65,535 byte. The limitation of 65,390 bytes (@1014 byte data link layer packet size) does no longer apply. Implicit HoldByRx command, transported in the Frame Acknowledge Command is now supported. It allows faster protocol response times if supported by sender and receiver. Dummy packets can no longer be transmitted on sender side to compensate delays on receiver side. The callback function MhpTxDelay() is now the only possibility to control the speed of the transmitter. Implemented Errata Item: 0201XX-053 • Summary of new features and significant changes: • • • • • • Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 37 MOST NetServices V3.0.x V3.0.x-SR-2 6.3.4 Packetizer for MOST High Service The complete API is described in the respective user manual [M2.4]. Modification New / modified / removed macros in adjustp.h: New / modified / removed API functions: New / modified / removed callback functions: Summary of new features and significant changes: Description ----- 6.3.5 Add-On Parallelized MOST Driver This section describes the delta within both Add-On modules PMHT and AAM. The complete API is described in the respective user manual [M2.5]. Modification New macros in adjustmh.h: Modified macros in adjustmh.h: Removed macros in adjustmh.h: New / modified / removed API functions: Modified structures at API: New / removed callback functions: Modified callback functions: Description • MHP_NO_COPY_ENABLE -• MHP_TX_DELAY_DUMMY_PACKET -• -- New parameter in TMhpTx: TotalPacketLength • New event signaled by MhpTxStatus(): MHP_TX_LEN_TOO_BIG New event signaled by MhpTxConStatus(): MHP_TX_CON_LEN_TOO_BIG The PMHT module supports the automatic supervision of MOST High Protocol Connections depending on the system state. This supervision can be disabled by defining the hidden switch MHP_DISABLE_CFG_MSG_FILTER. The size of MHP packets, that are transmitted by the PMHT module are no longer limited to 64 kByte. The API on sender side allows now to transmit data packets up to 3,9 GByte (4,294,901,760 byte). Extension of StartConnection command according MHP Specification Rev2.3 is supported to be able to use maximum block sizes of up to 65,535 byte. The limitation of 65,390 bytes (@1014 byte data link layer packet size) does no longer apply. Implicit HoldByRx command, transported in the Frame Acknowledge Command is now supported. It allows faster protocol response times if supported by sender and receiver. The AAM module supports control message telegrams up to 45 bytes payload on MOST150. Implemented Errata Item: 0201XX-053 • Summary of new features and significant changes: • • • • • • History Sheet Page 38 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 7 Version 3.0.0 7.1 MOST Specification Conformance This version of MOST NetServices is implemented according to following specifications: MOST Specification: MOST High Protocol Specification: FBlock NetBlock Specification: FBlock NetworkMaster Specification: FBlock ET Specification: General FBlock Specification: Rev. 3.0 Rev. 2.3 Rev. 3.0 Rev. 3.0 Rev. 2.6 Rev. 3.0 7.2 Supported Hardware This version of MOST NetServices supports following hardware and firmware combinations: Network MOST150 INIC OS81110 Hardware Revision Firmware Version MOST NetServices Version C 1.0.0 3.0.0 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 39 MOST NetServices V3.0.x V3.0.x-SR-2 7.3 Changes between V2.1.x-SR-1 and V3.0.0 This section provides you a guideline, how to upgrade from version 2.1.x-SR-1. The complete API and features are described in the respective user manuals [M1.1], [M1.2], [M1.3], and [M1.4]. The record is split-up into two sections. Section 7.3.2 summarizes all changes that were incorporated between V2.1.x-SR-1 and the last available alpha version, called V2.5.0.Alpha5. Section 7.3.1 figures all later changes after label V2.5.0.Alpha5. Both sections in combination are the result of all relevant changes between V2.1.x-SR-1 and V3.0.0. 7.3.1 Changes between V2.5.0.Alpha5 and V3.0.0 This section just describes the differences compared to the latest available alpha version, called V2.5.0.Alpha5. 7.3.1.1 Layer I The complete API is described in the respective user manual [M1.1]. Modification New optional API to the MBM module (“MBM Usage API”) to get detailed information about the resource usage. The feature, its API, and the respective configuration macros are described in the Application Note “MBM Usage API” [AN1.1]. New macros for configuration: - MBM_USAGE_API - MBM_USAGE_FRAG_SMALL - MBM_USAGE_FRAG_MEDIUM - MBM_USAGE_FRAG_LARGE - MBM_USAGE_CALLBACK - MBM_USAGE_INIT_CALLBACK New optional debug module (MLOG) for simple logging to memory. The feature, its API, and the respective configuration macros are described in the Application Note “MLOG Usage API” [AN1.2]. New macros for configuration: - MLOG_NUM_STORES - MLOG_LINE_SIZE - MLOG_MEMCPY - MLOG_ENTER_CRITICAL_SECTION - MLOG_NUM_LINES - MLOG_TIMESTAMP - MLOG_DUMP_LINE - MLOG_LEAVE_CRITICAL_SECTION The PMS and MBM modules provide support for the MLOG debug output: New macros for configuration: - PMS_MLOG_STORE - MBM_MLOG_STORE New utility API functions in wAMS: - MsgBcdToStr() - MsgVersionToISO8859() New utility API function in wMCS: MostSetGetNodeAddr() New API function to read the MAC address: MostGetEUI48() History Sheet Page 40 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 Modification The standard error mask, which is returned by several API functions, can now signal a new type of error: ERR_ALREADY_SET This return signal means, that the target value is already set. The application can therefore be aware that no message will be send to INIC and no callback function will be called. The new return value is introduced at MostSetAttenuation() and MsgSetRetryConfig(). Changed structure TDataRx: Removed fields: Tgt_Adr_H and Tgt_Adr_L New field: Rcv_Type The Receive Type indicates, over which addressing mode the data packet was received, quite similar to the already available receive types for the Control Channel (MSG_RCV_TYPE_*). Available Receive Types of wADS: - DATA_RCV_TYPE_LOGICAL - DATA_RCV_TYPE_NODE_POS - DATA_RCV_TYPE_BROADCAST - DATA_RCV_TYPE_GROUPCAST Changed macros in adjust1.h: PMS_RX_SEG_PREALLOC_SIZE now limited to 64000. MBM_MEM_UNIT_SIZE limited to 128. The maximum payload of an AMS message is limited to 64000 bytes. Please note: MBM_MEM_UNIT_SIZE and MBM_MEM_UNIT_NUM must now be defined without any typecast! The INIC based Timer Management is completely removed. The formerly known “Alternative Timer Management” is now the only available option and renamed to “EHC based Timer Management”. Please note: All applications, that did not define the formerly macro MNS_TM_ALTERNATIVE, have to be adapted to the EHC based Timer Management. Removed macro from adjust1.h: MNS_TM_ALTERNATIVE The wCMS module is obsolete now. The remaining API functions to control the characteristics of Control Message Transmission (Retry parameters) are moved into the AMS module. The Control Message Priority can no longer be controlled by application. Renamed API functions: - CtrlGetRetryConfig() MsgGetRetryConfig() - CtrlSetRetryConfig() MsgSetRetryConfig() New optional callback function: msg.retry_config_adjusted_fptr() Removed field from struct TMsgTx: Priority Removed error code, that may be reported by callback function general.on_error: - NSR_E_INVALID_PRIORITY Renamed public macros: - MASTER MNS_MASTER - SLAVE MNS_SLAVE - TRUE MNS_TRUE - FALSE MNS_FALSE - ATTENUATION_STANDARD MNS_ATTENUATION_STANDARD - ATTENUATION_ON MNS_ATTENUATION_ON Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 41 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Feature SCM_PM_AUTO supports now the new MediaLB 6pin mode clock speeds. The RMCK Port can now also be configured as input. New macro: SCM_RMCK_SCKFSY_INIC_IN SCM supports flow-control for isochronous channels on MediaLB now: New parameter in Socket Description: TScmSocketDesc.medialb.flow_control_enable Support of multiple connections on Streaming sockets of direction “in” on the MOST Network port. Changed parameter most.flags of Socket Description, supporting following new values: - SCM_MOST_FLAGS_DEFAULT - SCM_MOST_FLAGS_SINGLE_CONNECTION - SCM_MOST_FLAGS_MULTIPLE_CONNECTIONS Please note: It is mandatory now to set the field parameter flags, when creating a Streaming socket on the MOST Network port. If no flags are applicable the value must be set to "SCM_MOST_FLAGS_DEFAULT". It is no longer possible to treat the value as don’t care at MOST50+. MOST150 supports only segmentation mode MSG_RX_SEG_EHC_ONLY. The selection in Adjust1.h becomes therefore obsolete: - MSG_RX_SEG_COOPERATIVE - MSG_RX_SEG_INIC_ONLY - MSG_RX_SEG_EHC_ONLY Property NetBlock.AbilityToWake was renamed to NetBlock.PermissionToWake. Following parts on the Layer I API are affected and renamed: - MostGetAbilityToWake() MostGetPermissionToWake() - TWmcsReadPMStruct.AbilityToWake TWmcsReadPMStruct.PermissionToWake - FUNC_ABILITYTOWAKE FUNC_PERMISSIONTOWAKE Changed implementation of feature Sudden Signal Off Detection: New callback functions: - vmsv.sso_store_ssoresult_fptr - vmsv.sso_restore_ssoresult_fptr Changed API function: VmsvGetSSOResult() Removed legacy callback function: store_diag_info_fptr() The alternative callback function msval_diag_result_fptr() has to be used instead. New public macros, that can be used on application layer for version dependent pre-processor switches: - MNS_VERSION_MAJOR - MNS_VERSION_MINOR - MNS_VERSION_RELEASE - MNS_VERSION_STEP Implemented Errata items: 0201XX-038, 0201XX-045, 0201XX-047, 0201XX-050 Patch for errata 0201XX-038 is enabled on default. It can be disabled on demand by defining the hidden macro: DISABLE_PATCH_0201XX_038. History Sheet Page 42 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 7.3.1.2 Layer II The complete API is described in the respective user manual [M1.2]. Modification Implementation of FBlock Enhanced Testability according FBlock specification Rev2.6: New callback functions: - ET_DSO_Request() - ET_DSIHold_Request() Removed callback functions: - ET_SendViaMHP_Request() - ET_EchoViaMHP_Request() - ET_MemAlloc_Query() - ET_MemFree_Query() - ET_MamacPing_Request() Removed API functions: - ET_MamacPing_Reply() - ET_Store_Diag_Info() Removed macro in adjust2.h: ET_ADD4 New API function: ET_Store_Diag_Result() New API function: NbSetGetNodeAddr() The message filter, that is dependent on the System Configuration Status, can now also be used in devices that contain the NetworkMaster. Removed obsolete macros in adjust2.h: - NTF_BUF_REMAIN - NB_ADD4 Pointer PtrPropertyRef removed in struct TNtfPropL. The column, that contained the pointer onto the Property’s reference value, was removed from the Notification Service Property Tables. This column was used only in version 1.x. In version 2.x the entries were zero. This change applies to all Function Blocks that use the Notification Service (one table per FBlock). Following legacy modes are removed in MOST NetServices V3.0.x, i.e. the previous default behavior of version 2.1.x-SR-1 is now the only available behavior: - NTF_AVOID_MATRIX_INIT - NTF_INIT_ON_SHUTDOWN - NTFS_INIT_ON_CONFIG_NOTOK - NTFS_SUPPRESS_INIT_ON_CONFIG - NTFCHECK_NO_SEGMENTED_MSG - DEVICE_TAB_STORE_NETOFF - DISABLE_REGINFO_FROM_ANY_CR_STATUS - CMD_AVOID_ERROR_ON_BRDCAST_ONLY Property NetBlock.AbilityToWake was renamed to NetBlock.PermissionToWake. Following parts on the Layer II API are affected and renamed: Macros in adjust2.h renamed: - CB_NB_ABILITYTOWAKE_STATUS CB_NB_PERMISSIONTOWAKE_STATUS - CB_NB_ABILITYTOWAKE_ERROR CB_NB_PERMISSIONTOWAKE_ERROR Callback functions renamed: - Callback NbAbilityToWakeStatus() NbPermissionToWakeStatus() - Callback NbAbilityToWakeError() NbPermissionToWakeError() Implemented Errata items: 0201XX-048, 0201XX-049 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 43 MOST NetServices V3.0.x V3.0.x-SR-2 7.3.1.3 MOST High Protocol Service The complete API is described in the respective user manual [M1.3]. Modification Following legacy modes are removed in MOST NetServices V3.0.x, i.e. the previous default behavior of version 2.1.x-SR-1 is now the only available behavior: - MHP_TIMER_V010907 - MHP_TIMEOUT_SET_REV2_1 7.3.1.4 Packetizer for MOST High Service The complete API is described in the respective user manual [M1.4]. Modification No changes History Sheet Page 44 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 7.3.2 Changes between V2.1.x-SR-1 and V2.5.0.Alpha5 This section describes the differences between the previous released service release for MOST25, called NS V2.1.x-SR-1 and the latest alpha version for MOST150, called V2.5.0.Alpha.5. The API and features are described in the respective user manuals [M1.1], [M1.2], [M1.3], and [M1.4], and the ReadMe file for V2.5.0.Alpha5 [R1]. 7.3.2.1 Layer I Modification Support of use case “Ethernet over MOST” (OS81110 only). New macros in adjust1.h: - MEP_MIN - MEP_DEFAULT_RETRY_PRIO New macro to be used by Low Level Driver: - PMS_IS_MEP() New API functions: - PmsPrepareMepHeader() - PmsPrepareMepHeaderExt() New API functions to control the feature “Ethernet over MOST” (OS81110 only): - MostSetMEPFilterMode(), MostGetMEPFilterMode() - MostSetMEPHashTable(), MostGetMEPHashTable() - MostSetEUI48() New API functions to configure the retry time for data packets, applicable for MDP and MEP: - MostSetPacketRetryTime() - MostGetPacketRetryTime() Structure TDataTX is expanded by field “Retry”, so that the application can set the number of low level retries for each packet. Expanded SCM API to support new data types and ports: Introduced new macros to support Transport Stream Interface (TSI) Port, Recovered Master Clock Port (RMCK) and Serial Peripheral Interface (SPI) Port: - SCM_PORT_ID_TRANSPORT - SCM_PORT_ID_TRANSPORT_1 - SCM_PORT_ID_RMCK - SCM_PORT_ID_SPI Introduced new macros to support Isochronous Streaming and QoS IP Streaming data: - SCM_TYPE_ISOPACKET - SCM_TYPE_ISODFPHASE - SCM_TYPE_ISODFDATA - SCM_TYPE_QOS_IP_STREAM Macro SCM_TYPE_STREAM was renamed to SCM_TYPE_SYNC. The previous macro is deprecated but still available. Removed macro in adjust1.h: MLB_PIN_MODE Parameter interface_mode of structure TScmMediaLBPortConfig was removed. The MediaLB operation mode can now be set via the INIC Configuration String only. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 45 MOST NetServices V3.0.x V3.0.x-SR-2 Modification Changed Runtime Configuration structure of the LLD Interface to support packet data transmission via SPI. Removed the following fields: - mlb_ctrl_tx_fptr - mlb_data_tx_fptr - icm_interace_id - mcm_interface_id - mdp_interface_id Added the following fields: - ctrl_tx_fptr - data_tx_fptr - ctrl_interface_id - data_interface_id The new FIFO Interface can be used for MediaLB as well as for Serial Peripheral Interface (SPI) and replaces the macro PMS_IFACE_MEDIALB: - PMS_IFACE_GENERAL Removed the support for the following macros formerly may be used with PmsSetFifoInterface() and PmsGetFifoInterface(): - PMS_M_FIFO_ICM - PMS_M_FIFO_MCM - PMS_M_FIFO_MDP New Ring-Break-Diagnosis compliant to MOST Specification Rev3.0: New macro in adjust1.h: - MSV_DIAG_RESULT_MSG New fields in the configuration structure, in addition to the callback pointer: - vmsv.diag_id.stream - vmsv.diag_id.length New callback function: - vmsv.rbd_store_rbd_result_fptr() New possible diagnosis result: - MSVAL_DIAG_SIGNAL_NO_LOCK (or DIAG_POS0_SIGNAL respectively) New Network Interface state, that may be reported by callback function vmsv.msval_state_changed_fptr: MSVAL_S_RBDRES New Sudden Signal Off Detection compliant to MOST Specification Rev3.0: New API functions: - VmsvGetSSOResult() - VmsvResetSSOResult() New error codes, that may be reported by callback function general.on_error: - NSR_E_BIST_CONF_STRING - NSR_E_BIST_DATA_MEMORY MOST NetServices trace module is now able to signal the reason for each transition to Protected Mode (OS81110 only). Implemented Errata items: 0201XX-039, 0201XX-044 History Sheet Page 46 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 7.3.2.2 Layer II Modification Timer management improved to reduce CPU load. FBlock NetBlock is updated according FBlock specification Rev3.0. New FBlock functions: - FBlockInfo - ShutDownReason - RBDResult - ImplFBlocks - EUI48 New OpTypes for function: ShutDown New configuration macro in adjust2.h: NB_ADD8 New macros in adjust2.h to configure the NetBlockShadow part: - CB_NB_FBLOCKINFO_STATUS - CB_NB_FBLOCKINFO_ERROR - CB_NB_IMPLFBLOCKS_STATUS - CB_NB_IMPLFBLOCKS_ERROR - CB_NB_EUI48_STATUS - CB_NB_EUI48_ERROR - CB_NB_SHUTDOWNREASON_STATUS - CB_NB_SHUTDOWNREASON_ERROR New callback functions on slave side: - NbFBlockInfoGet() - NbImplFBlocksGet() New callback functions of NetBlock Shadow part: - NbFBlockInfoStatus() - NbFBlockInfoError() - NbImplFBlocksStatus() - NbImplFBlocksError() - NbEUI48Status() - NbEUI48Error() - NbShutDownReasonStatus() - NbShutDownReasonError() - NbShutDownResultAck() - NbShutDownErrorAck() New API functions: - NbGetVersion() - NbGetMOSTVersion() Removed FBlock function: NetBlock.SourceHandles Obsolete configuration macro in adjust2.h: NUM_SOURCE_HANDLES Obsolete macros in adjust2.h to configure the NetBlockShadow part: - CB_NB_SOURCEHANDLES_STATUS - CB_NB_SOURCEHANDLES_ERROR Obsolete callback functions of NetBlock Shadow part: - NbSourceHandlesStatus() - NbSourceHandlesError() Behavior of callback function NBFBlockIDsSet() changed in error case according MOST Specification Rev3.0. The function must not respond with an error message, but has to return an unchanged FBlock list. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 47 MOST NetServices V3.0.x V3.0.x-SR-2 Modification NetworkMaster Module is updated according FBlock Specification Rev3.0. New FBlock functions: - SystemAvail - FBlockInfo New OpTypes for function: SaveConfig New macros in adjust2.h: - CB_NM_SYSTEMAVAIL_STATUS - CB_NM_SYSTEMAVAIL_ERROR - CB_NM_FBLOCKINFO_STATUS - CB_NM_FBLOCKINFO_ERROR - CB_NM_VERSION_STATUS - CB_NM_VERSION_ERROR New callback functions: - NmSystemAvailStatus() - NmFBlockInfoStatus() - NmSaveConfigResultAck() - NmVersionStatus() - NmSystemAvailError() - NmFBlockInfoError() - NmSaveConfigErrorAck() - NmVersionError() Removed macros: - CB_NM_BOUNDARY_STATUS - CB_NM_BOUNDARY_ERROR Obsolete callback functions of NetworkMaster Shadow part: - NmBoundaryStatus() - NmBoundaryError() ‘NewExt’ as new possible parameter in event NetworkMaster.Configuration.Status. Callback functions SystemCommunicationInit() and FBlockIDsChanged() are expanded accordingly. 7.3.2.3 MOST High Protocol Service The complete API is described in the respective user manual [M1.3]. Modification Timer management improved to reduce CPU load. Fair block interleaving on receiver side on equal priorities, according new MOST High Protocol Specification Rev2.3. The change has no impact to the API. The legacy behavior can be forced by defining a hidden macro called DISABLE_MHP_REV_2_3. Implemented Errata items: 0201XX-036, 0201XX-037, 0201XX-040, 0201XX-043 7.3.2.4 Packetizer for MOST High Service Modification Timer management improved to reduce CPU load. History Sheet Page 48 Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 MOST NetServices V3.0.x V3.0.x-SR-2 Appendix A: Switchable Patches This section summarizes all macros, which are introduced to control switchable patches. Typically, the system integrator dictates the right values for these macros. Macro in the configuration file ‘adjust1.h’ ENABLE_HF_340 Introduced in Service Release V3.0.x-SR-2 Description Disabled on default. It is required only, when using OS81092 in a timing master device. Copyright © 1998 - 2012 SMSC Document Version: 3.0.x-7 Date: 2012-01-31 History Sheet Page 49