Home

FIP DEVICE MANAGER NT DRIVER Multi Boards - Release

1. Input parameters hdevice Rang Report HANDLE type reference on the open device number of the context to be deleted This function returns a report with the Boolean value TRUE FALSE ALS 53328 c en if the request has been processed correctly if it has not FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 41 Detailed description of the API 33 kfdm_ channel create Corresponds to the FDM function fdm_channel_create Prototype BOOL kfdm_channel_ create HANDLE hdevice FDM_ CHANNEL PARAM Data_Buffer Description Used to create a messaging channel Input parameters hdevice HANDLE type reference on the open device Data_Buffer pointer to an FODM CHANNEL PARAM type structure describing the context Refer to 1 for the detail of this structure Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 42 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 34 kfdm_ channel delete Corresponds to the FDM function fdm_channel_delete Prototype BOOL k fdm_channel delete HANDLE hdevice int Channel nr Description Used to delete a messaging channel Input parameters hdevice Channel nr Report HANDLE type reference on the open device n
2. Used to read the status of the BA function of the station Input parameters hdevice HANDLE type reference on the open device Resultats pointer toa K_ BA INF STATUS type structure described below and containing the status of the BA Typedef struct int Last_Error BA INF STATUS BA Infos K_BA_INF_STATUS Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 26 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 21 kfdm_ba_commute_macrocycle Corresponds to FDM function fdm_ba_commute macrocycle Prototype BOOL kfdm_ba_commute macrocycle HANDLE hdevice int BA_RANG Description Used to switch a macrocycle Input parameters hdevice BA_RANG Report HANDLE type reference on the open device row of the macrocycle 0 1 This function returns a report with the Boolean value TRUE FALSE ALS 53328 c en if the request has been processed correctly if it has not FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 27 Detailed description of the API 22 kfdm_ba_set_priority Corresponds to FDM function fdm_ba_set_priority Prototype BOOL kfdm_ba_set priority HANDLE hdevice unsigned char Priority Level Description Used to modify the priority of the loc
3. K_FDM_REPORT VAR InternalInfos refer to fdm mps var read far CallBackRoutine refer to fdm_mps var read far Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 32 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 27 kfdm read_identification Corresponds to FDM function fdm_read identification Prototype BOOL kfdm_read identification HANDLE hdevice int subscriber K_FDM_IDENT_VAR Data Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine f Description Used to read the subscriber identification variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device subscriber physical address of the subscriber whose identification variable is to be read Data_Buffer pointer to a K FDM_IDENT_VAR type data structure described below containing the value read Typedef struct int Last_Error FDM_IDENT_VAR Result K_FDM IDENT VAR InternalInfos refer to fdm_mps var read far CallBackRoutine refer to fdm_mps var read far Report This function returns a report with the Boolean value TRUE if the request has
4. LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine i Description Used to read a subscriber present variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device subscriber physical address of the subscriber whose presence variable is to be read Data_Buffer pointer to a K FDM PRESENCE _ VAR type data structure described below Typedef struct int Last_Error FDM PRESENCE VAR Result K_FDM_ PRESENCE VAR InternalInfos refer to fdm_mps var read far CallBackRoutine refer to fdm_mps var read far Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 30 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 25 kfdm_read_present_list Corresponds to FDM function fdm_read present list Prototype BOOL kfdm_read present list HANDLE hdevice K_FDM_PRESENT_LIST Data Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine Y Description Used to read a subscriber present list variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK docu
5. char Tag Name echar SM MPS Conform ehar SMS Contform echar xk PMDP Conform char Vendor Fi eld FDM_IDENTIFICATION Report This function returns a report with the boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 4 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Detailed description of the API 3 kfdm_valid_medium Corresponds to the FDM function fdm_valid_medium Prototype BOOL kfdm_ valid medium HANDLE hdevice enum Description _MEDIUM DEF medium Choice of mediums to be used Input parameters hdevice medium Report HANDLE type reference on the open device medium This function returns a report with the Boolean value TRUE FALSE ALS 53328 c en if the request has been processed correctly if it has not FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 5 Detailed description of the API 4 kfdm_stop_network Corresponds to the FDM function fdm_stop_network Prototype BOOL kfdm_stop_network HANDLE hdevice Description Used to stop a network Input parameters hdevice HANDLE type reference on the open device Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 6 FIP DEVICE MANAGER NT DRIVER Multi B
6. kfdm_mps_var_ write loc kfdm_mps_var_read_loc No such procedure exists No such procedure exists kfdm_mps_var_ write far kfdm_mps_var_read_far Not used Kfdm generic time initialize No time consumption possible Automatic writing by the driver kfdm_generic_time_set_priority kfdm_generic_time_set_candidate_for election Kfdm generic time delete kfdm_generic_time_get election status Page 3 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Use FIP DEVICE MANAGER V4 API FDM V4 for Windows NT 4 fdm_channel_create kfdm_channel_create fdm_channel_delete kfdm channel delete fdm change channel nr No such procedure exists fdm messaging fullduplex create kfdm_messaging fullduplex create fdm messaging to send create kfdm messaging to send create fdm messaging to rec create kfdm messaging to rec create fdm messaging delete kfdm_messaging delete fdm send message kfdm send message fdm msg ref buffer free Not used fdm msg data buffer_free Not used fdm msg rec _fifo empty Not used fdm msg send fifo empty Not used kfdm receive message fdm_ ba load _macrocycle_fipconfb kfdm ba load macrocycle fipconfb fdm_ ba load macrocycle_manual kfdm_ ba load _macrocycle manual fdm_ba_ delete macrocycle kfdm_ ba delete macrocycle fdm_ba_start kfdm_ba_start fdm_ba_external_resync No such procedure exists fdm_ba_commute_macrocycle kfdm_ba_commute_macrocycle fdm_ba_set_priority kfdm_ba_set_priori
7. Buffer Description Reads a variable Input parameters hdevice AE LE RANG VAR_RANG Lg Data_Buffer typedef struct HANDLE type reference on the open device row of the AE_LE Value 0 9 row of the variable in the AE_LE number of bytes of the variable pointer toa K_ VAR DATA type buffer described below which will contain the value of the variable read int Last_ Error FDM_MPS_READ_STATUS Status FDM_MPS VAR DATA Data K_VAR DATA Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 13 User Reference Manual Detailed description of the API 12 kfdm_ mps var_synchronize Corresponds to FDM function None Prototype BOOL kfdm_mps var synchronize HANDLE hdevice LPKFDM ABSTRACT SYNCHRO TYPE InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine Description Enables synchronisation of the application on receipt of the Sync variable declared in one of the AE_LE which have been started up This procedure must be MONO THREAD This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device InternalInfos Internal LPKFDM_ ABSTRACT SYNCHRO TYPE type stru
8. EDM MSG SEND SERVICE REPORT Sexrvice Report EDM PRIVATE DLT F Private Page 4 44 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual InternalInfos CallBackRoutine Detailed description of the API FDM_MSG_TO_SEND typedef struct _FDM MSG T DESC unsigned short Nr_ Of Bytes unsigned char x Per Datas street FDM MS6 T DESE Next_Bloek FDM_MSG_T DESC Internal structure The structure must not be modified during execution of the function Procedure called on receipt of the acknowledgement of the sending of a message or when time delay expires The prototype of the CallBack function is as follows VOID WINAPI CallBackRoutine DWORD dwErrorCode DWORD FdmReport LPOVERLAPPED lpOverlapped yg dwErrorCode is equal to 0 if the request has been processed correctly FdmReport not used lpOverlapped pointer to an OVERLAPPED type structure The OVERLAPPED structure contains information used in asynchronous input and output I O ALS 53328 c en typedef struct OVERLAPPED DWORD Internal DWORD InternalHigh DWORD Offset DWORD OffsetHigh HANDLE hEvent OVERLAPPED hEvent contains user information which may be defined during the send request FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 45 User Reference Manual Detailed description of the API Report This function returns a report with the Boolean value
9. Jar Consumed FALSE enum FPM MSGC IMAGE Ima ge 182 Ulong Refreshment 1 sec Uleng Promptraess eons Ueng Delta Tine Location _ interne void _ Usexr _Signal _Mede _ constintsens interne Ushort Tels Election IIa Ushe t Channel Ne if A FDM_GENERIC_TIME DEFINITION Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 52 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 41 kdfm_generic_time set_priority Corresponds to the FDM function fdm _ generic _ time set priority Prototype Bool kfdm generic time priority Handle hdevice GT PRIORITY priority Description Used to modify the subscriber priority that is involved in the election process of the time variable producer Input parameters hdevice HANDLE type reference on the open device priority value of the priority to set 0 15 0 is the greatest priority Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 53 User Reference Manual Detailed description of the API 42 kfdm_generic_time set_candidate_ for election Corresponds to the FDM function fdm_ generic time set candidate for electio
10. TRUE if the request has been processed correctly FALSE if it has not There is also a deferred report updated by FDM after sending the message You have to read the following field InternalInfos InternalHigh which is the FDM report of type struct enum FDM MSG SND CNF bits 16 23 enum FDM MSG USER ERROR bits 8 15 enum FIP MSG SND REP bits 0 7 pa This deferred report can be explored after successful completion of the sleepEx function or another equivalent procedure or in the CallBack routine Page 4 46 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 36 kfdm received _message Corresponds to FDM function None Prototype BOOL kfdm_ received message HANDLE hdevice int RANG K_FDM MSG RECEIVED Data_ Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine Description Used to signal the reception of a message This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device RANG row of the messaging context to be used Data Buffer pointer to a K FDM MSG RECEIVED type data structure described below typedef struct int Last_Error int Nbr_Of Purged Message FDM_MSG_RECEIVED ref buffer FDM_MSG_R_DESC
11. data buffer K_FDM_MSG_RECEIVED InternalInfos Internal structure The structure must not be modified during execution of the function CallBackRoutine Procedure called on receipt of the acknowledgement of the sending of the message or when the time delay expires ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 47 User Reference Manual Detailed description of the API The prototype ofthe callBack function is as follows VOID WINAPI CallBackRoutine DWORD dwErrorCode DWORD FdmReport LPOVERLAPPED lpOverlapped dwErrorCode is equal to 0 if the request has been processed correctly FdmReport not used lpOverlapped not used Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Usage example B kfdm_received_message hdevice l ff 10 291 amp MsgR amp gOverLapped IOCompletionRoutine E if B FALSE kufdm_format_message hLib Dw SleepEx 6000 time out interval in milliseconds TRUE return to execute I O completion routine if TRUE Here the message is either read or there is a time out In that case a new read request must be made Page 4 48 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en 37 kfdm_switch_image Corresponds to FDM function fdm_switch_image Prototype BOOL kfdm_switch image HANDLE K
12. description of the API 7 kfdm_ae le start Corresponds to the FDM function fdm ae le start Prototype BOOL kfdm_ae le start HANDLE hdevice int AE LE RANG Description Start up ofan AE_LE Input parameters hdevice AE LE RANG Report HANDLE type reference on the open device row of the AE_LE Value 0 9 This function returns a report with the Boolean value TRUE FALSE ALS 53328 c en if the request has been processed correctly if it has not FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 9 Detailed description of the API 8 kfdm ae le stop Corresponds to the FDM function fdm ae le stop Prototype BOOL kfdm_ae le stop HANDLE hdevice int AE LE RANG Description Stopping an AE_LE Input parameters hdevice HANDLE type reference on the open device AE LE RANG row of the AE_LE Value 0 9 Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 10 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Detailed description of the API 9 kfdm ae le delete Corresponds to the FDM function fdm ae le delete Prototype BOOL kfdm_ae le delete HANDLE hdevice int AE LE RANG Description Deletion destruction ofan AE_LE Input parameters hdevice AE LE RANG Rep
13. of parameters start up stop Chapter 3 Use Chapter 4 Detailed description of the API Description of the programming interface on the basis of the one described in the FIP DEVICE MANAGER Version 4 user manual and additional information relating to a Windows environment Chapter 5 Examples of usage The following conventions are used in this manual C code sequences are indicated in courrier font Constants which exist in h files are indicated in BOLD type ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 5 User Reference Manual Preface 3 RELATED PUBLICATIONS The documents quoted in this manual are specified in the text in square brackets and listed in this paragraph e 1 FIP DEVICE MANAGER Software Version 4 User Reference Manual ALS 50278 e 2 CC138 CC139 CC140 CC141 Board User Manual ALS 53316 For more information on WorldFIP and hardware components e 3 FIP Network General Introduction ALS 50249 e 4 FULLFIP2 User Reference Manual ALS 50262 4 WE WELCOME 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 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Reader s comments FIP DEVICE MANAGER NT DRIVER Multi Boards ALS 53328 c en Release 2 User Reference Manual Your ma
14. read Typedef struct int Last_Error FDM_SYNCHRO_BA VAR Result K_FDM_SYNCHRO_BA VAR InternalInfos refer to fdm_mps var read far CallBackRoutine refer to fdm_mps var read far Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 35 User Reference Manual Detailed description of the API 29 kfdm_messaging fullduplex_create Corresponds to FDM function fdm_messaging fullduplex create Prototype BOOL kfdm_messaging fullduplex_create HANDLE hdevice int Rang FDM MESSAGING FULLDUPLEX Data_Buffer yee Description Used to create a new FULLDUPLEX messaging system context Input parameters hdevice Rang Data_Buffer HANDLE type reference on the open device context number for the driver pointer to an FODM MESSAGING FULLDUPLEX type data structure describing the context Refer to 1 for the detail of this structure The scored out fields of the structure below are not to be initialised typedef struct enum _FDM MSG IMAGE Position struct sending struct receiving yoid User Msg Ack FDM MESSAGING REE FDM MSC FO SEND gt yoigq Yser Qid optionaluser info voids Usex Ctxt epticonal user info unsigned short Channel_Nr void User Msg_Ree_Droe LEDM_ MESSAGING REF
15. the API 39 kfdm ae le get state Corresponds to the FDM function fdm_ae le get _state Prototype BOOL kfdm ae le get_state HANDLE hdevice int AE LE Rang K_FDM_AE LE STATE Value ae Description Used to identify the operating state of an AE_LE Input parameters hdevice HANDLE type reference on the open device AE_LE Rang row of the AE_LE Value pointer toa K FDM_AE LE STATE type data structure described below typedef struct int Last_Error enum FDM AE LE STATE AE LE State K_FDM_AE LE STATE Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 51 User Reference Manual Detailed description of the API 40 kfdm_generic_time_initialize Corresponds to the FDM function fdm generic time initialize Prototype BOOL kfdm_ generic time initialize HANDLE hdevice const FDM_GENERIC_ TIME DEFINITION User_ param i Description Initialisation of the time management function Input parameters hdevice HANDLE type reference on the open device User param pointer to an FDM GENERIC TIME DEFINITION structure defined below The scored out fields are not to be initialised typedef struct enum FDM BOOLEAN With_Choice Producer enum FDM BOOLEAN With_MPS Var Produced enum DM BOOLEAN With MPS
16. the CD ROM running with two subscribers on the same PC production and consumption of MPS variables production and consumption of messages e synchronisation of the application with a synchro identifier e the subscribers will be bus arbitrators An executable file must be created console application type using the files on the directory ALS 53328 b en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 5 1 User Reference Manual Examples of Usage Page 5 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 b en User Reference Manual Glossary AELE Set of globally managed communications variables API Application Programming Interface FDM FIP DEVICE MANAGER software library FIELDRIVE ASIC transceiver for copper physical layer FIELDTR Isolating transformer FIELDUAL ASIC FULLFIP2 peripheral device for managing medium redundancy FULLFIP2 ASIC WorldFIP communications coprocessor THREAD Windows NT environment task VCOM Communication variable as per the WorldFIP protocol ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Gloss 1 User Reference Manual Glossary Gloss 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual
17. 2 x contains the driver for a multi PCI boards ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 1 User Reference Manual Installation 2 INSTALLATION The software may only be installed on a PC with the hardware configuration necessary to accomodate NT4 with a PCI V2 1 or later slot with a CC138 CC139 CC140 or CC 141 board and a CD ROM The installer must have administrator access rights to install this driver Installation procedure O insert the CD ROM into the CD leader O change the directory to Programs Fdm_nt_knl_m_pciR2 x e double click on the Setup icon e reboot the computer or the driver will not appear in the list of peripheral devices After booting the PC you can verify in Start gt Programs gt ALSTOM Technology FIPWARE gt FDM NT MULTI that there are the following 6 sub items under the FIP Drivers item e Researcher of FIP Board Tool used for the association of the NT driver with a PCI communication board Present List Tool used to display the present subscribers e SMMPS Tool used to display the SMMPS variables of a subscriber e Error Lookup Tool that shows you the details of the errors e FIP Device Manager Doc basic FDM document e NT Driver Doc this document Page 2 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Installation 3 BIND A DRIVER TO A BOARD The FipBoardConf exe tool has to be used for the associatio
18. 328 c en User Reference Manual Detailed description of the API The prototype ofthe callBack function is as follows VOID WINAPI CallBackRoutine DWORD dwErrorCode DWORD FdmReport LPOVERLAPPED lpOverlapped o dwErrorCode is equal to 0 if the request has been processed correctly FdmReport 0 if request is processed by OK FDM 0 if NOK lpOverlapped pointer to an OVERLAPPED type structure The OVERLAPPED structure contains information used in asynchronous input and output I O typedef struct OVERLAPPED o DWORD Internal DWORD InternalHigh DWORD Offset DWORD OffsetHigh HANDLE hEvent OVERLAPPED The field hEvent can be used as a user tag see the example Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 17 User Reference Manual Detailed description of the API 14 kfdm_ mps var_write_far Corresponds to FDM function fdm mps var write universal Prototype BOOL kfdm_ mps var write far HANDLE hdevice int AE LE RANG int VAR _RANG int DataLength USER_BUFFER_TO_READ DataBuffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine Description Enables remote writing of an MPS variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or anoth
19. A E 2 9 6 2 Configuratiomof the VIC ei nba 2 10 6 2 1 Subscriber Configuration Service tab ccecccscesssesscesecseeeecesecesecseesecescecseeecesecaaecseceeeeaecaaecaeeeeeeaeeaeeneees 2 11 6 2 2 IBA sService taberi eie co tandandende covet de cahcen Ae bash dh poesias Ea leida 2 13 6 3 Start Stop of th iservicesix 2 004 Keke a enh Gee ees ha ee ee 2 14 6 3 1 ORNATO 2 15 6 3 2 DP A A A id iii 2 15 CHAPTER 3 USE 1 PROGRAMMING INTERFACE ccccccssesssesscesscesecesecesecaecaaecaeecaeeeseseaeseaeseeeeessecnseseaeceaecaeenseceecaeeenes 3 1 2s TIMEMANAGEMEN TO ethos chee ee ee 3 4 3 PERFORMANCE ui a oi 3 5 4 ERROR PROCESSING otui ao A tal ee ee 3 6 4 1 GetLastEtror funcio 3 6 4 2 Using Windows NT 4 Event Loi cia 3 7 4 3 Using the ErrorLookup Utility o ooonoonnnnnnnnnnnnnonnonnconncnnconnconncnn nono nono nonn A 3 8 4 4 Display of the last error in a Modal dialog DOX oooooonccnncnnocnnonooncconccnnono nono nono ronnonnnrono nono ron nc nrnn nn 3 9 4 4 1 kufdm format Message mairena Er EAEE TENEN iaa os Ea E S a E 3 9 4 4 2 kufdm load lbrary e ec eececsesescesecsceescesecsecaceeseesecsaecneeeseeseceaecseeesessecsaeceseeseceaecaseeseeseceaecaeeeseeeseaeente 3 10 CHAPTER 4 DETAILED DESCRIPTION OF THE API K kfdmucreate contextes csfo coincide leerte deter seats Dafa lo aaa a tl en log 4 1 NAS AA 4 2 32 Kid Valid a od 4 5 4 ukfdI st p Et WO ls 4 6 5 Kfdm ae le creatina aiii 4 7 A AA de lecuce
20. Comparison table FIP DEVICE MANAGER V4 API FDM V4 for Windows NT 4 fdm initialize fdm_get_version fdm_ticks_ counter fdm change test medium ticks fdm_initialize_ network fdm_stop_network fdm_valid_ medium fdm_online_test fdm_process_its fip fdm_process_it eoc fdm_process_it_irq Carried out upon installation of the driver Information given in the configuration splash screen Run periodically by the driver every 500 ms No such procedure kfdm initialize network kfdm stop network kfdm valid medium No such procedure Management of IRO and EOC is ensured by the driver SSS create contexte fdm_ae le create fdm_ae le delete fdm_ae le start fdm_ae le stop fdm ae le get state fdm_mps var_create fdm_ mps var change_id fdm mps var change period fdm_ mps var change Rqa fdm_ mps var _change_MSGa fdm mps var change priority fdm mps var change prod cons fdm_ mps var_write_loc fdm_ mps var_read loc fdm_ mps var time write_loc fdm_ mps var time read loc fdm_ mps var write universal fdm_ mps var read universal fdm_ mps fifo empty fdm_generic_time_initialize fdm_generic_time_read_loc fdm_generic_time_write_loc fdm_generic_time_set_priority fdm generic time set candidate for election fdm generic time delete kfdm ae le create kfdm_ ae le delete kfdm_ ae le start kfdm_ae le stop kfdm ae le get_state kfdm_mps_var_ create On line modification of parameters cannot be used
21. D_MSG 10XX is created dynamically XX is the number of a present subscriber detected on the network Send Time In the case of an Auto BA if you check this box then the identifier ID_ DAT 9802 is added to the above list Imported BA If you select this radio button then the BA is imported from an external tool In this case you have to enter the name of the binary file File name In the case of an Imported BA enter the name of the binary file 6 3 Start Stop of the services Selection path Start gt Settings gt Control Panel gt Services Service Etat D marrage FDMNT_SERVICE_BA Manuel FDMNT_SERYICE_SUBCFG Manuel D marrer Fournisseur de support de s curit NT LM Manuel Gestionnaire d alerte de Network Associates D marr Automatique a Arete Gestionnaire de t ches Network Associates D mar Automatique P a 2 Suspende LexBce Server D mar Automatique Messagerie l l D marr Automatique Reprendre Network Associates McShield D marr Automatique y D marrage Profils mat riels Param tres de d marrage o Aide FDMNT_SERVICE_BA service that manages a bus arbitrator FDMNT_SERVICE_SUBCFG service that initialises the subscriber Page 2 14 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Installation 6 3 1 Start Select the service and then click the Start button 6 3 2 Stop Select the service and then click the Stop butto
22. EDM MSG RECETVED 5 void Usex Qid _ __ epticonatousexr info voids Usex Ctxt _ eptionatuusexr info int Number _Of Msg Desc int Number Of Msg Block unsigned long Local DLL Address unsigned long Remote DLL Address FDM_MESSAGING FULLDUPLEX Page 4 36 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API The message exchange type at the Data Link Level is acknowledged or not acknowledged according to the contents of the address see Chapter 2 Subsection 1 6 of 1 Two supplementary bits are used They are bits 24 and 25 According to their values the interpretation is the following e 0 standard see Chapter 2 Subsection 1 6 of 1 e 2 not acknowledged e 3 acknowledged Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 37 User Reference Manual Detailed description of the API 30 kfdm_messaging to send create Corresponds to FDM function fdm_messaging_to send create Prototype BOOL kfdm_messaging_to send create HANDLE hdevice int Rang FDM MESSAGING TO SEND pe Data_Buffer 1 Description Used to create a messaging context for sending Input parameters hdevice HANDLE type reference on the open device Rang c
23. FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en First issue 02 2000 This edition 01 2001 Meaning of terms that may be used in this document Notice to readers 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 Caution notices are used where there is a risk of damage to equipment for example Note 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 usefulne
24. LS 53328 c en User Reference Manual Installation 5 START UP STOP The driver is started up and stopped independently of the user application by using the Windows NT 4 peripheral device management utility Directory path Start gt Settings gt Control Panel gt Devices 5 1 Start up To start up select the FipPCT driver and click on Start P riph rique Etat D marrage FipPCI D mar Manuel L wa FipScanBoard Manuel flashpnt D sactiv D marer Floppy D mar 5 yst me y Arter Ftdisk D sactiv Inport D sactiv D marrage Interface NetBIOS D mar Manuel intl xsr D mar Amorc Profils mat riels Jazzg300 D sactiv Jazzg364 D sactiv x Aide The process for starting up the driver includes a phase where the consistency of the values entered for the different parameters is verified This may produce an error message Two types of start up are available in the menu for starting up peripheral devices and these may be selected in the window which appears by clicking on Start ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 7 User Reference Manual Installation The window below then appears The Manual start up option requires that the driver be relaunched following the procedure listed above each time a Windows NT session is opened e g when the PC is started up while the Automatic start up option allows the system to be re boote
25. UE if Dw WAIT _IO COMPLETION gt i o completion routine OK else gt i o completion routine NOK ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 15 User Reference Manual Detailed description of the API 13 kfdm_ mps var_read_far Corresponds to FDM function fdm mps var read universal Prototype BOOL kfdm_ mps var read far HANDLE hdevice int AE LE RANG int VAR_RANG K FDM MPS VAR DATA FAR Data_ Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine Description Enables remote reading of an MPS variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device AE _ LE RANG row of the AE_LE Value 0 9 VAR_RANG row of the variable in the AE_LE Data_Buffer pointer toa K FDM_MPS_VAR_ DATA FAR type data structure described below typedef struct int Last_Error FDM MPS READ STATUS Status FDM_MPS_VAR_ DATA Data K_FDM MPS VAR DATA FAR InternalInfos Internal structure The structure must not be modified during the execution of the function CallBackRoutine Procedure called on receipt of the variable or when time delay expires Page 4 16 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53
26. _FDM_IMAGE NR Description hdevice Value Detailed description of the API Used to request the switching of the image the AE_LEs are operating with Input parameters hdevice HANDLE type reference on the open device Value pointer to a K FDM_IMAGE NR type data structure described below typedef struct int Last_Error enum IMAGE NR Image_Value K_FDM_ IMAGE NR Image_Value Report This function returns a report with the Boolean value IMAGE_1 or IMAGE 2 TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 49 User Reference Manual Detailed description of the API 38 kfdm_get_image Corresponds to FDM function fdm_get_image Prototype BOOL kfdm_get_image HANDLE hdevice K_FDM_ IMAGE NR Value ey Description Used to find out which image the AE_LEs are operating with Input parameters hdevice HANDLE type reference on the open device Value pointer to a K FDM_IMAGE NR type data structure described below typedef struct int Last_Error enum IMAGE NR Image Value K_FDM_IMAGE NR Image Value IMAGE 1 or IMAGE 2 Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 50 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of
27. aecaeecaeeeaeeeseenseees 2 11 Figure 2 3 BA Service Mii aaa 2 13 ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 11 User Reference Manual Tables Table 3 1 Comparison FDM V4 vs FDM V4 for Windows NT4 cccessessccssecsseceeeseeeeeeeeeseeesseenseeneesaeenaes 3 3 Page 12 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Chapter Introduction 1 1 DESCRIPTION OF THE SOFTWARE This software package which is part of the FIP DEVICE MANAGER Version 4 functions library contains a Windows NT 4 driver for WorldFIP boards CC138 CC139 CC140 and CC141 on PCI bus These boards are PCI boards fitted with the chipset comprising FULLFIP2 FIELDUAL FIELDRIVE FIELDTR etc This software package can drive more than one board This solution was designed to fulfil a need which is two fold O a need for the simplified implementation of the FIP DEVICE MANAGER Version 4 library under a Windows NT4 environment requiring only the use of standard driver handling functions installation definition of parameters start up stop O a need for a level of performance which is very close to that which would be obtained with an equivalent processor in the absence of any operating system The software has certain limitations such as the quantity of communication objects 150 VCOMs 48 AELEs 2 macrocycles 40 messaging contexts and 9 messaging system queues as well as certain
28. al BA function Input parameters hdevice HANDLE type reference on the open devices Priority Level desired level of priority 0 15 with 0 being the maximum priority Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 28 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 23 kfdm_ ba set _parameters Corresponds to FDM function fdm_ba_set_parameters Prototype BOOL kfdm_ba_set_parameters HANDLE hdevice enum _BA SET MODE BA Mode unsigned char MAX Subscriber unsigned char MAX Priority Description Used to modify the parameters used in the time delay calculations of the BA function of the station Input parameters hdevice HANDLE type reference on the open device BA Mode refer to 1 FDM V4 User Manual MAX Subscriber idem MAX Priority idem Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 29 User Reference Manual Detailed description of the API 24 kfdm_read_presence Corresponds to FDM function fdm_read presence Prototype BOOL kfdm_read presence HANDLE hdevice int subscriber K_FDM_PRESENCE_VAR Data Buffer LPOVERLAPPED InternalInfos
29. been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 33 User Reference Manual Detailed description of the API The station identification variable in comparison with the one used in FDM Version 4 is Vendor_Name Field entered during configuration Model_ Name Field entered during configuration Revision Field entered during configuration Tag Name Field entered during configuration SM_MPS_ Conform Field entered during configuration SMS_ Conform Field entered during configuration PMDP Conform Field entered during configuration Vendor Field Field entered during configuration Page 4 34 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 28 kfdm_read_ba_synchronize Corresponds to FDM function fdm_read ba _synchronizel Prototype BOOL kfdm_read ba _synchronize HANDLE hdevice K_FDM_SYNCHRO_BA VAR Data Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine 1 Description Used to read the network BA sync variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device Data Buffer pointer to a K FDM SYNCHRO BA VAR type data structure described below containing the value
30. cture The structure must not be modified during execution of the function CallBackRoutine Procedure called on receipt of the sync The prototype of the CallBackRoutine function is as follows VOID WINAPI CallBackRoutine DWORD dwErrorCode DWORD Compte _rendu LPOVERLAPPED lpOverlapped o dwErrorCode Will be equal to 0 if the request has been processed correctly by NT Compte _rendu 2 If Sync correct 3 If Time out or invalid 4 Syncho lost LpOverlapped pointer on the InternalInfos structure provided during the call InternalInfos gOverlapped IntervalHigh 2 gt received sync event 3 gt non received sync event the time _out is 5 seconds Page 4 14 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Example of usage VOID WINAPI IOCompletionRoutinel DWORD dwErrorCode completion code DWORD Compte_rendu LPOVERLAPPED lpOverlapped pointer to structure with I O information switch compte rendu case 2 PulseEvent Hevent OK break case 3 time out case 4 synchronisation loss break PIIT ELITE IAE main for KFDM ABSTRACT SYNCHRO TYPE Tmp DWORD Dw kfdm_mps var synchronize hdevice amp Tmp IOCompletionRoutine Dw SleepEx 6000 THR
31. d without intervention 5 2 Stop To stop a device select the FipPCI driver which is in Started status and click on Stop P riph riques D marr D marr D marr D marr D sactiv D sactiv D sactiv D sactiv D sactiv Manuel Manuel Manuel D sactiv Syst me Page 2 8 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Installation 6 SERVICES Two services are available e A service that configures the parameters of a subscriber associated with a PCI board O A service that launches a Bus Arbitrator on a subscriber associated with a PCI board Before installing the services you have to start the device driver see Chapter 4 1 and then associate a board with a driver see Section 3 6 1 Installation of the services To install the FDM NT services e change the directory to Programs Fdm_nt_knl_m_pciR2 x Services e double click the SETUP EXE program ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 9 User Reference Manual Installation 6 2 Configuration of the services You can lauch this tool e by double clicking FDM_NT_CONFIG EXE O using the following path Start gt Programs gt ALSTOM Technology FIPWARE gt FDM NT MULTI gt Services gt FDM_NT_CONFIG Choose a local FDM NT context Context A combo box displays the created contexts see Section 3 Select a created con
32. e gt E 2 N 4 N 4 N 0 jf 2 YES AS Ushert Types MESSAGE RECEPTION AUTHORIZED TWO BUS MODE TWO_IMAGE MODE enum _FULLFIP_Mode List Mode Ushort TSlot Ushert NB OF USER MPS VARIABLE Ushert BAH Uleng PULLFTP RAM Dim Ushore NB OF DIFFERENT ID PROG BA Ushert Nof Repeat Ushert Ne Of Tx Buffer gl void Usex_Present_hbist Preg struct FDM_REPF FPM PRESENT LIST Ushert _ Usexr tdenti fication Preg struct FDM _REF __FDM IDENT VAR Ushert_ Usexr Report Preg struct FDM_REF __FDM REPORT VAR Ushert_ User Presence Prog struct FPM _REF __FDM PRESENCE VAR void Usexr_Synchro_BA Prog struct _FDM_REF __EDM SYNCHRO BA VAR Ushort tMedium_Tieks Ushoxrt Fime Oue Ficks Ushert Fime Ouet Msg Fiecks Ushert Online fFests Fieks Ushert Defauit Medium_threskeld HE WITH BA YES amp amp FPDM_WITH PIPTO FDM_WITH FIPIO NO Page 4 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Detailed description of the API Ushert Segment Paraners Ticks endi struct Ushort TIMER CNT REGISTER ae Ushort MODE REGISTER Ir User_responsability void User Signal Mps Aper struct FPM REF gt void _ User Signal Smmps struct FPM REF gt void _ User Signal Send Msg struct FDM REF gt void Us
33. e int Device Description Used to create a logical link between the user world and the kernel world of the FDM driver Input parameters Device logical number 1 to 20 that identifies an association of driver to a board and to a driver Enter the same value that you entered when you used the configuration tool Chapter 2 Subsection 4 Configuration Report HANDLE type reference on the open device If INVALID HANDLE_VALUE is displayed opening has not been performed correctly If it is not produced the reference of the open device appears ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 1 User Reference Manual Detailed description of the API 2 kfdm_initialize_network Corresponds to the FDM function fdm_initialize network Prototype BOOL kfdm_initialize network HANDLE hdevice const FDM CONFIGURATION SOFT U soft FDM CONFIGURATION HARD U hard const FDM_IDENTIFICATION U ident Description Used to initialise the network variables Input parameters hdevice HANDLE type reference on the open device U _ soft pointer to FDM CONFIGURATION SOFT type data structure described below The scored out fields are not to be initialised typedef struct 150 0x2000 0x20000 0x100 ff A 4 9 interne interne E interne a interne E intern
34. eccesseesseesceesceesceecceecsecssecseecseecneeeneeeeceeeeeeensesesecaeeaeceaecseeceeeseeeseeneeees 4 33 28 kfdm_read_ba_symchromize cccececescesseesceesceesceeecesecesecesecaecsaeeeseeseeseeeeeeeneeeaecaecaecaecaeeceeenseeneeneeeas 4 35 29 kfdm_messaging fullduplex_create neniani a aE E E E T t 4 36 30 Kfdm messaging to send create viii a Adee ee wits Bes 4 38 31 kfdm messaging to tecate 4 40 32 kfdmi messaging delta dai 4 41 A ORO 4 42 34 AA cence te hse carted de E EE ieceumeeSags 4 43 39 2 kfdmissend Message rodea 4 44 36 kfdm received MEA A daa 4 47 37 ktdm switch IM A A ae ee ee 4 49 38 kfdm get image isje e ak a EE ceed EEEE RE E E ceeds E EE es T E E eee 4 50 39 Ki dm ae le redada 4 51 INS A 4 52 41 o A 4 53 42 kfdm generic time set candidate for election cc cccceccccessessceesceeeceseceseceeecseecaeecseeeaeenseseeesereeeeeeseees 4 54 43 kfdm generic time get election status cccecccssessecsecsseeseeeseeesceeeceecesecsecsecsaecsaecseecaeeeaeeeseeeeteseees 4 55 44 kfdm generic time deletis ds ane eee 4 56 45 kufdm get subscriber UMD E EEE E EER n R 4 57 CHAPTER 5 EXAMPLES OF USAGE GLOSSARY Page 10 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Figure 2 1 FIP Driver NT Configurator ii EERE E ai EE 2 4 Figure 2 2 Subscriber Configuration Service tab cccecccecccsseesseeseeeseeesceeeeesecnseensecsaeceaecaaecaees
35. ent 8 bytes mode which is the default option proposed by the Visual C V6 0 compiler or later ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 3 5 User Reference Manual 4 ERROR PROCESSING There are four methods for managing errors O getting the last error by GetLastError function O using the NT4 Event Log O using the ErrorLookup utility O using a Modal dialog box to display the last error 4 1 GetLastError function This function returns the value of the last error code to the calling Thread The FDM driver however updates the error code when a fault occurs To facilitate debugging upon each call to the SIGNAL WARNING function which is activated when an error is detected by the FDM the driver updates the error code accessible by the application and activates the PC buzzer for 5 seconds Function DWORD GetLastError VOID Input parameters None Report This function returns the error code dwErrCode which is updated during the call for help to the VOID SetLastError DWORD dwErrCode function Error codes are structured in the following way e when the most significant bit b31 is set to 1 the low order bits represent the errors usually fed back by FDM as specified by enum CODE_ERROR in its reference manual 1 e OxD refers to errors detected by the driver access interface e OxE refers to errors detected by the driver Page 3 6 FIP DEVICE MANAGER NT DRIVER Mult
36. er equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device AE LE RANG row of the AE_LE Value 0 9 VAR_RANG row of the variable in the AE_LE DataLength number of bytes to be transferred DataBuffer pointer to a USER BUFFER TO READ type data structure of the data to be written Refer to 1 for the description of this structure InternalInfos internal structure The structure must not be modified during the execution of the function CallBackRoutine Procedure called on receipt of the variable or when time delay expires The prototype of the cal1Back function is the same as that for the kfdm mps var read far function Page 4 18 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 19 User Reference Manual Detailed description of the API 15 kfdm ba load macrocycle manual Corresponds to FDM function fdm_ba_load_macrocycle_ manual Prototype BOOL kfdm_ba_load_macrocycle manual HANDLE hdevice int BA RANG int Nb_of_Liste int Nb_of Instruction unsigned short Label const PTR_LISTS const PTR INSTRUCTIONS The macro below enabl
37. es a simplified call to be made BOOL Bus _Arbitrator_ CREATE hdevice BA RANG Label Listes Programme Description Used to create and load a macrocycle Input parameters hdevice HANDLE type reference on the open device BA_ RANG row of the macrocycle 0 1 Nb_of_Liste refer to FDM V4 User Manual 1 Nb_of Instruction Label i PTR_LISTS 3 PTR_INSTRUCTIONS E Page 4 20 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Detailed description of the API Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Example of usage const LIST ELEMENT LO 0xE100 ID DAT bi const LIST ELEMENT L1 Ox0001 ID DAT 0x0002 ID DAT 0x0002 ID DAT 0x0003 ID DAT 0x0016 ID DAT 0x0017 ID DAT 0x0018 ID DAT 0x0019 ID DAT 0x0021 ID DAT 0x0022 ID DAT 0x0023 ID DAT 0x0024 ID DAT 0x0025 ID DAT ry PTR_LISTS Listes BA Ushort sizeof LO LIST_ELEMENT LO Ushort sizeof L1 LIST ELEMENT L1 rs define millisecondes 1000 const PTR_INSTRUCTIONS Prg BA SEND LIST ya Ob BA WAIT 5000 SEND LIST pe ke ca TEST P 4 Og TEST P 0 SEND _APER 200 millisecondes SEND_MSG 200 millisecondes BA WAIT 200 millisecondes NEXT MACRO 0 E B Bus Arbitrator CREATE hdev
38. es signal hee Msg struct FDM REF fi void User Ctxt ii FDM_CONFIGURATION SOFT interne interne interne interne interne U_hard pointer to FDM_CONFIGURATION_HARD type data structure described below The scored out fields are not to be initialised typedef struct _FDM CONFIGURATION HARD Uchar K_PHYADR char MySegment Uchar Reserved i HHE FDM EPH CHAMP IFO YES Port Type LOC FIPA Port Type LOC FIPDRIVE HH fi telse Uechar volatile FOC FIPS Uchar volatile LOC FIPDRIVE 4 Hendi Ushort volatile FREE ACCES ADDRESS ii void User Reset Compeonent iy streuet EDM CONFIGURATION HARD gt void User _Signal Fatal Error if struct FDM REF Ref _FDM ERROR CODE void User Signal Warning struct FDM REF Ref FDM_ERROR_CODE gt MEMORY RN Memory Management_Ref if styvuct FDM REF Pty Autotests if FDM_CONFIGURATION HARD interne interne interne interne interne interne interne interne interne interne U_ident pointer to FDM_CONFIGURATION_HARD type data structure described below The scored out fields are not to be initialised ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 3 Detailed description of the API typedef struct char Vendor Name char Model Name char Revision
39. esponds to FDM function fdm_ messaging_to_rec _create Prototype BOOL kfdm _messaging_to rec create HANDLE hdevice int Rang FDM_MESSAGING_TO_REC Data Buffer Description Used to create a messaging context for receiving Input parameters hdevice HANDLE type reference on the open device Rang context number for the driver Data_Buffer pointer to an FODM MESSAGING TO_ REC type data structure describing the context Refer to 1 for details of this structure The scored out fields of the structure below are not to be initialised typedef struct enum _FDM MSG IMAGE Position i struct void User Msg Ree _Pree PDM_MESSAGING REF _PDM MSG RECEIVED voids Yser Qi optional user info gt voids Usexr Ctxt _ eptionatousexr info int Number _Of Msg Desc int Number Of Msg Block receiving unsigned long Local DLL Address unsigned long Remote DLL Address FDM_MESSAGING TO REC Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 40 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 32 kfdm messaging _delete Corresponds to FDM function fdm_messaging delete Prototype BOOL kfdm_messaging delete HANDLE hdevice int Rang Description Used to delete a messaging context
40. esponds to the FDM function fdm_generic time delete Prototype BOOL kfdm_ generic time delete HANDLE hdevice Description Stops the time management function Input parameters hdevice HANDLE type reference on the open device Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 56 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Detailed description of the API 45 kufdm get subscriber_ number Corresponds to the FDM function None Prototype BOOL kufdm_get_subscriber number HANDLE hdevice USHORT subscriber Description Utility used to read the number of the station subscriber The value read is the one contained in the Registry which is independent of the value registered by the driver Input parameters hdevice HANDLE type reference on the open device subscriber address where the subscriber number will be filled Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 57 User Reference Manual Detailed description of the API Page 4 38 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Chapter Examples of Usage b One example is given on
41. i Boards Release 2 ALS 53328 c en User Reference Manual Use 4 2 Using Windows NT 4 Event Log The event log is used to access a chronological event report It is activated by the command Start gt Programs gt Administrative Tools Common gt Event Viewer Event Viewer System Log on ABESSE 28 11 97 15 01 40 FipP I None 28 11 97 15 01 39 FIpPCl 28 11 97 15 01 38 FipPCl Detailed information on a particular event is obtained by double clicking on it Event Detail The code contained in the last word is the FDM warning code 0x502 in the example above Refer to 1 for details of all the possible codes ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 3 7 User Reference Manual 4 3 Using the ErrorLookup utility This tool can be launched by e double clicking ErrorLookup exe O using the following path Start Programs gt ALSTOM Technology FIPWARE DFDM NT MULTI Error Lookup EA FDM ErrorLookup x Value 80040502 Error Message etat de AELE interdit cette commande Enter the error value returned by the driver The description of the error will be displayed Page 3 8 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Use 4 4 Display of the last error in a Modal dialog box To display the last error in a Modal dialog box you have to use the following functions e kufdm_format_message l e kufdm load
42. ice 0 row 0 1 0x300 Label Listes_BA Name of the table which defines the lists Prg_BA Name of the table which defines the macrocycle E ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 21 User Reference Manual Detailed description of the API 16 kfdm_ba_load_macrocycle_fipconfb Corresponds to FDM function fdm_ba_load macrocycle fipconfb Prototype BOOL kfdm_ba_load_macrocycle fipconfb HANDLE hdevice int BA RANG const unsigned short ba_fipconfb Jo Description Used to create and load a macrocycle Input parameters hdevice HANDLE type reference on the open device BA_ RANG row of the macrocycle 0 1 ba_fipconfb pointer to a table generated in the FIPCONFB tool format Refer to 1 Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 22 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual 17 kfdm_ba_delete_macrocycle Corresponds to FDM function fdm _ba_delete macrocycle Prototype BOOL kfdm_ba_delete macrocycle HANDLE hdevice int BA RANG Description Used to delete a macrocycle Input parameters hdevice HANDLE type reference on the open device BA_RANG row of the macrocycle 0 1 Report This function returns a report with the Boolean value Detailed description of the API TRUE if the
43. in job is a System designer a Programmer LJ Distributor LJ Maintenance a System integrator a Operator LJ Installer QU Other specify below If you would like a personal reply please fill in your name and address below 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 All comments will be considered by qualified personnel REMARKS ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 7 User Reference Manual Reader s comments Page 8 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Contents CHAPTER 1 INTRODUCTION ls DESCRIPTION OF THE SOFT WARE vei ccscsscstssecsceussseseusscecnconeseesstetgszevieeseusheeoesevders postevenstontertpesdedennsante 1 1 2 DEVICE DRIVER ARCHITECTURE e eeraa eE rerea EATE ENE OE EEEE EEES ENEA E EREN EnA EEEa Enei i 1 1 CHAPTER 2 INSTALLATION A SURREY zene e a Areca eae e E SS 2 1 2 INSTALLATION cia A A A dl awaits 2 2 3 BIND A DRIVER TO A BOARD oocooococcconcnnncnnnonnnonnnonnnonnnnnncnnncn nono nn corr on nr on nr on nr AERE i 2 3 45 CONFIGURATION A az 2 4 9 STARTUP AS TO Piti T TAE an an ita Sid 2 7 5 1 MAA A A A dt dead 2 7 5 2 SLOP APE ERE EEIE E O O TAN 2 8 Os SERV CE A dd o O 2 9 6 Installation of the services ii A es WR
44. library 4 4 1 kufdm_format_message Corresponds to FDM function None Prototype void kufdm_format_message HINSTANCE hlib Description Utility for displaying the last error in a Modal dialog box NT errors will be displayed in the language used by the PC The error messages are contained in a DLL with the name messages dll To access an error message you have to load first this DLL by calling the kufdm load library function Your process will be blocked till you click on the OK button of the Modal dialog box Report Not applicable ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 3 9 User Reference Manual 4 4 2 kufdm_load_library Corresponds to FDM function None Prototype HINSTANCE kufdm_load_library void Description Loads the DLL that contains the error messages used by the function kufdm_format_message Input parameters None Report Handle on the DLL if the load operation has been performed correctly NULL if the load operation has not been performed correctly Page 3 10 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Chapter Detailed description of the API 4 A detailed description of the programming interface may be found in the reference manual 1 This manual should be used as a reference guide 1 kfdm_create_contexte Corresponds to FDM function None Prototype HANDLE kfdm_create context
45. mentation Input parameters hdevice HANDLE type reference on the open device Data Buffer pointer to a K FDM_ PRESENT LIST type data structure described below containing the value read Typedef struct int Last_Error FDM PRESENT LIST Result K_FDM_ PRESENT LIST InternalInfos refer to fdm_mps var read far CallBackRoutine refer to fdm_mps var read far Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 31 User Reference Manual Detailed description of the API 26 kfdm_read_report Corresponds to FDM function fdm_read_ report Prototype BOOL kfdm_read_ report HANDLE hdevice int subscriber K_FDM_REPORT_VAR Data Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine i Description Used to read a subscriber report variable This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device subscriber physical address of the subscriber whose report variable is to be read Data_Buffer pointer to a K FDM REPORT VAR type data structure described below containing the value read Typedef struct int Last_Error FDM REPORT VAR Result
46. n If you need the service to start automatically you have to click the Startup button and then select the Automatic radio button ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 15 User Reference Manual Installation Page 2 16 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Chapter Use 3 1 PROGRAMMING INTERFACE The package comes supplied with an API which must be included in the application This application is compiled using a Visual C compiler V6 0 or above To do this the file kfdm c must be included in the project and the following line must be written in the application files which use this API include kufdm h The interface which is then available differs principally from the basic FDM V4 interface in terms of O the management by the driver of initialisation functions hardware software network medium and the management of communication ticks interrupts etc e services for the exchange of variables messages and bus arbitration which are limited to standard services O the time management service which is limited to broadcasting the time of the PC and managing the redundancy of the time producer e additional functions used to create the contexts necessary for Windows NT applications and to manage error processing ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 3 1 User Reference Manual
47. n Description Used to include or not include the subscriber in the election process of the time variable producer Input parameters hdevice HANDLE type reference on the open device val if FDM_FALSE the subscriber will not be included FDM_TRUE the subscriber will be included Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 54 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 43 kfdm generic_time get election_status Corresponds to the FDM function None Prototype Bool kfdm generic time get_election status Handle hdevice Etat Abonn s result Description Used to know the status of the subscriber regarding the process of the time variable election Input parameters hdevice HANDLE type reference on the open device result pointer to a Etat Abonnes type data structure described below that contains the status type def struct unsigned abonn s 8 enum subscriber states state 4 unsigned Prio 4 Etat Abonn s Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 55 User Reference Manual Detailed description of the API 44 kfdm_generic_time_ delete Corr
48. n of the FIP NT driver to a PCI communication board This tool can be launched e by double clicking FipBoardConf exe O using the following path Start gt Programs gt ALSTOM Technology FIPWARE gt FDM NT MULTI gt Researcher of WorldFIP boards ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 3 User Reference Manual Installation 4 CONFIGURATION Chercheur de carte WorldFip Modification de s PCI depuis la derni re configura CC141 Non utilis Device 00 Appiiguen Figure 2 1 FIP Driver NT Configurator Page 2 4 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Installation Select the board and then click on the Properties button The following screen will be displayed Propri tes carte PCI ELE AS EEN RAR omn Nor this FDM N gt FIPSPY FDM_RTX on Select the FDM_NT driver Enter a device number 1 to 20 This device number associates a the selected board with a driver Click on Apply ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 5 User Reference Manual Installation The following screen will be displayed Chercheur de carte WorldFip CC141 FDM_NT Device 01 This screen shows you the following couple the board the associated driver the device number Page 2 6 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 A
49. ng broadcast over the network using a level of precision fixed 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 The 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 4 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Use 3 PERFORMANCE Performance in terms of device exchange capacity has been defined as follows e Medium redundancy TWO_BUS_MODE e Data base TWO_IMAGE MODE Medium test period according to the basic FDM document 1 see Chapter 2 Subsection 1 2 e Value of Time out 1 sec e Value of Time out message according to the basic FDM document 1 see Chapter 2 Subsection 1 2 e Period of on line tests not selected there are no on line tests e BA DIM dimension 0x2000 O Maximum number of VCOMs 150 O Maximum number of AELE 48 e Maximum number of macrocycles 2 Maximum number of msg contexts 40 e Available messaging channels 0 for aperiodic 1 8 for periodic In addition the application using this API must be compiled in struct member alignm
50. oards Release 2 User Reference Manual ALS 53328 c en Detailed description of the API 5 kfdm_ ae le create Corresponds to FDM function fdm ae le create Prototype BOOL kfdm_ ae le create HANDLE hdevice int AE LE RANG int AE LE DIM Description Creation ofan AE_LE Input parameters hdevice HANDLE type reference on the open device AE LE _RANG row of the AE_LE Value 0 9 AE LE DIM maximum number of variables which may make up this AE_LE Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 7 User Reference Manual Detailed description of the API 6 kfdm mps var_create Corresponds to FDM function fdm_ mps var _create Prototype BOOL kfdm_mps var create HANDLE hdevice int AE LE RANG FDM_XAE Var_Param Description Defines the parameters of a variable in an AE_LE Input parameters hdevice HANDLE type reference on the open device AE LE RANG row of the AE_LE Value 0 9 Var Param pointer to a structure describing the parameters of the variable Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 8 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en Detailed
51. ontext number for the driver Data_Buffer pointer to an FDM_MESSAGING_TO_SEND type data structure describing the context Refer to 1 for details of this structure The scored out fields of the structure below are not to be initialised typedef struct enum FDM_MSG_IMAGE Position i struct void _ tUsexr Msg Ack FDM MESSAGING REE FDM MSG TO SEND yvoid Usex OQid epticnal userinfo f void Usexr Ctxt epticonal user info unsigned short Channel_Nr sending unsigned long Local DLL Address unsigned long Remote DLL Address FDM_MESSAGING TO SEND Page 4 38 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API The message exchange type at the Data Link Level is acknowledged or not acknowledged according to the contents of the address see Chapter 2 Subsection 1 6 of 1 Two supplementary bits are used They are bits 24 and 25 According to their values the interpretation is the following e 0 standard see Chapter 2 Subsection 1 6 of FDM User Manual e 2 not acknowledged e 3 acknowledged Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 39 User Reference Manual Detailed description of the API 31 kfdm_messaging to rec_create Corr
52. ort HANDLE type reference on the open device row of the AE_LE Value 0 9 This function returns a report with the Boolean value TRUE FALSE ALS 53328 c en if the request has been processed correctly if it has not FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 11 Detailed description of the API 10 kfdm_ mps var write_loc Corresponds to FDM function fdm ae le delete Prototype BOOL kfdm_ mps var write loc HANDLE hdevice int AE LE RANG int VAR_RANG int Lg USER_BUFFER_TO_READ Data Buffer Description Writing of an MPS variable Input parameters hdevice HANDLE type reference on the open device AE LE RANG row of the AE_LE Value 0 9 VAR_RANG row of the variable in the AE_LE Lg number of bytes of the variable 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 Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 12 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Detailed description of the API 11 kfdm_mps var_read_loc Corresponds to FDM function fdm ae le delete Prototype BOOL kfdm_ mps var read loc HANDLE int int hdevice AE LE RANG VAR_RANG K_VAR DATA Data
53. other limitations 2 DEVICE DRIVER ARCHITECTURE The software is composed of a driver and a programming interface in C ANSI which provides access to the driver The driver integrates the FIP DEVICE MANAGER Version 4 library which provides access to the WorldFIP network for target hardware based on a FULLFIP2 communication coprocessor Moreover it manages the range of FDM services whether for initialisation timers or the processing of interrupts The programming interface API which communicates with the driver via the standard functions provided by Windows NT 4 I OCTRL READ WRITE FILE provides a means for accessing the driver and via the driver for accessing the different functions of FIP DEVICE MANAGER Version 4 ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 1 1 User Reference Manual Introduction Windows NT 4 User THREAD Application Library Windows NT 4 Kernel FIP DEVICE MANAGER V4 CC138 139 140 141 Benefiting therefore from the facilities of a Windows environment different applications organised in several THREADS may access this driver without the need for any special precautions Page 1 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Chapter Installation 2 1 SUPPLY The software is provided on a CD ROM The directory Programs contains the device drivers e Fdm nt knl m pciR
54. request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 23 User Reference Manual Detailed description of the API 18 kfdm_ba_start Corresponds to FDM function fdm_ba_start Prototype BOOL kfdm_ba_start HANDLE hdevice int BA_RANG Description Used to start up a macrocycle Input parameters hdevice HANDLE type reference on the open device BA_ RANG row of the macrocycle 0 1 Report This function returns a report with the Boolean value TRUE if the request has been processed correctly FALSE if it has not Page 4 24 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual ALS 53328 c en 19 kfdm_ba_stop Q Corresponds to FDM function fdm_ba_stop Prototype BOOL kfdm_ba_stop HANDLE hdevice Description Used to stop the current macrocycle Input parameters hdevice HANDLE type reference on the open device Report This function returns a report with the Boolean value Detailed description of the API TRUE if the request has been processed correctly FALSE if it has not ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 4 25 User Reference Manual Detailed description of the API 20 kfdm ba status Corresponds to FDM function fdm_ba_status Prototype BOOL kfdm_ba_status HANDLE hdevice K_BA_INF_ STATUS Resultats Description
55. ronment on PCs equipped with CC138 CC139 CC140 and CC141 PCI boards This product therefore completes the FIP DEVICE MANAGER offer within the framework of ALSTOM s WorldFIP technological offer globally marketed under the FIPWARE trademark This document describes e installation configuration and start up using Windows NT 4 s standard driver handling functions O 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 either a working or advanced knowledge of WorldFIP operating principles Users who plan to develop the interfacing of a Windows 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 Description 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
56. ss of the information contained herein ALSTOM 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 All rights reserved Copyright 2001 ALSTOM Paris France Page 2 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Revisions Index Date Nature of revision letter a 02 2000 Document creation b 09 2000 New CC141 board Subscriber configuration service Bus Arbiter Service Modification of the k dm_mps var _synchronize function c 01 2001 Update of the subscriber configuration service ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 3 User Reference Manual Revisions Page 4 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Preface 1 PURPOSE OF MANUAL AND DOCUMENTED VERSION This document is the manual for the implementation of FIP DEVICE MANAGER Version 4 destined for a Windows NT 4 envi
57. text and click OK Driver configuration If you click this button then the FipBoardConf exe tool is launched see Section 3 You can consult the couple board driver device or change any of the couple parameters Page 2 10 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Installation 6 2 1 Subscriber Configuration Service tab This tab is used to set the parameters of the subscriber associated with the selected context EA Fip Device Manager NT Multi Board Service Configuration Figure 2 2 Subscriber Configuration Service tab Subscriber number Subscriber number on the WorldFIP network Segment number Number of the network segment on which the subscriber is located This number appears in the messaging system address and its default value is 0 ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 11 User Reference Manual Installation Board Type of the board used The possible PCI boards are CC138 CC139 CC140 or CC141 Mode See FIP DEVICE MANAGER User Manual Mode parameter of the FDM CONFIGURATION SOFT structure in the section that describes the function fdm_initialize network Time Slot Value of the time unit used as a basis for all time calculations see the Tslot parameter of the fdm_initialize network function described in the FDM User Manual MPS Generic Time Properties Checking the Hour Produced option allo
58. ty fdm_ba_set_parameters kfdm_ba_set_parameters fdm_ba_status kfdm_ba_status fdm_ba_stop kfdm_ba_stop fdm_ba_ loaded No such procedure exists fdm_read_report kfdm_read_report fdm_read_present_list kfdm_read_present_list fdm_read_identification kfdm_read_identification fdm_read_presence kfdm_read_presence fdm_read_ba_synchronize kfdm_read_ba_synchronize fdm_get_local_report No such procedure exists fdm_switch_image kfdm_switch_image fdm_get_image kfdm_get_image fdm_smmps_fifo empty Not used kufdm_get_subscriber_number kufdm_format_message kufdm load library Table 3 1 Comparison FDM V4 vs FDM V4 for Windows NT4 A driver is an independent program If for example the application program creates an AE LE with kdfm_ae le create in the driver the AE _LE still exists even when the user application is stopped If the user program is relaunched and an AELE is created with the same row the driver returns a warning This also applies for other objects BA messaging context ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 3 3 User Reference Manual 2 TIME MANAGEMENT Depending on the settings made the PC may choose to broadcast its time over the network thanks to the ID9802 variable and 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 bei
59. umber of the channel to be deleted This function returns a report with the Boolean value TRUE FALSE ALS 53328 c en if the request has been processed correctly if it has not FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 User Reference Manual Page 4 43 Detailed description of the API 35 kfdm send _message Corresponds to FDM function fdm_send message Prototype BOOL kfdm_send message HANDLE hdevice int RANG K FDM MSG TO SEND id Data Buffer LPOVERLAPPED InternalInfos LPOVERLAPPED COMPLETION ROUTINE CallBackRoutine Description Used to request the sending of a message This procedure uses Write Read FileEx in Windows NT It must be followed by SleepEx or another equivalent procedure refer to Microsoft SDK documentation Input parameters hdevice HANDLE type reference on the open device RANG row of the messaging context to be used Data Buffer pointer to a K FDM_MSG_TO_SEND type data structure described below The scored out fields are not to be initialised typedef struct FDM_MSG_TO_SEND MsgToSend void x fr FDM_MSG_T_DESC Block unsigned char Message 256 K FDM MSG TO SEND typedef struct _FDM MSG TO SEND struct EDM MSG TO SEND Next struct FDMMSG TO SEND Prev int Nr_ Of Blocks FDM_MSG T DESC k Ptr Block unsigned long Local DLL Address unsigned long Remote DLL Address
60. vs cence EEE REE RE EE ERER 4 8 dee MEA Start 25 24 a5 ce seat a uated IN 4 9 8 ikfdni ae lestopQy enna deat ete n a ee as ee hi ee ee eo 4 10 91 kfdim cael delete siccccch chet anced Aorta Mie eh O 4 11 ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 9 User Reference Manual Contents LO KEI Mps Var write doi ida 4 12 11 kfdm mps var read loc mia id 4 13 12 kfdm_mps_var_Synchromize ccecccsseessceescessceecesecaecscecsaecaeeeaeeeseceeseeenseenseceseceaeceaeeeaeeeseeneeeneeeneenstess 4 14 13 kfdm tnps var read farses A ada 4 16 14 kid mips var write farO tied neha ada 4 18 15 kfdm ba load macrocycle_manuall ccceecceescessceesecscecseeeseeeeeececeeeseensecesecaecnaecaecseecaeeeaeeneeeneesereees 4 20 16 kfdm ba load macrocycle fipcoOntb o ooococcnooniccnonononcconcconnonn nono nonnnnncnn ono no no nr cn nr nnn ron nr nro r ran rra nr narran 4 22 17 kfdm ba delete macrocyclel iii tica 4 23 18 kfdm di dica 4 24 NA 4 25 A Bal Status O 4 26 21 kfdm ba commute _macrocycle cccccsceesseessceseceeeeseceecseeeseeeneeseeesecesecnseceseeeaecsaecsaecsaecaeeeseeeseeeeeenteeas 4 27 20 kfdm basset pA OYO r a a a abad 4 28 23 Kfdii ba set para E E R E E eee eee 4 29 24 kfdm read presence oinei priri eie a E RR AE EEE E RRE E RA 4 30 DI Klm read present iaa 4 31 26 kfdm read repo o e e oti es iil de Gate A a he ete 4 32 27 kfdm_read_identification ccc
61. ws you to produce the time POSIX format 9802 Identifier 500 ms refreshing period Tslot precision In addition you can select the mechanism for managing the redundancy of the time producer when you check the Productor Choice option BA Number Number of the Bus Arbitrator of your station Max BA Number Highest number of the Bus Arbitrators connected on your network Vendor Name Enter the name of the manufacturer Model Name Enter the name of the product Revision Enter the revision index of the product Vendor Field Enter additional information relating to the product Page 2 12 FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 ALS 53328 c en User Reference Manual Installation 6 2 2 BA Service tab This tab is used to set some parameters if your subscriber has also to act as a BA A Fip Device Manager NT Multi Board Service Configuration alle os Figure 2 3 BA Service tab BA Management Check this box if your subscriber has also to act as a BA Priority Enter the priority of your BA between 0 to 15 The highest priority is 0 Max value of physical address used Enter the maximum value of the physical address of the subscribers present on the network ALS 53328 c en FIP DEVICE MANAGER NT DRIVER Multi Boards Release 2 Page 2 13 User Reference Manual Installation Auto BA If you select this radio button then an Auto BA is generated A periodical messaging list on the identifiers I

FIP DEVICE MANAGER NT DRIVER Multi Boards - Release

Contents

Download Pdf Manuals

Related Search

Related Contents