Multimedia and Control Networking Technology MOST System Management Module Update Information for Rev. 1.2.1 Document Information: Version: 1.2.1-2 Date: 2007-03-22 MOST® Media Oriented Systems Transport Copyright © 1998 - 2007 SMSC MOST System Management Module Update Information for Rev. 1.2.1 Legend Copyright © 1998 - 2007 SMSC or its subsidiaries. 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. Further Information For more information on SMSC products, including integrated circuits, software, and MOST development tools and modules, contact one of our offices below, or visit our web site: SMSC Europe GmbH Bannwaldallee 48 D-76185 Karlsruhe GERMANY Phone: +49 721 62537-0 Fax: +49 721 62537-119 Email: ais@smsc.com SMSC 1120 South Capital of Texas Highway Building 2, Suite 100 Austin, Texas 78746 USA Phone: +1 512 306-8450 Fax: +1 512 306-8442 Email: ais@smsc.com SMSC 38600 Van Dyke Avenue, Suite 220 Sterling Heights Michigan 48312-1172 USA Phone: +1 586 795-0545 Fax: +1 586 795-8950 Email: detroit-ais@smsc.com SMSC Japan KK 20th Floor Osaki New City Building #4 1-6-4 Osaki, Shinagawa-ku Tokyo, 141-0032 JAPAN Phone: +81 3 5487-0502 Fax: +81 3 5487-0490 Email: japan-ais@smsc.com SMSC Sweden AB Amerikahuset Barlastgatan 2 S-414 63 Göteborg SWEDEN Phone: +46 31 70460-30 Fax: +46 31 70460-31 Email: sweden-ais@smsc.com Technical Support Europe: support-ais-de@smsc.com Japan: support-ais-jp@smsc.com America: support-ais-usa@smsc.com http://www.smsc-ais.com Copyright © 1998 - 2007 SMSC Page 2 Document Version: 1.2.1-2 Date: 2007-03-22 MOST System Management Module Update Information for Rev. 1.2.1 MOST System Management Module Update Information for Version 1.2.1 Copyright © 1998 - 2007 SMSC All rights reserved Copyright © 1998 - 2007 SMSC Document Version: 1.2.1-2 Date: 2007-03-22 Page 3 MOST System Management Module Update Information for Rev. 1.2.1 Document History Version Date Section Comment on Changes General - Document converted to SMSC style Initial version for MOST System Management Module software release V1.2.1 (YYYY-MM-DD) 1.2.1-2 1.2.1-1 2007-03-22 2006-01-23 References Reference [1] [2] [3] [4] [5] [6] [7] [8] [9] Document MOST Specification MOST NetServices User Manual Layer I MOST NetServices V2 User Manual Layer I MOST NetServices User Manual Layer II FBlock NetBlock Specification (Function Catalog) FBlock NetworkMaster Specification (Function Catalog) FBlock ConnectionMaster Specification (Function Catalog) General FBlock Specification (Function Catalog) MOST System Management Module User Manual Copyright © 1998 - 2007 SMSC Page 4 Document Version: 1.2.1-2 Date: 2007-03-22 MOST System Management Module Update Information for Rev. 1.2.1 Table of Contents 1 VERSION 1.2.1 .................................................................................................................................7 1.1 Specification Conformance............................................................................................................7 1.2 Document Versions .......................................................................................................................7 1.3 Supported Hardware......................................................................................................................7 1.4 Differences between V1.2.1 and V1.1.0 ........................................................................................8 1.4.1 Network Management ............................................................................................................8 1.4.2 Connection Management .......................................................................................................9 1.4.3 Power Management ............................................................................................................ 11 Copyright © 1998 - 2007 SMSC Document Version: 1.2.1-2 Date: 2007-03-22 Page 5 MOST System Management Module Update Information for Rev. 1.2.1 Conventions Within this document, the following abbreviations and symbols are used for improving readability: MSMM FileName.xxx FunctionName() x..y 0xzz RSVD x Comment MOST System Management Module Name of a file Name of a function Range from x to y. Used as abbreviation e.g., for a group of bits like D7..0 Hexadecimal number (value zz) The respective value is reserved for future use Don’t care Copyright © 1998 - 2007 SMSC Page 6 Document Version: 1.2.1-2 Date: 2007-03-22 MOST System Management Module Update Information for Rev. 1.2.1 1 Version 1.2.1 1.1 Specification Conformance This version of MSMM is implemented according to following specifications: Document MOST Specification [1] MOST NetServices User Manual Layer I [2] MOST NetServices V2 User Manual Layer I [3] MOST NetServices User Manual Layer II [4] FBlock NetBlock Specification (Function Catalog) [5] FBlock NetworkMaster Specification (Function Catalog) [6] FBlock ConnectionMaster Specification (Function Catalog) [7] General FBlock Specification (Function Catalog) [8] Revision 2.5 1.10.x 2.1.x 1.10.x/2.1.x 2.5.0 2.5.0 2.5.0 2.5.0 1.2 Document Versions Document MOST System Management Module User Manual Version 1.2.x-3 1.3 Supported Hardware This version of MSMM supports the following hardware and firmware variants: 1 2 Network NIC Hardware Revision Firmware Version MOST25 OS8104 D N/A Network INIC MOST25 OS81050 Firmware Version 1.9.x1 1.10.x2 MOST50 OS81082 Hardware Revision D1 E2 A1 B2 1.3.x NetServices Version 1.10.3 1 V1.10.XX-SR-10 2 NetServices Version 2.1.01 2.1.12 Not recommended Recommended Copyright © 1998 - 2007 SMSC Document Version: 1.2.1-2 Date: 2007-03-22 Page 7 MOST System Management Module Update Information for Rev. 1.2.1 1.4 Differences between V1.2.1 and V1.1.0 This section describes the differences between MSMM version 1.2.1 and version 1.1.0. The complete API and configuration switches are described in the MSMM user manual [9]. 1.4.1 Network Management Modification New Macros in adj_msm.h Modified Macros in adj_msm.h New API Functions Modified API Functions New Callback Functions Modified Callback Functions Adapting MOST NetServices V1.x Layer I Adapting MOST NetServices V1.x Layer II Adapting MOST NetServices V2.x Layer I Description None None Migration Guide n/a n/a None None None None None n/a n/a n/a n/a n/a None n/a msval_event_fptr() Adapting MOST NetServices V2.x Layer II New Files Removed Files None This callback should now be used to report MSM_E_NETON and MSM_E_NETOFF events instead of the msval_state_changed_fptr() callback as was previously specified. n/a None None n/a n/a Copyright © 1998 - 2007 SMSC Page 8 Document Version: 1.2.1-2 Date: 2007-03-22 MOST System Management Module Update Information for Rev. 1.2.1 1.4.2 Connection Management Modification New Macros in adj_msm.h Description MSM_CM_FORCE_ALLOCATE MSM_CM_BOUNDARY_DELAY MSM_CM_BOUNDARY_REBUILD Modified Macros in None adj_msm.h MSM_ECM_NUM_SINKS Removed Macros from adj_msm.h MSM_ECM_NUM_SOURCES MSM_ECM_NUM_MLC MSM_ECM_NUM_HMI MSM_ECM_NUM_CLUSTERS MSM_ECM_NUM_SOURCETYPES mlcList Modified information in mlcConnectionList msm_ecm.tab mlcSourceTypeList Migration Guide This macro is used to force the Connection Manager to use Allocate on source devices supporting both Allocate and SourceConnect. If not defined, SourceConnect will be used if both methods are supported. Only applicable for MOST25 networks since SourceConnect is not supported for MOST50 networks. This macro is used to set the initial delay in [ms] that the Connection Manager waits after receiving a MoveBoundary.StartResult call and sending notification on boundary change until the actual boundary change process is started. If this macro is defined, all present synchronous connections will be rebuilt after a boundary change, initiated by a call to MoveBoundary.StartResult, during runtime has been completed. Only applicable for MOST25 networks since synchronous connections does not have to be disconnected before changing the boundary on MOST50 networks. n/a Moved to msm_ecm.tab Renamed variable and type names in the msm_ecm.tab file. hmiId information has been removed from mlcList and clusterList. ECMType_Mlc ECMType_MlcConnection New API Functions None See MSMM User Manual [9] for detailed information (“Document History” and “Configuring msm_ecm.tab” sections) n/a To be continued … Copyright © 1998 - 2007 SMSC Document Version: 1.2.1-2 Date: 2007-03-22 Page 9 MOST System Management Module Update Information for Rev. 1.2.1 Continued Modification Modified API Functions New FBlock Functions Description None Migration Guide n/a MoveBoundary() (0x402) Modified FBlock Functions New Callback Functions Modified Callback Functions Adapting MOST NetServices V1.x Layer I Adapting MOST NetServices V1.x Layer II None Method to change boundary during runtime. Property to inform about boundary change. n/a None n/a None n/a None n/a NbBoundarySetQuery() Adapting MOST NetServices V2.x Layer I Adapting MOST NetServices V2.x Layer II None On the TimingMaster device, this callback must always return TRUE to allow the ConnectionManager to access NetBlock property Boundary.SetGet. n/a New Files msm_cm_25.c BoundaryChange() (0x403) NbBoundarySetQuery() msm_cm_50.c Removed Files msm_cm.c If ConnectionManager runs on the TimingMaster device this callback should always return FALSE to prevent other devices from accessing the NetBlock property Boundary.SetGet. If the ConnectionManager runs on a TimingSlave device this callback must always return TRUE on the TimingMaster device to allow the ConnectionManager to access NetBlock property Boundary.SetGet. This file replaces msm_cm.c if MSM_CONNECTIONMASTER macro is defined in adj_msm.h and running on a MOST25 network. This file replaces msm_cm.c if MSM_CONNECTIONMASTER macro is enabled in adj_msm.h and running on a MOST50 network, i.e. MSM_MOST_50 macro defined in adj_msm.h Replaced by msm_cm_25.c and msm_cm_50.c Copyright © 1998 - 2007 SMSC Page 10 Document Version: 1.2.1-2 Date: 2007-03-22 MOST System Management Module Update Information for Rev. 1.2.1 1.4.3 Power Management Modification New Macros in adj_msm.h Modified Macros in adj_msm.h New API Functions Modified API Functions New Callback Functions Modified Callback Functions Modified API Macros New Files Removed Files Description None None None None None None None None None Migration Guide n/a n/a n/a n/a n/a n/a n/a n/a n/a Copyright © 1998 - 2007 SMSC Document Version: 1.2.1-2 Date: 2007-03-22 Page 11