FDM RTX RELEASE 2 User Reference Manual
Contents
1. RELEASE 2 User Reference Manual ALS 53330 c en First issue 04 2000 This edition 01 2001 Meaning of terms that may be used this document Notice to readers WARNING Warning notices are used to emphasize that hazardous voltages currents temperatures or other conditions that could cause personal injury exist or may be associated with use of a particular equipment In situations where inattention could cause either personal injury or damage to equipment a Warning notice is used Caution notices are used where there is a risk of damage to equipment for example Notes merely call attention to information that is especially significant to understanding and operating the equipment This document is based on information available at the time of its publication While efforts have been made to be accurate the information contained herein does not purport to cover all details or variations in hardware or software nor to provide for every possible contingency in connection with installation operation or maintenance Features may be described herein which are not present in all systems ALSTOM assumes no obligation of notice to holders of this document with respect to changes subsequently made ALSTOM makes no representation or warranty expressed implied or statutory with respect to and assumes no responsibility for the accuracy completeness sufficiency or usefulness of the information contained herein ALSTOM2. 2 31 deo epe n epe RI EE 2 5 ae ee epe edes 2 5 rtfdm _ _ 2 6 rtfdm 10 2 7 rtfdm mps var read 10 2 8 rtfdm mps var write universal 2 0 rtfdm mps var read 1 3 SYNCHRONISATION ALS 53330 FDM RTX RELEASE 2 User Reference Manual Contents Page 9 Contents 4 BUS ARBITRATOR MANAGEMENT 4 14 4 1 ba load macrocycle fipconfb 4 14 4 2 rtfdm ba load macrocycle manual 4 14 4 3 rtfdm ba delete 4 4 15 2 4 Ree ttov ap eese 4 16 4 5 e Ee Mies 4 16 4 6 SERE ER mE UR teu s 4 17 4 7 rtfdm ba set 4 17 4 8 ba priority 4 18 5 MANAGING WORLDFIP DATA LINK LAYER MESSAGES 4 19 SAs rtfdmi channe l create bs be tidie
3. The FIP DEVICE MANAGER RTX Release 2 software package offers the user many functions that derive from the basic FDM VA software package The interface which is then available differs principally from the basic FDM VA interface in terms of management of initialisation functions hardware software network medium and the management of communication ticks interrupts etc services for the exchange of variables messages and bus arbitration which are limited to standard services time management service which is limited to broadcasting the time of the PC and managing the redundancy of the time producer additional functions used to create the contexts necessary for RTX applications and manage error processing The user RTSS process must be linked to the fdmrtdll lib import library The user RTSS process must be generated by a Visual 6 0 compiler on RTX 4 3 1 In addition the RTSS must be compiled in struct member alignment 8 bytes mode which is the default option proposed by the Visual 6 0 compiler or later Applications can be created that partition their time critical functions to run in the RTSS environment and non time critical functions to run in the Win32 environment Processes in both environments can communicate and synchronise through the shared RTX Interprocess Communication IPC objects Processes in the RTSS environment perform the high speed deterministic control functions of the application T
4. ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 4 3 Detailed description of the functions The hardware watchdog can be removed if you write 0 in Ref Port Verif Altera before calling this function 1 5 rtfdm initialize network BOOL rtfdm initialize network RTSS FDM Ref const FDM CONFIGURATION SOFT Soft const FDM CONFIGURATION HARD Hard const FDM IDENTIFICATION Ident initialisation of FDM instance Parameters Ref reference of an RTX FDM instance Soft typedef struct Ushort MESSAGE RECEPTION AUTHORIZED TWO BUS TWO IMAGE MODE enum FULLFIP Mode List Mode Ushort TSlot Ushort NB OF USER MPS VARIABLE 150 Ushort BA Dim 0x2000 Ulong FULLFIP RAM Dim interne Ushort OF DIFFERENT ID PROG BA 0x100 Ushort Nr Of Repeat 1 Ushort Nr_Of_Tx_Buffer 9 II 4 4 4 4 4 4 4 4 4 void User Present List Prog struct REF FDM PRESENT LIST Ushort User Identification Prog struct FDM REF IDENT VAR Page 4 4 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions Ushort Report Prog struct FDM REF FDM REPORT VAR Ushort User Presence Prog struct FDM REF FDM PRESENCE VAR void User Synchro BA Prog struct FDM REF FDM SYNCHRO VAR Ushort Test Medium Ticks interne Ushort Time_Out
5. RELATED PUBLICATIONS The documents quoted in this manual are specified in the text in square brackets and listed in this section 1 ALS 50278 FIP DEVICE MANAGER Software Version 4 User Reference Manual 2 ALS 53316 WorldFIP PCI Communication Board CC138 139 140 141 V1 User Reference Manual For more information on WorldFIP and hardware components 3 ALS 50249 FIP Network General Introduction 4 ALS 50262 FULLFIP2 User Reference Manual 4 WEWELCOME YOUR COMMENTS AND SUGGESTIONS ALSTOM strives to produce quality technical documentation Please take the time to fill in and return the Reader s Comments page if you have any remarks or suggestions Page 6 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Reader s comments ALS 53330 FDM RTX RELEASE 2 User Reference Manual Your main job is System designer L Distributor Maintenance System integrator Operator Installer If you would like a personal reply please fill in your name and address below Programmer Other specify below COMPANY NAME ADDRESS lectu dyttid eaedem decedunt utu Send this form directly to your ALSTOM sales representative or to this address ALSTOM Technology Technical Documentation Department TDD 23 25 Avenue Morane Saulnier 92364 Meudon la For t Cedex France Fax 33 0 1 46 29 10 21 comments will be considered
6. SEND type data structure describing the context Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 20 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 5 5 rtfdm messaging to rec create BOOL rtfdm messaging to rec create RTSS FDM Ref int Rang FDM MESSAGING TO REC Data Buffer Used to create a messaging context for receiving Parameters Ref reference of a RTX FDM instance Rang messaging context number Data Buffer pointer to an FDM MESSAGING TO REC type data structure describing the context Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 5 6 rtfdm messaging delete BOOL rtfdm messaging to rec create RTSS FDM Ref int Rang Used to delete a messaging context Parameters Ref reference of a RTX FDM instance Rang messaging context number Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 21 Detailed description of the functions 5 7 rtfdm send message BOOL rtfdm se
7. by qualified personnel REMARKS Continue on back if necessary ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 7 Reader 5 comments Page 8 FDM RTX RELEASE 2 User Reference Manual ALS 53330 CHAPTER 1 INTRODUCTION CHAPTER 2 INSTALLATION 1 SUPPLY scias s RE Fdo e bled Miis 2 INSTALLATION 2 25060 3 START UP S TOP CHAPTER 3 USE 1 PROGRAMMING INTERFACE 2 TIMEMANAGEMENT ER 3 PERFORMANCE eR eas 4 ERROR PROCESSING CHAPTER 4 DETAILED DESCRIPTION OF THE FUNCTIONS 1 INITIATISATIQON een dH pb 1 1 create multiboard context 1 2 rtfdm 1 3 xtfdm delete context eT L4 anuales Re ER 1 5 2 1 6 valid medium 1 7 rtfdm stop network 2 AE LE AND MPS VARIABLES MANAGEMENT 2 1 rtfdm ae le create 2 2 attdm ae Te delete eevee fa save bees hing bara e OR
8. gives no warranties of merchantability or fitness for purpose In this publication no mention is made of rights with respect to trademarks or tradenames that may attach to certain words or signs The absence of such mention however in no way implies there is no protection Partial reproduction of this document is authorized but limited to internal use for information only and for no commercial purpose However such authorization is granted only on the express condition that any partial copy of the document bears a mention of its property including the copyright statement rights reserved Copyright 2001 ALSTOM Paris France Page 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Revisions b 08 2000 8 Chapter 4 functions rffdm get version get count and rtfdm initialize network 01 2001 Use of the CC141 board ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 3 Revisions Page 4 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Preface 1 PURPOSE OF MANUAL AND DOCUMENTED VERSION This document is the manual for the implementation of FIP DEVICE MANAGER Version 4 designed for a Windows NT 4 environment on PCs equipped with VenturCom s RTX real time extension of the CC139 CC140 and CC141 PCI communication boards This product therefore expands the FIP DEVICE MANAGER offer within the framework of ALSTOM s WorldFIP technological offer globally marketed under
9. in the example program can be used NEW USER creation of a memory pool DELETE USER deletion of a memory pool ALLOCATE MEMORY allocation of a memory bloc inside a memory pool FREE MEMORY freeing of a memory bloc inside a memory pool ALS 53330 FDM RELEASE 2 User Reference Manual Page 6 1 Miscellanous Page 6 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330
10. msg contexts 40 Available messaging channels 0 for aperiodic 1 8 for periodic fdm ticks counter period 100 ms ALS 53330 FDM RELEASE 2 User Reference Manual Page 3 3 4 ERROR PROCESSING The GetLastError function returns the calling thread s last error code value The last error code is maintained on a per thread basis Multiple threads do not overwrite each other s last error code DWORD GetLastError VOID Parameters This function has no parameters Return Values The return value is the calling thread s last error code value Functions set this value by calling the SetLastError function The Return Value section of each reference page notes the conditions under which the function sets the last error code Page 3 4 FDM RTX RELEASE 2 User Reference Manual ALS 53330 1 Chapter Detailed description of the functions 4 INITIALISATION Use of only one board In this case you must call the function rtfdm create monoboard context Use of more than one board In this case you must call the function rtfdm create multiboard context Before calling this function you must detect the characteristics of your PCI board by using the FipBoardConf exe utility The following screen gives you the main parameters that you must enter the rtfdm_create_multiboard_context function Propri tes carte PCI FDM RTX v Sans application FDM NT FIPSPY RT FDM INST
11. returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 9 Detailed description of the functions 2 5 rtfdm mps var create BOOL rtfdm mps var create RTSS FDM Ref int AE LE RANG const FDM XAE Var Param Defines the parameters of a variable in an LE Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 47 Var Param pointer to a structure describing the parameters of the variable Refer to 1 for the description of this structure Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 2 6 rtfdm mps var write loc BOOL rtfdm mps var write loc RTSS FDM Ref int AE LE RANG int VAR RANG USER BUFFER TO READ Data Buffer Writing of an MPS variable Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 9 VAR RANG row of the variable in the AE LE Data Buffer pointer to a USER BUFFER TO READ type structure containing the data to be written Refer to 1 for the description of this structure Page 4 10 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions Return Values The function returns TRUE i
12. the FIPWARE trademark This document describes installation configuration and start up the special features of this version as regards the application interface in relation to the basic interface offered by the FIP DEVICE MANAGER Version 4 function library This document in no way constitutes a training manual for the operating concepts and principles of the WorldFIP network Users depending on whether they are installing this software on a PC to serve as a user application or whether they plan to carry out the interfacing of an application must have a working or advanced knowledge of WorldFIP operating principles Users who plan to develop the interfacing of an application with this software must follow the FIP DEVICE MANAGER Version 4 manual as it is indispensable to this task 2 CONTENT OF THIS MANUAL This user manual is structured in the following way Chapter 1 Introduction General presentation of the software in relation to the hardware and software environment into which it is integrated Chapter 2 Installation Commissioning of the software under a Windows environment on a PC equipped with a WorldFIP coupling board installation definition of parameters start up stop Chapter 3 Use Chapter 4 Detailed description of the functions Description of the programming interface Chapter 5 Error List Chapter 6 Miscellanous ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 5 Preface 3
13. the slot number hexadecimal given by the ScanBus utility 2 Waiton this Event RtWaitForSingleObject EvtEoc INFINITE The event FIP EOC Event is created by the fdmrtdll rtss library with the following parameters InitialState FALSE Automatic reset mode ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 4 13 Detailed description of the functions 4 BUS ARBITRATOR MANAGEMENT 4 1 rtfdm ba load macrocycle fipconfb BOOL rtfdm ba load macrocycle fipconfb RTSS FDM Ref int BA RANG const Ushort ba fipconfb Used to create and load a macrocycle Parameters Ref reference of a RTX FDM instance RANG row of the macrocycle O 1 ba fipconfb pointer to a table generated in the FIPCONFB tool format Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 4 2 rtfdm ba load macrocycle manual BOOL rtdm ba load macrocycle manual RTSS FDM Ref int BA RANG int Nb of List int Nb of Instruction unsigned short Label const PTR LISTS List const INSTRUCTIONS Instructions Used to create and load a macrocycle Page 4 14 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions Parameters Ref reference of a RTX FDM instance RANG row of the macrocycle O 1 Nb o
14. 4 19 52 rtfdmechannel enr eR eR Mien p DU edn ely 4 19 5 3 rtfdm messaging fullduplex create 4 20 5 4 rtfdm messaging to send create 4 20 5 5 rtfdm messaging to rec create 4 21 5 6 rifdmimessaging delete Ee 4 21 5 7 xtidm send message Reo MARRE E UE 4 22 5 8 rtfdm msg ref buffer free 4 22 6 MANAGING SM MPS NETWORK MANAGEMENT VARIABLES 4 23 6 1 s en Reha 4 23 6 2 tidmeread present lit cooks PERS DESCR E 4 23 6 3 read identification 4 24 6 4 read presence 4 24 6 5 rtfdm read ba synchronize 4 25 T MANAGING MPS TIME 4 26 7 1 rtfdm_generic_time_initialize 4 26 7 2 rtfdm generic time set 4 27 7 3 generic time set candidate for election 4 27 7 4 rtfdm generic time get e
15. ANCE rtfdm create multiboard context 0 13 0 ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 4 1 Detailed description of the functions 1 1 rtfdm create multiboard context RTSS FDM rtfdm create multiboard context ULONG Bus ULONG Slot ULONG Funct VOID RTFCNDCL ShutDownRoutine PVOID Context LONG Reason Constructor of a FDM RXT instance This function initialises all the registers of the board Parameters Bus number of PCI bus where the board is plugged Slot Slot number Funct function number ShutDownRoutine The handler function to call when FDM RTSS delivers the stop notification Context The pointer to the RTSS reference Reason The reason argument may have one of the following values according to the reason for the notification RT SHUTDOWN NT SYSTEM SHUTDOWN The system is starting a normal shutdown Shortly after all shutdown handlers have been executed Windows NT will stop RT SHUTDOWN NT STOP Windows NT has stopped i e blue screen RTSS will continue to operate with service restrictions Return Values A stop handler object has been correctly instantiated when a valid handle is returned Otherwise INVALID HANDLE VALUE is returned and you should call GetlastError for more detailed information Page 4 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 1 2 rtfdm create monoboard context RTSS FDM rtfdm cre
16. L rtfdm generic time delete RTSS FDM Ref Deletion of the time management object Parameters Ref reference of a RTX FDM instance Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 28 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 8 UTILITIES 8 1 rtfdm get image BOOL rtfdm get image RTSS FDM Ref FDM IMAGE NR Value This function is used to find out which image the AE LE and the messaging context are on Parameters Ref reference of a RTX FDM instance Value the result is IMAGE 1 or IMAGE 2 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 8 2 rtfdm switch image BOOL rtfdm switch image RTSS FDM Ref enum IMAGE NR image This function is used to request switching of the AE LE and messaging context image Parameters Ref reference of a RTX FDM instance image IMAGE 1 or IMAGE 2 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 29 Detailed description of the functions 8 3 rtfdm get versio
17. RANG row of the variable in the AE LE Data Buffer pointer to a USER BUFFER TO READ type structure containing the data to be written Refer to 1 for the description of this structure Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 2 9 rtfdm mps var read universal BOOL rtfdm mps var read universal RTSS FDM Ref int AE LE RANG int VAR RANG This function makes it possible to read an MPS variable whether it is local or remote If the variable is remote then an aperiodic request is made When the variable is received then a user callback procedure is activated is User Signal Var Cons field of FDM XAE structure refer to 1 for more information Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 9 VAR RANG row of the variable in the AE LE Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 12 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 3 SYNCHRONISATION You can synchronise your application on the FIP synchronisation variable You must proceed as follows 1 Openthe RTX event FIP EOC Event HANDLE EvtEoc RtOpenEvent O FALSE L FIP EventXX where XX is
18. Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 6 2 rtfdm read present list BOOL rtfdm read present list RTSS FDM Ref Used to read a subscriber present list variable Refer to 1 Parameters Ref reference of a RTX FDM instance Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 23 Detailed description of the functions 6 3 rtfdm read identification BOOL rtfdm read identification RTSS FDM Ref int subscriber Used to read the subscriber identification variable Refer to 1 Parameters Ref reference of a RTX FDM instance subscriber physical address of the subscriber whose identification variable is to be read Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 6 4 rtfdm read presence BOOL rtfdm read presence RTSS FDM Ref int subscriber Used to read the subscriber presence variable Refer to 1 Parameters Ref reference of a RTX FDM instance subscriber physical address of the subscriber whose presence variable is to be read Return Values The function ret
19. _Ticks 100 ms Ushort Time_Out_Msg_Ticks 100 ms Ushort Online_Tests_Ticks 0 Ushort Default_Medium_threshold 112 struct Ushort TIMER_CNT_REGISTER Ushort MODE REGISTER User responsability void User Sienal Mps Aper C struct FDM_REF interne void User Signal Smmps struct FDM REF interne void User Signal Send Msg struct interne void User Signal Rec Msg struct interne void User Ctxt interne FDM CONFIGURATION SOFT Hard typedef struct CONFIGURATION HARD Uchar K PHYADR char MySegment Uchar Reserved 2 Port LOC EIPIS interne Port Type LOC FIPDRIVEI4 interne Ushort yelatile FREE ACCES ADDRESS interne void User_Reset_Component interne Cstruct EDM CONFIGURATION HARD 3 void User Sienal Fatal Error interne Cstruet CEDM REF Ref FDM ERROR CODEJ void User Sienal Warning interne struct FDM REF Ref FDM_ERROR_CODE ALS 53330 RTX RELEASE 2 User Reference Manual Page 4 5 Detailed description of the functions MEMORY RN Memory Management Ref struct CEDM REE Pt amp Autotests FDM CONFIGURATION HARD Ident typedef struct char Vendor Name char Model Name char Revision char Tag Name char SM MPS Conform char SMS Conform char PMDP Conform char Vendor Fi
20. age 1 4 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Chapter Installation 2 1 SUPPLY The main files contained in the supply are fdmrtdll rtss the executable module fdmrtdll lib the import library file that must be linked to the user application messages dll dll that processes errors Setup utility used for the installation ScanBus utility used for association of a board to RTSS process ErrorLookup utility that gets you the details of an error header files examples documents User Reference Manual 2 INSTALLATION Double click Setup exe program ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 2 1 Installation 3 START UP STOP START Several methods are available to start fdmrtdll rtss the command prompt enter RTSSRUN fdmrtdll rtss be started at boot time from the command prompt enter RTSSRUN b fdmrtdll rtss directly from a WIN32 process a RTSS process you must call the CreateProcess function that executes RTSSRUN To start the RTSS application you can use one of the above methods used to start the fdmrtdll rtss dynamic link library The fdmrtdll rtss dynamic link library must be started before starting the user process STOP From the command prompt enter RTSSKILL b process number Page 2 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Chapter Use 3 1 PROGRAMMING INTERFACE
21. ate monoboard context VOID RTFCNDCL ShutDownRoutine PVOID Context LONG Reason Constructor of a FDM RXT instance This function scans one PCI board and initialises all the registers of this board Parameters ShutDownRoutine The handler function to call when FDM RTSS delivers the stop notification Context The pointer to the RTSS reference Reason The reason argument may have one of the following values according to the reason for the notification RT SHUTDOWN NT SYSTEM SHUTDOWN The system is starting a normal shutdown Shortly after all shutdown handlers have been executed Windows NT will stop RT SHUTDOWN NT STOP Windows NT has stopped 1 blue screen RTSS will continue to operate with service restrictions Return Values A stop handler object has been correctly instantiated when a valid handle is returned Otherwise INVALID HANDLE VALUE is returned and you should call GetlastError for more detailed information 1 3 rtfdm delete context void rtfdm delete context RTSS FDM Ref Destructor of a FDM RXT instance Parameters Ref reference of a RTX FDM instance No Return Values 1 4 rtfdm initialize BOOL rtfdm initialize RTSS FDM Ref Initialization of RTX environment parameters Parameters Ref reference of a RTX FDM instance Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information
22. e for election BOOL rtfdm generic time set candidate for election RTSS FDM Ref enum FDM BOOLEAN state This function enables the user to include or to exclude the subscriber in the procedure for managing redundancy of the MPS time variable producers ID 9802 Parameters Ref reference of a RTX FDM instance state TRUE to include the subscriber in the procedure for managing redundancy of the MPS time variable producers or FDM FALSE to exclude Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 27 Detailed description of the functions 7 4 rtfdm generic time get election status BOOL rtfdm generic time get election status RTSS FDM Ref EtatAbonnes result Used to know the status of the subscriber regarding the election process of the time variable Parameters Ref reference of a RTX FDM instance result pointer to a EtatAbonnes type data structure described below that contains the status type def struct unsigned abonnes 8 enum subscriber states state 4 unsigned Prio 4 EtatAbonnes Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 7 5 rtfdm generic time delete BOO
23. eld FDM IDENTIFICATION Return Values interne interne interne interne interne interne The function returns TRUE if it completes successfully otherwise it returns FALSE If FALSE is returned then you should call GetlastError for more detailed information 1 6 rtfdm valid medium BOOL rtfdm valid medium RTSS FDM Ref enum MEDIUM DEF Medium Choice of media to be used Parameters Ref reference of a RTX FDM instance Medium medium Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 6 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 1 7 rtfdm stop network BOOL rtfdm stop network RTSS FDM Ref Stop the network that has been started by the function rtfdm initialize network Parameters Ref reference of a RTX FDM instance Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 7 Detailed description of the functions 2 AE LE AND 5 VARIABLES MANAGEMENT 2 1 rtfdm ae le create BOOL rtfdm ae le create RTSS FDM Ref int AE LE RANG int AE LE DIM Creation of an Para
24. f List Number of lists described Nb of Instruction Number of instructions described Label Internal macrocycle label Lists Pointer to a data structure of the LISTS type described above containing the sequences of identifiers to be circulated Instructions Pointer to a data structure of the PTR INSTRUCTIONS type described above containing the sequences of instructions to be executed Refer to 1 for more information Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 4 3 rtfdm ba delete macrocycle BOOL rtfdm ba delete macrocycle RTSS FDM Ref int BA RANG Used to delete a macrocycle Parameters Ref reference of a RTX FDM instance RANG row of the macrocycle O 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 15 Detailed description of the functions 4 4 rtfdm ba status BOOL rtfdm ba status RTSS FDM Ref BA INF STATUS Resultats Used to read the status of the BA function of the station Parameters Ref reference of a RTX FDM instance Resultats pointer to a BA INF STATUS type structure described below and containing the status of the BA Refer to 1 f
25. f it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 2 7 rtfdm mps var read loc BOOL rtfdm var read loc RTSS FDM Ref int AE LE RANG int VAR RANG USER BUFFER TO READ Data Buffer Reading of an MPS variable Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 9 VAR RANG row of the variable in the AE LE Data Buffer pointer to a USER BUFFER TO READ type structure containing the data to be read Refer to 1 for the description of this structure Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 2 8 rtfdm mps var write universal BOOL rtfdm mps var write universal RTSS FDM Ref int AE LE RANG int VAR RANG USER BUFFER TO READ Data Buffer This function makes it possible to write an MPS variable whether it is local or remote If the variable is remote then an aperiodic request is made When the variable is sent then a user callback procedure is activated is User Signal Var Prod field of FDM_XAE structure refer to 1 for more information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 11 Detailed description of the functions Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 9 VAR
26. formation 5 2 rtfdm channel delete BOOL rtfdm channel delete RTSS FDM Ref Ushort Channel nr Used to delete a periodic messaging channel Parameters Ref reference of a RTX FDM instance Channel nr number of the channel to be deleted Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 19 Detailed description of the functions 5 3 rtfdm messaging fullduplex create BOOL rtfdm messaging fullduplex create RTSS FDM Ref int Rang FDM MESSAGING FULLDUPLEX Data Buffer Used to create a new FULLDUPLEX messaging system context Parameters Ref reference of a RTX FDM instance Rang messaging context number Data Buffer pointer to an MESSAGING FULLDUPLEX type data structure describing the context Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 5 4 rtfdm messaging to send create BOOL rtfdm messaging to send create RTSS FDM Ref int Rang _ MESSAGING TO SEND Data Buffer Used to create a messaging context for sending Parameters Ref reference of a RTX FDM instance Rang messaging context number Data Buffer pointer to an MESSAGING TO
27. he process in the Win32 environment can utilise the complete range of Win32 functions as graphical displays and data storage ALS 53330 FDM RELEASE 2 User Reference Manual Page 3 1 Use User application ALSTOM DELIVERY Figure 3 1 Application Programming Interface 2 TIME MANAGEMENT Depending on the settings made the PC may choose to broadcast its time over the network thanks to the ID9802 variable using specific FDM V4 mechanisms The time is displayed in POSIX format The variable produced is updated automatically every 500 ms with a guaranteed precision of 100 ns for the recopy operation The time broadcast over the network uses a level of precision set by Time slot selected during configuration Therefore under general conditions of use at 1 Mbit s the difference between the time of the PC and the time broadcast will be less than 62 5 us if Time slot has been selected with this value Management of time producer election may be activated on initialisation and is used to select a time producer from amongst various devices that are capable of time production on the same network Channel 1 must be configured before the election mechanism will work Page 3 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330 3 Performance in terms of device exchange capacity has been defined as follows Maximum number of AELE 40 Maximum number of macrocycles 2 Maximum number of
28. lection 4 28 7 5 rtfdm generic time delete 4 28 8 UTETES reete E eA PE NP ER AUN 4 29 8 1 tfdm get image eoe ted aes bedhead Eu ER E 4 29 8 2 switch image pee ele de Rech eg 4 29 8 9 get version 2 Wee EAD ewe RE 4 30 8 4 xtfdm get count di da 4 30 CHAPTER 5 ERROR LIST CHAPTER 6 MISCELLANOUS Page 10 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Figures Figure 1 1 Generation of an FDM RTX application 1 1 Figure 3 1 Application Programming Interface 3 2 Figure 5 1 ErrorLookup Screen 5 2 ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 11 Tables Table 5 1 Errors types 5i dest gin haere AER SAEC EH E OE HRS 5 1 Page 12 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Chapter Introduction 1 FIP DEVICE MANAGER Release 2 software package represents the adaptation of FDM V4 on VenturCom s RTX real time extension of Windows NT This software package drives a PCI communication board CC139 WorldFIP communication board for 1 Mbit sec 140 WorldFIP com
29. meters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 47 AE LE DIM maximum number of variables which may make up this LE Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 2 2 rtfdm ae le delete BOOL rtfdm ae le delete RTSS FDM Ref int AE LE RANG Deletion destruction of an AE LE Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 47 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 8 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 2 3 rtfdm ae le start BOOL rtfdm ae le start RTSS FDM Ref int AE LE RANG Start up of an AE LE Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 47 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 2 4 rtfdm ae le stop BOOL rtfdm ae le stop RTSS FDM Ref int AE LE RANG Stopping an AE LE Parameters Ref reference of a RTX FDM instance AE LE RANG row of the AE LE Value 0 47 Return Values The function
30. munication board for 2 5 Mbits sec 141 WorldFIP communication board for 5 Mbits sec The FIP DEVICE MANAGER RTX Release 2 software package is delivered as a dynamic link library RTSS DLL The main files contained in the supply are fdmrtdll rtss this is the executable module fdmrtdll lib this is the import library file that must be linked with the user application The user process must be linked to the fdmrtdll lib import library The user process must be generated by a Visual C 6 0 compiler on RTX 4 3 1 or later COMPILER Library Manager COMPILER ENTORNO SU UR ERR Linker Figure 1 1 Generation of an FDM RTX application ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 1 1 Introduction Each user RTSS process can be associated with only one board that means if you have two boards you must develop tw
31. n rtfdm get version FDM RTX VERSION Ptr This function is used to get the version of RTX DLL FDM and FIPCODE Parameters Ptr pointer to a FDM RTX VERSION structure see below typedef struct FDM VERSION ELEMENT fdm Rtx FDM VERSION ELEMENT fdm V4 FDM VERSION ELEMENT fdm V6 FDM VERSION ELEMENT Return Values None 8 4 rtfdm get EOC count rtfdm get EOC count RTSS FDM Ref short Count Used to get Count Parameters Ref reference of a RTX FDM instance Count number of EOC inerrupts Return Values The function returns TRUE if it completes successfully or it returns FALSE otherwise If FALSE is returned then you should call GetlastError for more detailed information Page 4 30 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Chapter Error List 5 There are 4 types of errors SYSTEM 0 00000 0 000000 FDM 0 80040 Refer to 1 DLLFDM 0x8004exxx see below Table 5 1 Errors types ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 5 1 Error List The ErrorLookup utility shows you the details of the errors fe FDM ErrorLookup 80040502 Figure 5 1 ErrorLookup Screen Page 5 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Chapter Miscellanous To simplify the creation of an application certain memory management functions not documented but used
32. nd message RTSS FDM Ref int Rang FDM MSG TO SEND Data Buffer Used to request the transmission of a message Parameters Ref reference of a RTX FDM instance Rang messaging context number Data Buffer pointer to an MSG SEND type data structure Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 5 8 rtfdm msg ref buffer free msg data buffer free BOOL rtfdm msg data buffer free MSG R DESC Memory BOOL rtfdm msg ref buffer free RECEIVED Memory Used to free the memory zone which contains a received message or received message descriptor Parameters Memory pointer to the data structure to be released Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 22 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 6 MANAGING SM MPS NETWORK MANAGEMENT VARIABLES 6 1 rtfdm read report BOOL rtfdm read report RTSS FDM Ref int subscriber Used to read a subscriber report variable Refer to 1 Parameters Ref reference of a RTX FDM instance subscriber physical address of the subscriber whose report variable is to be read Return
33. o RTSS processes The FIP DEVICE MANAGER RTX Release 2 software package offers the user many functions that derive from the basic FDM V4 software package The details and the description of the different concepts of WorldFIP communications are described in 1 The main tasks implemented are the following ENSURING SYSTEM OPERATION This functionality is dedicated to the management of components required to build WorldFIP connection points i e FULLFIP2 medium redundancy circuits and private memories It consists of the following basic functions configure and manage or FULLFIP2 components out the self tests of the WorldFIP connection point s optional process events coming from the network s manage memory resources develop the various time outs required for other functions monitor the quality of the media prevent degradation prevent latent faults in double medium allow the subscriber to run as FIPIO manager MANAGING AE LE AND THE MPS VARIABLES This functionality enables the application layer services to be performed which enables the user to have access to the MPS variables through unconnected logic entities called AE LE It consists of the following basic functions create and delete an MPS AE LE start up and stop an MPS adda variable in an MPS AE LE reada variable consumed in an AE LE with or without dynamic refresh status write a variable pr
34. oduced in an AE LE with or without dynamic refresh status manage supposed pure sync variables Page 1 2 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Introduction MANAGING THE BUS ARBITRATOR S This functionality consists of the following basic functions load a macrocycle start or stop a macrocycle change a macrocycle 2 a macrocycle manage election of a bus arbitrator HANDLING SM MPS NETWORK MANAGEMENT VARIABLE This functionality enables network management services to be performed and provides the user with access to the SM MPS variables It consists of the following basic functions management of the list of equipment present variables management of the presence variable management of the identification variable management of the report variable management of the BA sync variable MANAGING WORLDFIP DATA LINK LAYER MESSAGES This functionality enables the data connection layer services to be performed These provide the user with access to messages at DLL WorldFIP level It consists of the following basic functions configure messaging transmit a message receive a message MANAGING TIME This functionality consists of the following basic functions managing election of time variable producer time variable read time variable write ALS 53330 FDM RELEASE 2 User Reference Manual Page 1 3 Introduction P
35. or more information Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 4 5 rtfdm ba start BOOL rtfdm ba start RTSS FDM Ref int RANG Used to start up a macrocycle Parameters Ref reference of a RTX FDM instance RANG row of the macrocycle O 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 16 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 4 6 rtfdm ba stop BOOL rtfdm ba stop RTSS FDM Ref Used to stop the current macrocycle Parameters Ref reference of a RTX FDM instance Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 4 7 rtfdm ba set parameters BOOL rtfdm ba set parameters RTSS FDM Ref enum BA SET MODE BA Mode unsigned char MAX Subscriber unsigned char MAX Priority Used to modify the parameters used in the time delay calculations of the BA function of the station Parameters Ref reference of a RTX FDM instance BA Mode Refer to 1 Subscriber Refer to 1 MAX Priority Refer to 1 Return Values The function return
36. s TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RELEASE 2 User Reference Manual Page 4 17 Detailed description of the functions 4 8 rtfdm ba set priority BOOL rtfdm ba set parameters RTSS FDM Ref unsigned char Priority Level Used to modify the parameters used in the time delay calculations of the BA function of the station Parameters Ref reference of a RTX FDM instance Priority Level desired level of priority 0 15 with 0 being the highest priority Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 18 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 5 MANAGING WorldFIP DATA LINK LAYER MESSAGES 5 1 rtfdm channel create BOOL rtfdm channel create RTSS FDM Ref CHANNEL PARAM param Used to create a periodic messaging channel Eight periodic messaging channels numbered from 1 to 8 can be created Parameters Ref reference of a RTX FDM instance Channel param pointer to FDM CHANNEL PARAM type Structure Refer to 1 Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed in
37. start up of this protocol Parameters Ref reference of a RTX FDM instance User param Refer to 1 for the details of this structure typedef struct enum BOOLEAN With Choice Producer enum BOOLEAN With MPS Var Produced enum BOOLEAN With MPS Var Consumed enum FDM MSG IMAGE Image unsigned long Refreshment 2 5 Mhz 400ms unsigned long Promptness 1 Mhz 1000ms const unsigned long Delta Time Location void User Signal Mode int Sens unsigned short Ticks Election 2 5 Mhz 2400ms 1 Mhz 1000ms unsigned short Channel Nr FDM GENERIC TIME DEFINITION Return Values Page 4 26 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 7 2 rtfdm generic time set priority BOOL rtfdm generic time set priority RTSS FDM Ref GT PRIORITY priority Used to modify the subscriber priority that is involved in the election process of the MPS time variable producer Parameters Ref reference of a RTX FDM instance priority value of the priority to set O 15 O is the highest priority Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information 7 3 rtfdm generic time set candidat
38. urns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information Page 4 24 FDM RTX RELEASE 2 User Reference Manual ALS 53330 Detailed description of the functions 6 5 rtfdm read ba synchronize BOOL rtfdm read ba synchronize RTSS FDM Ref Used to read the network BA sync variable Refer to 1 Parameters Ref reference of a RTX FDM instance Return Values The function returns TRUE if it is successfully completed or FALSE otherwise If FALSE is returned you should call GetlastError for more detailed information ALS 53330 FDM RTX RELEASE 2 User Reference Manual Page 4 25 Detailed description of the functions 7 MANAGING MPS TIME VARIABLE Refer to 1 to see the format of the MPS time variable 1 The RTSS timer CLOCK1 will be used by FDM after you have called the function rtfdm generic time initialize 2 When a station produces the MPS time variable CLOCK1 the value is sent 3 When a station consumes the MPS time variable CLOCKI the value is updated 4 The FdmRtxTime example copies the RTSS CLOCKI into the PC system clock 7 1 rtfdm generic time initialize BOOL rtfdm generic time initialize RTSS FDM Ref const GENERIC TIME DEFINITION User param Creation of the MPS time variable the messaging LSAPs required for the time producer redundancy management protocol to be operated and the possible
Download Pdf Manuals
Related Search