Home

SEGMENT_FDM Version 1 Software user manual

1. MCS CONFIGURATION Extern Signal Warning mcs initialize in parameter oftype minor errors MCS CONFIGURATION Extern Signal ConnexionFailure mcs initialize in parameter oftype Detection of connection MCS CONFIGURATION failure Extern Signal MCS mcs initialize in parameter of type that the user must activate MCS CONFIGURATION task mcs fifos empty Extern Signal Command Cnf mcs initialize in parameter of type acknowledgement of channel MCS CONFIGURATION command User Msg Rec Proc mcs createandstart channels in reception of a message on a one per configured channel parameter of type channel MCS USER CHANNEL CONFIGU RATION User Msg Ack mcs createandstart channels in acknowledgement of one per configured channel parameter of type message sent on a channel MCS USER CHANNEL CONFIGU RATION ALS 53331 b en SEGMENT FDM Version I Software user manual Page 3 15 Primitives Prototype of procedures void void void void void void void Extern Signal MCS void Extern Signal Error MCS TYPE ERROR WARNING pl void p2 MCS ERROR CODE LIST p3 Extern Signal Warning MCS TYPE ERROR WARNING pl void p2 MCS ERROR CODE LIST p3 Extern Signal ConnexionFailure USER MCSCHANNEL REF CONNEXION FAILURE LIST Extern Signal Command Cnf struct MCS REF MCS CHANNEL COMMAND User Msg Rec Proc USER MCSCHANNEL REF struct MCS SDU RECEIVED
2. presentation with the various interfaces Chapter 2 Description of functions operating contexts transfers Chapter 3 Primitives description of primitives Chapter 4 Software Initialisation operation of the software Chapter 5 Error messages Chapter 6 Installation procedures Appendix A Example Glossary 3 RELATED PUBLICATIONS The documents mentioned in this manual are specified in the text between brackets and listed in this paragraph 9 Y3 30 A420597 A User requirements 9 Y3 30 A418811 A Segmentation software development plan ALS 50278 FIP DEVICE MANAGER Software Version 4 User Reference Manual 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 ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 5 Preface Page 6 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Reader s comments ALS 53331 b en SEGMENT_FDM Version 1 Software user manual Your main job is M System designer C Programmer L Distributor B Maintenance M System integrator C Operator LJ Installer 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 5 avenue Newton B
3. 8 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Chapter Description of functions 2 1 ADMINISTRATION OF OPERATING CONTEXTS The operating contexts are the software objects on which the software functions rely They contain static operating parameters as well as a representation of the status at time t which defines the actions possible on these contexts enabling subsequent processing to be envisaged List of contexts 9 Contexts specific to the Software MCS instance MCS channel 9 Operating contexts handled by the Software and belonging to FIP DEVICE MANAGER FIP DEVICE MANAGER instance FIP DEVICE MANAGER channel FIP DEVICE MANAGER message contexts the MCS instance enables the Software to be integrated into software tasks or processes the MCS channels provide the transport services offered by the SEGMENT FDM software the FIP DEVICE MANAGER instance enables the FDM software to be integrated into software tasks or processes An FDM instance is associated with a WorldFIP network the message contexts provide the data link transfer services offered by the FDM R4 software ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 2 1 Description of functions Characteristics of FDM message contexts 9 The SEND message contexts enable messages to be sent at DLL level from a local Source Address to a Destination Address 9 The RECEIVE message contexts enable messages to be rece
4. Address corresponds to source LSAP segment number source address segment Remote Address corresponds to destination LSAP segment number destination address segment One and only one address is used per channel If the remote station is a MICROFIP station you must configure Remote Address 00 xy zz xy physical address of the MICROFIP station on the network zz segment number 9 Configure User Msg Rec Proc pointer to the callback function which is called by the Software to send the user the message reception procedure message 9 Configure User Msg Ack pointer to the callback function which is called by the Software to send the user the message sent acknowledgement ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 2 7 Description of functions 3 TRANSFERS Data transfers take place via DATA type channels in both SEND and RECEIVE directions The events which activate the transfers are transmission requests from the user and reception of data units from the network Transmission and reception of messages using the A DATA protocol takes a certain amount of time as it implements mechanisms such as segmentation and reassembly with acknowledgement of each data unit 9 when sending a user message segmentation consists in chopping the message into packets 9 whenreceiving DLL frames reassembly consists in combining them to create a message 9 Packet user data entity with assoc
5. P 215 92142 CLAMART Cedex France Fax 33 0 1 46 29 12 44 All comments will be considered by qualified personnel REMARKS ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 7 Reader s comments Page 8 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Contents CHAPTER 1 GENERAL PRESENTATION 1 GENERAL SOFTWARE DESCRIPTION tech rettet teinte inerte anne sheets E E then reti 1 1 2 PRESENTATION OF FUNCTIONS Gite pr td e iem reellen 1 3 3 PRESENTATION OF THE INTERFACE WITH THE USER APPLICATION eee 1 4 3 1 Initi lisation DEIBIUIVES eee ee i epic tete dien eg ede e eee RR 1 4 3 2 Configuration f nctians ee Eder e eet DIRE eR c ERE Bis ERR eee Rocio rire be ate 1 4 3 3 Send messages functions ls 1 4 3 4 Receive messages Tunctions se eet per Pepe pectet br es lernen 1 5 3 3 Activation TUNCHONS oen UR HO RIO URS e eee RM ette end 1 5 3 6 X Functions to inform the User ieren e a eren eene ener teneret trennen trennen nre 1 5 4 PRESENTATION OF THE INTERFACE WITH FDM R4 eene nennen rennen 1 6 5 PRESENTATION OF THE INTERFACE WITH THE OPERATING 1 7 CHAPTER 2 DESCRIPTION OF FUNCTIONS 1 ADMINISTRATION OF OPERATING en eene nenne tenete nennen 2 1 1 1 Creation of general operating context MCS instance uueennessesanesnnesnnesnnenn
6. User Msg Ack USER MCSCHANNEL REF struct MCS SDU TO SEND Description of types MCS ERROR CODE LIST gives the error code list see chapter 5 Description of type MCS TYPE ERROR WARNING This type is used to identify the error or warning source in order to find out the type of parameter P2 typedef enum MCS TYPE MCS CHANNEL CONFIGURATION MCS TYPE MCS SDU TO SEND MCS TYPE FDM MSG RECEIVED MCS TYPE FDM MSG TO SEND MCS TYPE MCS FDM MSG TO SEND MCS TYPE MCS CHANNEL REF As regards the user it is mainly field p3 that has to be analysed For certain warnings or errors it is however of interest to find out the reference of the faulty channel This reference can be read in parameter when parameter type Pl MCS TYPE MCS CHANNEL REF see Error messages chapter code MCS ERROR CODE LIST Page 3 16 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives The other cases are used to identify the Software level at which the error occurred Description of type CONNEXION FAILURE LIST see chapter Error messages code CONNEXION FAILURE LIST ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 17 Primitives 2 DESCRIPTION OF OS PRIMITIVES 2 1 OS primitives of FDM_R4 The user must fill out the OS primitives as defined in manual ALS 50278 The primitives concerning some OSs are already filled out If the user uses an OS other than that def
7. creation of the instance 3 2 Configuration functions mcs channel command channel operating command creation stop destruction Extern Signal Command cnf informs the user when a channel command has been acknowledged 3 3 Send messages functions mcs send message sends a message on a channel User Msg Ack informs the user when a message has been acknowledged Page 1 4 SEGMENT FDM Version 1 Software user manual ALS 53331 b en General Presentation 3 4 Receive messages functions User_Msg_Rec_Proc informs the user when a message is received mcs_free_received_message releases a received message mcs cat msg received concatenation of received message data 3 5 Activation functions mcs fifos empty activation of Software internal fifos emptying function Extern Signal MCS informs the user that he must activate the Software internal fifos emptying task 3 6 Functions to inform the user Extern Signal Error informs the user of a serious error Extern Signal Warning informs the user of a minor error Extern Signal ConnexionFailure informs the user of a connection failure mcs get version Software version read request mcs get errorandwarningstring error or warning code in character string format ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 1 5 General Presentation 4 PRESENTATION OF THE INTERFACE WITH FDM_R4 Internally the Software calls on the FIP DEVICE MANAGER message services fdm_messaging_ fulldu
8. message 9 with start middle or end MCS PDU or 9 with start middle end PDU MCS then the Software sends a DLL frame with acknowledgement PDU and reassembles the DLL frames When the message is complete the user is notified by the callback procedure which he provided at channel configuration that a message has been received on the channel concerned The data making up the message are supplied in x blocks The user can call a primitive supplied by the Software in order to reconcatenate the message received into a single block The user is notified of a message number and the total size of the message data Itis up to the user to release the SDU received as the Software has to manage recycling of memory resources If problems occur the user is informed by connection fault Warning or Signal procedures Page 2 10 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Chapter Primitives 3 1 DESCRIPTION OF USER PRIMITIVES 1 1 Procedure mcs get software version Prototype mcs get software version MCS VERSION Version Description This procedure is used to identify the MCS software version used Input parameters Version pointer to the storage zone for the VERSION type version read Definition of type MCS VERSION typedef struct char Version char Revision char Proto char ProtoNr char Date 3 MCS_VERSION ALS 53331 b en SEGMENT_FDM Version 1 Software user manual Page 3 1 Prim
9. type DESC BLOCK DATA T This type is the same as that defined by FDM MSG T DESC in FDM R4 typedef struct DESC BLOCK DATA T struct DATA BLOCK TO TRANSFER unsigned short Nr Of Bytes unsigned char Ptr Data struct DESC BLOCK DATA T Next Block User Block struct DATA BLOCK TO TRANSFER Private This type contains a private field the use and content of which do not concern the user This field is in italics DESC BLOCK DATA T Nr Of Bytes Number of bytes contained in the block pointed by Ptr Data Ptr Data Pointer to the zone containing the data Next Block Pointer to the next block of the same type Output parameters code of type MCS ERROR CODE LIST See ERROR MESSAGES APPENDIX MCS OK if the request is accepted or following error code MCS SEND DATA ON INEXISTING CHANNEL MCS SEND DATA ON IDLE CHANNEL MCS INTERNAL ERROR If the request is not accepted then a Extern Signal Error or Extern Signal Warning procedure is triggered with the same error code ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 11 Primitives Page 3 12 When the request is accepted the following calls are possible either Extern_Signal_Error which is triggered in the event of a major problem or Extern Signal Warning which indicates a fault of type MCS_ SEND DLL xxx on the reference of the channel concerned This warning is associated with the Service Report field i
10. ConnexionFailure USER MCSCHANNEL REF CONNEXION FAILURE LIST MEMORY RN J MCS CONFIGURATION In italics Name fdm ref Extern Signal MCS Extern Signal Error Extern Signal Warning Extern Signal ConnexionFailure Extern Signal Command Cnf Memory Management Ref Memory Management Ref procedures to be supplied by the user see chapter 3 Subsection 1 1 9 name given to the instance maximum 8 characters reference of the FDM instance to which the SEGMENT FDM instance is attached pointer to a user function to be called by SEGMENT FDM to tell it to activate the void task pointer to a user function to be called by SEGMENT FDM to indicate a serious software error pointer to a user function to be called by SEGMENT FDM to indicate a minor software error pointer to a user function to be called by SEGMENT FDM to indicate a connection failure pointer to a user function to be called by SEGMENT FDM to inform the user about the command channel result Pointer to a structure which is necessary when the partitioned memory manager is used Must be initialised at NULL of not partitioned memory manager is used MEMORY RN is a structure defined in the file gdm os h of the software FDM R4 This file is to complete depending on user OS ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 3 Primitives Output parameters MCS_REF pointer to MCS REF type instance created Poin
11. MCS ERROR CODE LIST J MCS CHANNEL COMMAND Next Previous mcs ref Command paramIN for create channelmcs Report This type and certain types on which it depends contain private fields the use and content of which do not concern the user These fields are in italics Command paramIN for create channelmcs Report command type create stop delete see _MCS_CHANNEL_COMMAND _LIST pointer to the configuration channel to create see MCS_USER_CHANNEL_CONFIGURATION see MCSCHANNEL_REF field used when confirming the request see Extern Signal Command Cnf Page 3 6 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives Definition of type enum CHANNEL COMMAND LIST typedef enum MCS CHANNEL CREATE MCS CHANNEL STOP MCS CHANNEL DELETE Description of type MCSCHANNEL_REF Software internal not handled by the user Reference of an MCS channel created The message is sent received on a channel reference Definition of type MCS_USER_CHANNEL_CONFIGURATION typedef struct _ MCS_USER_CHANNEL_CONFIGURATION USER_MCSCHANNEL_REF UserChannelRef unsigned long Local_Address unsigned long Remote_Address unsigned short ConnexionTempoTicks unsigned short MaxSDUsSize MCS TYPE DLL DLLType void User Msg Rec Proc USER MCSCHANNEL REF struct MCS SDU RECEIVED void User Msg Ack USER MCSCHANNEL REF struct MCS SDU TO SEND _
12. MSG TYPE msg type MSG MODE msg mode E UserChannelRef user reference one per MCS channel Local Address address Local DLL Address message transmission source Lsap segment number Remote Address address Remote DLL Address message transmission destination Lsap segment number ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 7 Primitives ConnexionTempoTicks MaxSDUSize DLLType User Msg Rec Proc User Msg Ack number of ticks needed to trigger a time out Timeout value triggering repetition of a data PDU sent following a user s send message request when the channel has not received an acknowledgement for this PDU one tick an fdm ticks counter call see manual ALS 50278 maximum size of message being sent or received on the channel type of exchange at DLL level e connection channel to a FULLFIP2 type subscriber e connection channel to a MICROFIP type subscriber Pointer to a user function to be called by the Software after a message is received Pointer to a user function to be called by the Software after a message acknowledgement is received The callback procedures can be the same for all the channels msg type msg mode ack Type of message periodic on channel 1 or aperiodic acknowledgement mode for sending on the channel sending in normalised mode address acknowledged or not acknowledged sending in non acknowledged mode The no
13. SEGMENT FDM Version 1 Software user manual ALS 53331 b en First issue 04 2000 This edition 07 2000 Meaning ofterms that may be used in 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 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 usefulness of the information contained
14. allback function which is to be called by the Software to inform the user that he must activate the MCS empty fifo task see Sequence the actions to be performed 9 identifies the user callback function which is to be called by the Software to inform the user of the result of the channel command see Channel commands Page 2 2 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Description of functions 1 2 Inform the user of operating faults Checking user actions All the user s actions are checked so that a situation is never reached in which the software s behaviour is non deterministic These checks are usually run upstream when the interface procedures are called by the user In any case the user must be precisely informed of why the service he requests has been rejected reports are provided immediately as well as later on When it can the Software also gives information about problems encountered using Warnings or Fatal errors or Connection Failure errors by calling user callback procedures which were supplied at creation of the instance Checking the configurations When the configurations are created the Software runs as many checks as possible in order to guarantee the correct working of the corresponding context if creation is accepted The configuration parameters are carefully checked so that only configurations which have a real meaning are accepted In addition memory management checks are run as well as
15. are as follows 9 channel command requests queue 9 message transfer request queue DLL frames reception queue 9 link transfer confirmations queue DLL frame sent acknowledgement queue 9 timeouts expiry queue This queue contains the times for management of the DLL frame acknowledgement timeouts Page 2 4 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Description of functions The operating model is the same as that used by FIP DEVICE MANAGER C1 gt Place message Indication processing required Sequencing C4 Processing request is stored in the interconnection queue 2 When an interconnection queue goes from empty to not empty the user is called by the Extern Signal MCS procedure The user must write this procedure In this procedure the user must activate a task enabling control to be given to the Software When the software has control via procedure mcs_fifos_empty it scans the interconnection queues When one of them is other than empty it extracts the message and triggers processing by calling the appropriate procedure ALS 53331 b en SEGMENT_FDM Version 1 Software user manual Page 2 5 Description of functions 2 CHANNEL COMMANDS The Software offers the user an interface for commanding a channel There are 3 types of channel commands 9 creation request 9 stop request 9 destruction request These commands can only take place if the MCS instance initialisatio
16. checks on configuration objects on which the Software relies Warning of malfunctions on a channel Any problem encountered by the Software is explicitly reported to the user By their very nature A DATA type channels must be capable of sending and receiving according to the capabilities initially assigned to them In particular the acknowledgement repetition anti duplication mechanisms must be able to absorb network transmission faults and carry out reliable transfers in reasonable time As soon as the Software detects a malfunction in a channel it warns the user by calling a warning procedure giving the reference of the faulty channel The following types of malfunction are possible 9 message transfer failure on a transmission channel 9 detection of sequence break in the reception window on a reception channel ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 2 3 Description of functions 1 3 Sequencing the actions to be performed The following principle is used 9 all the events for which processing is not considered to be short are stored in interconnection queues These events are on hold until the Software takes over control retrieves them one by one and initiates processing of them in turn These events are as follows 9 channel command requests 9 message transfer requests 9 message transfer confirmations 9 reception of data link messages 9 expiry of timeouts The interconnection queues
17. e mcs_createandstart_channels 0x13 _MCS_CHANNEL_CREATE_ON_ILLEGAL_INSTANCE Instance not valid must give that suppliedby CR mcs initialize 0x14 _MCS_CHANNEL_CREATE_ILLEGAL_USERCHANNEL_REF A user reference in table CR MCS_USER_CHANNEL_CONFIGURATIO N is not valid It must be unique to each MCS channel 0x15 _MCS_CHANNEL_CREATE_TOO_MUCH_CHANNELS Number of channels gt 256 CR 0x16 _MCS_CHANNEL_CREATE_ALLOCATE_MEMORY_FAULT Memory allocation problem CR Ox1B MCS CHANNEL CREATE ILLEGAL CALL BACK A call back User msg ack or User msg rec CR FUNCTION procedure is null Ox1C MCS CHANNEL CREATE ILLEGAL LOCAL ADDRESS Error on a local LSAP CR OxID MCS CHANNEL CREATE ILLEGAL REMOTE ADDRESS Error on a remote LSAP CR 1 _MCS_CHANNEL_CREATE_ILLEGAL_CHANNEL_NR Error on Channel_NR channel should be lt 9 CR ALS 53331 b en SEGMENT_FDM Version 1 Software user manual Page 5 1 Error messages 2 E W Value Mnemonic Context CR Ox1F _MCS_CHANNEL_CREATE_ILLEGAL_SDU_SIZE SDU size 0xFFFF CR 0x22 MCS CHANNEL CREATE ILLEGAL REFUSED DLL CTXT Creation of message context refused by CR CREATION FDM R4 MCS SEND DATA xxx faults Errors detected at message transmission mcs send message 0x100 MCS_SEND_DATA_ON_INEXISTING_CHANNEL Reference of channel on which message sent Note 1 does not exist CR 0x104 MCS_SEND_DATA_INVALID_LENGTH Message size
18. e on a channel When the Software receives a send message request from the user 9 itchecks that the channel on which the user asks to send the message has indeed been configured and if the channel is in the running state not stopped or in destruction state If not the request is qualified as negative with the appropriate report 9 itstores the message in the queue and when the Software has control it carries out the following segments the message to be sent into x DLL frames sends the DLL frames managing acknowledgement and repetition gives the user confirmation of transfer warns the user of any malfunction In the configuration of a channel the number of requests in parallel was set at 1 so the user must receive confirmation of message transfer before being able to send a new message ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 2 9 Description of functions The user receives confirmation of transfer via the callback procedure which he provided at configuration of each channel This confirmation is valid if each DLL frame making up the message has been sent and received an acknowledgement DLL frame If problems occur the user is informed by connection fault Warning or Signal procedures 3 2 Receiving a message on a channel FIP DEVICE MANAGER differentiates between the network frames according to the destination addresses The DLL frames are sorted by the software and ifthey make up a
19. ensnensennnnnnonnnnnnennennnenn 2 2 1 2 Inform the user of operating faults eren enne enne 2 3 1 3 Sequencing the actions to be performed ussuessessnesnnesnnesnnesnnennonnnonsnennnnnnnnnnnnnnnnnnnnnesnnennnesnn en 2 4 2 CHANNEL COMMANDS etit rr e ERU ERR hee Bleiben 2 6 2 1 Channel configuration tte Dp nee DOR e TSS EE 2 6 3 TRANSEERS sno eniti tne Her tdeo eir ert epo o en e oes 2 8 3 1 sendinp a message on a channel ct erregen 2 9 3 2 Receiving a message on a channel eene enne rennen trennen nnne 2 10 CHAPTER 3 PRIMITIVES 1l DESCRIPTION OF USER PRIMITIVES eese nennen nennen tren nren eren nennen 3 1 1 1 Procedure mcs get software version eecceesceceseceeseeceseeeeseeceseeesaeeceseeceeaeecsueeseneecsueeeeaeecsaeeeeneecsas 3 1 1 2 Proced reimncs 1nt alie eedem eee GN 3 2 1 3 Procedure mcs fifo empty tke eR Rer rU ERREUR TREES 3 4 1 4 Procedure mcs get errorandwarningstring 3 5 1 5 Procedure mcs channel Command ccccccccccccccccccccccccecccesececcsecesecesecesesessseseeessssssssssssseseeseseseseseseaes 3 5 1 6 Procedure mics send message run der de eee cede dte pret ve eds 3 10 1 7 Procedure mcs free received message iriennerien R eene EEE enne nennen 3 13 1 8 Procedure mcs cat msg received nente 3 14 1 9 Primitives called to be suppl
20. ers None 1 4 Procedure mcs get errorandwarningstring Prototype void msc get errorandwarningstring char String MCS ERROR CODE LIST Code Description This user help procedure gives the user a clear report associated with type MCS ERROR CODE LIST It can be used when the user wishes to print the code plainly rather than just a number Input parameters String pointer to code storage zone This zone supplied is assumed to have at least 40 characters Code error code to be translated 1 5 Procedure mcs channel command Prototype MCS ERROR CODE LIST mcs channel command MCS REF Mcs MCS CHANNEL COMMAND mcschannelcmd Description This procedure is used to create stop and delete a channel There is a sequence for a channel Youcreate a channel e You can stop only a created channel Youcan delete only a stopped channel You must give the input parameters until the user callback procedure Extern Signal Command Cnf is called This callback provides the request result ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 5 Primitives Input parameters mcs ref pointer to the MCS REF instance mcschannelemd command request of type MCS CHANNEL COMMAND Definition of type MCS CHANNEL COMMAND typedef struct MCS CHANNEL COMMAND struct MCS CHANNEL COMMAND struct MCS CHANNEL COMMAND struct MCS REF MCS CHANNEL COMMAND LIST MCS USER CHANNEL CONFIGURATION struct MCSCHANNEL REF
21. herein ALSTOM gives no warranties of merchantability or fitness for purpose shall apply 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 2000 ALSTOM Paris France Page 2 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Revisions Index Nature of revision letter 07 2000 Modifications throughout the document ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 Revisions Page 4 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Preface 1 PURPOSE OF MANUAL AND DOCUMENTED VERSION This document is the user manual for the SEGMENT_FDM Software version 1 This is a subscriber message segmentation software built with the FULLFIP2 communication component This manual describes all the functions offered by this software and how to implement and use it 2 CONTENT OF THIS MANUAL The content of this manual is as follows Chapter 1 General presentation description of the Software functions
22. iated MCS header transmitted to the data link layer 9 Frame data unit transmitted on the physical layer WAIT man T Ar tee Rr c IER ea VL Sed E E ET NI A NEA EE N v N N Ne ee es 5 MCS header XMCS Packets Link header 1 Packet X Link frames For exchange on a channel connected to aMICROFIP type station DLL_SIZE 122 bytes destination source MCS header lt gt gt 0 user data max 118 bytes IsapPF Isappf Eg segment In IsapPF Isappf ES segment MCS size 3 o MCS PDU N No invocation PF No invocation Lo Page 2 8 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Description of functions For exchange on a channel connected to a FULLFIP2 type station DLL SIZE 256 bytes destination MCS header Source user data max 252 bytes IsapPF lo Isappf Eg segment N IsapPF ESSI Isappf ES segment MCS PDU No invocation PF EN MCS size 3 No invocation pf The MCS header comprises a PDU giving the type of frame 9 statPDU 0x24 middle PDU 0x25 9 end PDU 0x26 9 complete PDU 0x27 when the SDU can fit into a single frame Each PDU sent must be acknowledged by an Ack PDU 0x60 frame without user data When the channel does not exist the transfer request is refused and an immediate negative report is produced and the Software notifies it using the Warning procedure 3 1 Sending a messag
23. ics 9 the SDU MaxSDUSize that can be sent or received on a channel is configured This size must have the same value on the remote station Its maximum value OxFFFF or 65535 bytes 9 the user gives the type of destination subscriber MICROFIP or FULLFIP2 DLLType The size of the DLL frame differs depending whether one is connected to a MICROFIP type station 128 bytes or a FULLFIP2 station 262 bytes Internally the Software thus configures DLL 517 122 size of message data link layer in bytes for MICROFIP subscriber DLL Size 256 size of message data link layer in bytes for FULLFIP2 subscriber 9 ConnexionTempoTicks is configured each message is segmented into x DLL frames For each DLL frame sent there must be a corresponding DLL acknowledgement frame returned connexionTempoTicks is the value of the timeout which triggers repetition of a DLL frame when the channel has not received an acknowledgement for this frame The message contexts needed by FDM LS APs are created by the Software during this configuration process 9 the type of message used msg type is configured Depending on the type used the Software configures the WorldFIP channel associated with the message context 0 aperiodic channel associated with the aperiodic message traffic 1 periodic channel associated with a message identifier circulating periodically 9 Address and Remote Address are configured Local
24. ied by the user eene 3 15 2 DESCRIPTION OF OS PRIMITIVES eese nennen nennen 3 18 2 OS primitives of FDM RA nenne see 3 18 2 2 OS primitives for SEGMENT FDM seen nennen nennen eren eene enne enne 3 18 ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 9 Contents CHAPTER 4 SOFTWARE INITIALISATION te HOW TORUN THE SOFTWARE nett RE CR ige CR Ob 4 1 2 INIITALISETEDM RA ie prt RUM nU ge 4 2 2 1 Use of the Periodic Message 4 2 2 2 Use of the Aperiodic Message system enne nennen trennen rennen ens 4 2 3 RUN AN APPROPRIATE BUS ARBITER PROGRAM eee nennen nennen nennen 4 3 4 INITIALISE THE SOFTWARE AND CONFIGURE THE MCS CHANNELS eene 4 4 CHAPTER 5 ERROR MESSAGES 1 CODE MCS ERROR CODE LIST ier eU er Rasen asien 5 1 2 CONNEXION FAILURE 2 tete e t Re Het Ursi e AI EE Ure bete Pd ces 5 4 CHAPTER 6 INSTALLATION PROCEDURES 1 PRESENTATION OF DELIVERY tete te i o E E Re EPI Spuren 6 1 2 ene reinen REIHE va ed Ie 6 2 3 COMPILATION PARAMETERS e eeeeeeee E E A A teen teen 6 3 APPENDIX A EXAMPLE EXAMPLE OF SEGMENT FDM SOFTWARE MAKEFILE FOR PSOS eee 1 GLOSSARY Page 10 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Chapter General P
25. ined in the FDM_R4 compilation options see file User_opt h he must then write the procedures concerning his OS in files fdm_os h and fdm_os c 2 2 OS primitives for SEGMENT_FDM The Software uses the same FDM_R4 files User_opt h fdm_os h and fdm os c If the user uses an OS other than that defined in the FDM_R4 compilation options see file User_opt h he must then write the procedures concerning his OS in file mcs os c This concerns the following procedures BinarySemaphoreCreate creation of a binary semaphore SemaphoreDelete deletion of the binary semaphore Page 3 18 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Chapter Software initialisation 4 1 HOW TO RUN THE SOFTWARE The actions involved must be run in a certain order as described below 1 Initialise the FDM R4 software configure the DLL transfer rate physical address segment number etc initialise the R4 message part configure the WorldFIP channels for transmission locally create the WorldFIP identifiers providing the FIP node with the message bandwidth 2 Runan appropriate BUS ARBITER program 3 Following this initialisation you must start the Software initialisation ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 4 1 Software initialisation 2 INITIALISE FDM_R4 The Software uses the message services of FIP DEVICE MANAGER Therefore before using the Software you must have made all the call
26. ion 1 Software user manual ALS 53331 b en General Presentation 2 PRESENTATION OF FUNCTIONS The Software offers the following functions 9 system operation administering operating contexts e initialisation of the general operating context e configuration creation stop and delete of SEGMENT FDM channels informing the user of operating faults sequencing the actions to be performed 9 transfer of data via an A DATA channel using the MCS protocol sending a message on a channel receiving a message on a channel ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 1 3 General Presentation 3 PRESENTATION OF THE INTERFACE WITH THE USER APPLICATION This interface offers the user primitives which are associated with the various SOFTWARE functions MEE Receive Message Send Message Ver Msg _Rec_Proc mes cat msg received User Msg Ack mcs free received ness e 1 2 I mes _send_message INITIALISATION mcs initialize 2e CONFIGURATION mcs channel command Extern Signal Command Cnf Extern Signal ConnexionFailure Extern _Signal_ Error FORMATION Extern _Signal_Warning i mcs get version mcs get errorandwarning mcs fifos empty ACTIVATION Extern Signal MCS 4 3 1 Initialisation primitives mcs_initialize software initialisation
27. itives Version Revision Proto ProtoNr Date 0 Date 1 Date 2 version no revision no gt if prototype version 0 gt official version prototype number only significant if Proto 1 Year Month Day Output parameters None 1 2 Procedure mcs initialize Prototype MCS_REF mcs_initialize MCS_CONFIGURATION param MCS_ERROR_CODE_LIST report Description This USER side interface is used to create an instance of the Software in other words to initialise the operating context of this instance Creating an instance leads to allocation and initialisation of all the resources required for the working of this instance Input parameters param pointer to a table containing the configuration to be initialised by the MCS CONFIGURATION type user table report of type enum _MCS_ERROR_CODE_LIST contains the error code for the reason for the failure to create the MCS instance see chapter 5 Page 3 2 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Primitives Definition of type MCS_CONFIGURATION typedef struct char Name FDM REF fdm ref void Extern Signal MCS void Extern Signal Error MCS TYPE ERROR WARNING void MCS ERROR CODE LIST void Extern Signal Warning MCS TYPE ERROR WARNING void MCS ERROR CODE LIST void Extern Signal Command Cnf struct MCS REF struct MCS CHANNEL COMMAND void Extern Signal
28. ived at DLL level from a Source Address at a local Destination Address 9 The FULLDUPLEX message contexts enable messages to be sent and received at DLL level 9 The FIP message channels enable a FIP message context to use a given part of the bandwidth for FIP network messages These channels are periodic when the bandwidth has an initial fixed size or is aperiodic They are needed for SENDING DLL messages Links between FDM and SEGMENT FDM context 9 aninstance of the Software is attached to one and only one instance of FDM that is a unique WorldFIP node 9 a MCS channel is mapped on an FDM message context and this context is only handled by this MCS channel The various contexts are configured as follows 9 It is up to the user to configure the WorldFIP channels at DLL level necessary for sending messages We talk of periodic or aperiodic WorldFIP channels via the procedures offered by the FDM R4 software 9 The Software offers the user a configuration interface for creating the general operating context MCS instance configuring the MCS channels 1 1 Creation of general operating context MCS instance Creation of the instance 9 leads to allocation and initialisation of all the necessary resources 9 identifies the user callback functions which are to be called by the Software to provide information about any faults encountered during operation see Inform the user of operating faults 9 identifies the user c
29. knowledgement has been received Page 5 4 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Chapter Installation procedures 1 PRESENTATION DELIVERY SEGMENT_FDM source files mcs user c mcs h mcsconfi c mcs os h mcs Oos c mcsprive h mcstools c mcspriv2 h mcsheart c mcs opt h The user must obtain the FDM R4 source files ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 6 1 Installation procedures 2 IMPLEMENTATION For this part you should refer to Manual ALS 50278 and 9 write the content of the user procedures likely to be used filloutthe OS interface macros file fdm os c FDM R4 file mcs os c SEGMENT FDM 9 customise file user opt h FDM R4 according to the needs of the application concerned 9 compile files XXX c with the appropriate compiler using the relevant compilation options 9 build library FIPMAN lib this name simply an example using the appropriate library manager 9 build library SEGMENT FDM lib this name simply an example using the appropriate library manager 9 link these two libraries with the user application Page 6 2 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Installation procedures 3 COMPILATION PARAMETERS The compilation options are replaced by FDM R4 library configuration options in file user opt h Before building the two libraries FIPMAN lib and SEGMENT FDM lib this file must therefore be config
30. m FDM RA It indicates an error in input parameter CHANNEL REF for this procedure Note 3 MCS TYPE FDM MSG TO SEND This type is used in Extern Signal Error following calling of procedure mcs send message and means that the FDM message context associated with the MCS channel no longer exists which is impossible Note 4 MCS TYPE MCS FDM MSG TO SEND This type is used in Extern Signal Error following an acknowledgement frame transmission error Note 5 MCS TYPE MCS CHANNEL REF This type is used to give the references of MCS channel in Extern Signal Error or Extern Signal Warning ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 5 3 Error messages 2 CONNEXION_FAILURE This code is a list It is used in the procedure Extern_Signal_ConnexionFailure void Extern_Signal_ConnexionFailure USER MCSCHANNEL REF CONNEXION FAILURE LIST Value Mnemonic Context Exchange error the received PDU MCS 0 CONNEXION FAILURE In ProtocoleExchange number is not expected Sequence number error when aMCS _CONNEXION_FAILURE_BrokenSequence frame was received Error when a message is transferred Not all the acknowledgement PDUs on all 2 CONNEXION FAILURE SDUTransferError the sent frames are available In this case the acknowledgement of the sent message is negative in User_Msg_Ack After the transfer of a PDU no PDU _CONNEXION_FAILURE_PDUTransferError ac
31. mmand before a delete command WARNING Be careful when you stop a channel No receive or send message must be running ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 9 Primitives 1 6 Procedure mcs send message Prototype MCS ERROR CODE LIST mcs send message CHANNEL REF channelmcs SDU TO SEND msg Description This procedure is run by the user when he wishes to send a message on a running channel The requested channel must exist and have been configured Input parameters channelmces MCS channel reference It was given at channel configuration msg message to be sent of type MCS SDU TO SEND Definition of type MCS SDU TO SEND typedef struct MCS SDU TO SEND struct MCS SDU TO SEND Next struct MCS SDU TO SEND Previous ALL MCSCHANNEL REFS Channel unsigned long Destination unsigned int Nr_Of_Blocks DESC_BLOCK_DATA_T Ptr_Block MCS SDU TO SEND PRIVATE AREA Private MCS MCS ERROR CODE LIST Service Report This type and certain types on which it depends contains private fields the use and content of which do not concern the user These fields are in italics Nr Of Blocks number of DESC BLOCK DATA T type blocks in the message Ptr Block pointer to the first message description block Report field used when confirming transmission acknowledgement Page 3 10 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives Definition of
32. n MCS SDU TO SEND which will be set to MCS SEND DATA DLL FAIL when calling the transmission acknowledgement primitive SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives 1 7 Procedure mcs free received message Prototype void mcs free received message SDU RECEIVED msg Description This procedure is to be run by the user when he has received and analysed a message It enables the Software internal resources created for this message to be released Following this procedure all the data concerning the message is deleted Input parameters msg pointer to message to be released of type MCS SDU RECEIVED Definition of type MCS SDU RECEIVED typedef struct SDU RECEIVED struct MCS SDU RECEIVED Next struct MCS SDU RECEIVED FPrevious ALL MCSCHANNEL REFS Channel unsigned long Source unsigned short SDU Nr unsigned short SDU Size unsigned int Nr Of Blocks DESC BLOCK DATA R Ptr Block MCS SDU RECEIVED ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 3 13 Primitives This type contains private fields the use and content of which do not concern the user These fields are in italics SDU Nr number of the SDU SDU Size total size of message received Nr Of Blocks number of blocks of type DESC BLOCK DATA R Ptr Block pointer to the first message description block Definition of type DESC BLOCK DATA R typedef struct DESC BLOCK DATA
33. n acknowledged mode is preferable because the MCS acknowledgement frames are used Description of type _MCS_TYPE_DLL typedef enum _MCS_TYPE_DLL_FULLFIP MCS_TYPE_DLL_MICROFIP Description of type MCS MSG TYPE DLL typedef enum MSG TYPE PERIOD periodic type messages MCS MSG TYPE APERIOD aperiodic type messages Page 3 8 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives Description of type _MCS_MSG_MODE_ACK typedef enum MSG MODE NORMALISE MCS MSG MODE NOACK Command mcs channel command Extern Signal Command Cnf Channelmcs channel reference of created channel NULL if not created MCS CHANNEL CREATE ParamIN for create MCS CHANNEL STOP ParamIN for create not use Channelmcs channel reference of channel to stop MCS CHANNEL DELETE ParamIN_for_create not use Channelmcs channel reference of channel to delete Output parameters MCS ERROR CODE LIST MCS OK if the request is accepted the user will have the report of his command in the callback procedure Extern Signal Command Cnf or following error code MCS CHANNEL COMMAND ON ILLEGAL INSTANCE MCS CHANNEL COMMAND ILLEGAL PARAMETERS MCS CHANNEL COMMAND ILLEGAL SERVICE MCS CHANNEL COMMAND ILLEGAL CHANNEL STATE A channel is in running state when he is created and if there is no stop or delete command on his reference You must give a stop co
34. n phase has been carried out When the Software receives a channel command request it 9 checks the validity of the command the sequencing on the channel commands is creation stop destruction 9 puts the request in a queue and when the software is activated it makes the following processing If the request is invalid a report will be immediately returned If the request is a stop request it stops the channel whose reference is given in the command is stopped the message send reception is stopped If the command is a destruction command the channel whose reference is given in the command is destructed The user receives the confirmation of his request via the callback procedure given during the configuration of the MCS instance 2 1 Channel configuration The creation request contains the channel configuration parameters Each channel is configured for connection to 9 either a MICROFIP type station 9 ora FULLFIP2 type station The message size that can be sent or received on these channels will be configured for each channel The remote station connected to the channel must have the same value All the MCS channels have the following properties 9 type A DATA MCS channels point to point with PDU acknowledgement 9 anticipation 1 9 number of repetitions 1 Page 2 6 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Description of functions Each MCS channel has the following characterist
35. ncatenate the whole message on his own system To do this he must allocate a contiguous zone on his system the size of which is given in the received message structure He then calls the primitive mcs cat msg received 3 When the user has received the message he must call the primitive mcs free received message in order to release the resources used for message reception error messages Page 4 4 SEGMENT FDM Version 1 Software user manual ALS 53331 b en 1 CODE MCS ERROR CODE LIST This Chapter J Error messages code is a list It is used 9 either in the immediate procedure report gt reported by CR in the following table 9 orinthe warning or error procedures Extern Signal Error Extern Signal Warning gt reported by E in the following table gt reported by W in the following table E W Value Mnemonic Context CR 0 _MCS_NOK Indicates requested operation successful 1 _MCS_NOK Indicates error in requested operation 2 _MCS_INTERNAL_ERROR Internal Software error SERIOUS E _MCS_CREATE_xxx faults Error detected during procedure mcs initialize Ox10 _ CREATE ILLEGAL PARAMETER Illegal input parameter CR 0 11 _MCS_CREATE_ALLOCATE_MEMORY_FAULT Memory allocation problem CR 0x12 MCS_CREATE_CREATE_SEMAPHORE_FAULT Semaphore creation problem CR _MCS_CHANNEL_CREATE_xxx faults Error detected during procedur
36. not valid WwW Note 1 Size 0 or size gt Max_SDU_size configured CR for the channel 0x106 MCS_SEND_DATA_DLL_FAIL Cause Error during transfer to DLL layer in Report field see callback procedure User_msg_ack _MCS_ RECEIVE xxx faults Errors detected at message reception by DLL layer 0x200 MCS_RECEIVE_DLL_ON_INEXISTING_CHANNEL This error is indicated in Extern_Signal_error Note 2 Problem with MCS channel reference 0x201 MCS_RECEIVE_DLL_ON_IDLE_CHANNEL This error is indicated in WwW Note 2 Extern_Signal_warning Problem with MCS channel reference the reference exists but the MCS channel is not in a normal state 0x203 MCS_RECEIVE_DLL_INVALID_PDU This error is indicated in WwW Note 2 Extern_Signal_warning Reporting an error in PDU MCS 0x204 MCS_RECEIVE_DLL_BROKEN_MESSAGE This error is indicated in Extern_Signal_error E Note 2 Reporting incorrect message received from DLL MCS CHANNEL CONNECTED xxx faults Errors 0x400 _MCS_CHANNEL_CONNECTED_LACK_OF_MEMORY_FOR_ Problem with allocating memory resources at W Note 5 USER_IND message reception by DLL layer _MCS_SEND_DLL_xxx faults Errors detected at frame transmission part of SDU on the DLL layer These warnings are associated with MCS_SEND_DATA_DLL_FAIL 0x500 MCS_SEND_DLL_ON_INEXISTING_CHANNEL the FIP message channel does not exist we W Note 5 are sending on a periodic channel which was not created by fdm create canal 0x501 MCS SEND DLL ON IMAGE2 The message system is not configu
37. o Page A 2 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Example libsegmentfdm a c opt SRC_OBJ Grm f libsegmentfdm a LIB LIBOPTS libsegmentfdm a OBJ DIR mcs user o LIB LIBOPTS libsegmentfdm a OBJ_DIR mesconfi o LIB LIBOPTS libsegmentfdm a OBJ_DIR mcsheart o LIB LIBOPTS libsegmentfdm a OBJ_DIR mcstools o LIB LIBOPTS libsegmentfdm a OBJ DIR mcs os o rm f opt OBJ_DIR mes_user o mcs_user c HEADERS makefile CC COPTS o OBJ DIR mcs user o mcs user c OBJ DIR mcsconfi o mcsconfi c HEADERS makefile CC COPTS o OBJ_DIR mesconfi o mcsconfi c ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page A 3 Example OBJ_DIR mcsheart o mcsheart c HEADERS makefile CC COPTS o OBJ DIR mcsheart o mcsheart c 0 DIR mcstools o mcstools c V HEADERS makefile CC COPTS o OBJ_DIR mcstools o mcstools c OBJ DIR mcs 05 0 mcs os c HEADERS makefile CC COPTS o OBJ_DIR mcs_os o mcs os c Utility targets c opt Build the C Compiler options file from macros c opt makefile echo COPTS FILE gt c opt echo COPTS FILE2 gt gt c opt echo COPTS_FILE3 gt gt c opt echo INC gt gt c opt Page A 4 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Example dirs pmkdir OBJ_DIR ALS 53331 b en SEGMENT_FDM Version 1 Software use
38. or the aperiodic message system to work you must periodically circulate the identifier associated with production of the MPS variable with authorisation and an aperiodic message window of correct size is required ID DAT identifier no BA part for use with a MICROFIP HANDLER Station So that the messages are accepted by MICROFIP HANDLER station the ID MSG O6xy must be circulated where xy station physical address with each station having a different physical address ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 4 5 Software initialisation 4 INITIALISE THE SOFTWARE AND CONFIGURE THE MCS CHANNELS The Software is initialised when the operator calls the function mcs initialize Once the action described above has been carried out the services are available in other words the USER can 9 ask to command channels 9 whena channel is running after acknowledgement of create channel command ask to send a message on a running channel receive messages and message sent confirmations on a running channel 9 when the user wants to stop and delete a channel he must check that no send or receive message is running Sequence to be followed by the user when receiving a message 1 The user is warned of message reception when the call back procedure User Msg Rec Proc associated with the context is called 2 The user then analyses the message received the message being in the form of n blocks He can co
39. plex_create fdm_change _messaging_ acknowledge_type fdm_messaging_ delete When configuring the channels it also calls on fdm messaging fullduplex create fdm messaging delete fdm change messaging acknowledge type fdm msg send message fdm msg ref buffer free and fdm msg ref data buffer free Page 1 6 SEGMENT FDM Version 1 Software user manual fdm msg data _ buffer free fdm msg ref buffer free FDM R4 creation of message context for sending and receiving destruction of message context modification of the messaging acknowledgement type for sending it calls on for reception it calls on ALS 53331 b en General Presentation 5 PRESENTATION OF THE INTERFACE WITH THE OPERATING ENVIRONMENT The operating environment interface is the same as that described for FDM R4 see manual ALS 50278 chapter 1 Section 4 Overview of interface with operating environment The user must therefore carry out the actions requested for FDM R4 The OS related procedures described by FDM R4 and used by the Software are as follows OS Enter Region OS Leave Region OS semaphore take OS semaphore release The Software also uses binary semaphore The user must therefore write the semaphore create and delete procedures OS BinarySemaphoreCreate and OS Semaphore Delete ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 1 7 General Presentation Page 1
40. r manual Page A 5 Example Page A 6 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en A_DATA A_UNIDATA DLL Frame FDM R4 Frame LSAP MCS MCS Channel MFHD PDU ALS 53331 b en Glossary Data transfer service using the MCS protocol based on a connection established beforehand This service allows reliable transfer of data units of a size which can exceed the size of a link message segmentation assembly repetition anti duplication mechanisms Data transfer service using the MCS protocol not based on any connection This service allows unreliable transfer of data units of a size not exceeding the link message size These transfers can be acknowledged if the user so wishes Protocol data which can be carried in a single FIP message FIP DEVICE MANAGER R4 Software Data unit sent over the physical layer Link Service Access Point Data link access point enabling WorldFIP messages to be sent and or received The LSAP can be compared to the FDM message context implemented in FIP DEVICE MANAGER Messaging Common Services The Software implements these services The MCS channel is the operating context allowing MCS messages to be sent and or received In the light version the configured channel carries out the transfers using the A DATA protocol MICROFIP HANDLER software This software can only be used for the MICROFIP component and in particular implements the services of the WorldFIP message sys
41. red on WwW Note 5 IMAGE and we are asking to send on this image 0x502 _MCS_SEND_DLL_INTERNAL_ERROR Internal error detected in the frame sent on W Note 5 DLL layer data size 0 0x503 MCS SEND DLL UNKNOWN ERROR Unknown error detected in frame sent on W Note 5 DLL layer Page 5 2 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Error messages Reminder Procedures Extern Signal Error and Extern Signal Warning include parameters and P2 see chapter dealing with Primitives to be supplied by the user procedure prototypes The error codes above are associated with parameters P1 P2 defined in the following notes Note Parameter P1 List Parameter P2 MCS TYPE ERROR WARNING Pointer to 1 TYPE SDU TO SEND MCS 8 0 TO SEND 2 FDM MSG RECEIVED FDM MSG RECEIVED 3 MCS TYPE FDM MSG TO SEND FDM MSG TO SEND 4 TYPE FDM MSG TO SEND FDM MSG TO SEND 5 MCS TYPE MCS CHANNEL REF CHANNEL REF Note 1 MCS TYPE MCS SDU TO SEND This type is used in Extern Signal Error or Extern Signal Warning following calling of procedure mcs send message as well as in its immediate report It indicates an error on input parameter MCS CHANNEL REF for this procedure Note2 MCS TYPE FDM MSG RECEIVED This type is used in Extern Signal Error or Extern Signal Warning following processing of an indication fro
42. resentation 1 1 GENERAL SOFTWARE DESCRIPTION The role of the Software is to enable messages of any size to be transferred on the WorldFIP network It is responsible for breaking down the message into a size compatible with that of the frames in the WorldFIP data link layer and for reassembling them at the receiver It is designed to be run on embedded targets equipped with the FULLFIP2 communication component It is delivered in the form of a library of primitives to be linked with the user application and the FIP DEVICE MANAGER R4 software Itis written in C ANSI and developed regardless of its operating context user application operating environment SEGMENT FDM Rel 1 FIP DEVICE MANAGER R4 ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 1 1 General Presentation The Software offers an interface for the users of a station wishing to exchange messages with another subscriber The messages exchanged are larger than those which can be transmitted in a frame Subscriber X Subscriber Y Subscriber Z SEGMENT_FDM SEGMENT_FDM FULLFIP2 FULLFIP2 SEGMENT_MICROFIP MICROFIPHANDLER MICROFIP WorldFIP Network The message frames on the WorldFIP network differ according to the type of subscriber connected 9 for a connection to a subscriber FULLFIP2 the frame is 256 bytes 9 connection to a subscriber on MICROFIP the frame is 122 bytes Page 1 2 SEGMENT FDM Vers
43. s needed for operation of the FDM R4 see manual ALS 50278 chapter 1 Section 4 Overview of interface with user application 9 creation of the FDM device 9 creation and start up of the network by correctly configuring all the message related information 9 management of internal timeouts 9 activation of message transmission function 9 activation of message reception function 2 1 Use of the Periodic Message system For FDM we use periodic channel No 1 So that the periodic message system works you must declare the WorldFIP identifier one identifier per station used for this channel The declaration procedure is an FDM R4 user function fdm channel create See condition on the BA to ensure that the periodic message system works 2 2 Use of the Aperiodic Message system The channel used for aperiodic messages is channel 0 So that the aperiodic message system works the station must produce at least one MPS variable with message request authorisation see FDM R4 See condition on the BA to ensure that the aperiodic message system works Page 4 2 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Software initialisation 3 RUNAN APPROPRIATE BUS ARBITER PROGRAM BA for the periodic message system For the periodic message system to work you must periodically circulate the identifier of the periodic channel of each station ID MSG identifier No For the aperiodic message system F
44. tem data link layer Protocol Data Unit SEGMENT FDM Version 1 Software user manual Gloss 1 Glossary Gloss 2 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en
45. ter NULL if creation was impossible the error code is then set in the report parameter Definition of type MCS REF Software internal not handled by the user 1 3 Procedure mcs fifo empty Overview Activation of the void MCS fifos task after general initialisation mcs initialize This activation should be triggered when the user has received the signal via the Extern signal MCS procedure Prototype void mes fifos empty MCS REF Mcs Description This function enables the user to activate a command channel for which the request was transmitted by the primitive mcs channel command to activate sending of a message on a channel for which the request was transmitted by the primitive mcs send message to identify the message sent acknowledgement with the Software activating user procedure User Msg Ack to identify the messages received with the Software activating user procedure User Msg Rec Proc User Msg Ack user procedure to acknowledge transmission on a channel User Msg Rec Proc user procedure for reception of message on a channel User Msg Ack User Msg Rec Proc two procedures given by the user in creation command channel Page 3 4 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives Input parameters Mcs pointer to the reference of type MCS_REF This is the pointer which was supplied during the initialisation procedure mcs_initialize Output paramet
46. unsigned short Nr Of Bytes unsigned char Ptr Data struct DESC BLOCK DATA R Next Block Nr Of Bytes number of bytes contained in the block pointed by Ptr Data Ptr Data pointer to the zone containing the data received Next Block Pointer to the next block of the same type Output parameters None 1 8 Procedure mcs cat msg Prototype void mcs cat msg received char ptr data user MCS SDU RECEIVED msg Description This procedure is a user help procedure When the user receives a message it is of the type MCS SDU RECEIVED this type consists of a set of x description buffers This procedure enables the user to reconcatenate all the data into a single block on his own system Page 3 14 SEGMENT FDM Version 1 Software user manual ALS 53331 b en Primitives Input parameters ptr data user pointer to a buffer that the user must allocate The user knows the size to be allocated for this buffer that given in field SDU Size of MCS SDU RECEIVED msg pointer to received message to be concatenated of type MCS SDU RECEIVED Output parameters None 1 9 Primitives called to be supplied by the user Summary of procedures to be written by the user and called by the Software to inform the user of various events The user can change the following procedure names PROCEDURE Reference sent to the Software by called Mt Extern_Signal_Error mcs initialize in parameter of type detection of serious errors
47. ured see COMPILATION PARAMETER chapter of manual ALS 50278 File mes opt h should not be modified unless you wish to use the SOFTWARE on a Windows NT PC see appendix case of FDM NT ALS 53331 b en SEGMENT FDM Version 1 Software user manual Page 6 5 Installation procedures Page 6 4 SEGMENT_FDM Version 1 Software user manual ALS 53331 b en Appendix Example A EXAMPLE OF SEGMENT FDM SOFTWARE MAKEFILE FOR PSOS MAKEFILE PSS_ROOT home robin SEGMENT_FDM psos pssmcf include PSS_ROOT bsps ut5307 bsp mk HEADERS mcs_opt h mcsprive h mcspriv2 h mcs h mcs_os h OBJ DIR obj SRC_OBJ c opt OBJ_DIR mes_user o OBJ DIR mcsconfi o OBJ_DIR mcsheart o V OBJ DIR mcstools o OBJ DIR mcs os o COPTS c opt ALS 53331 b en SEGMENT_FDM Version 1 Software user manual Page A I Example CC dplus INC I I I PSS_ROOT include I PSS_ROOT bsps devices fdm COPTS_FILE1 c g D__DIAB Xsmall const 0 Xsmall data 0 DBSP CACHE ENABLE COPTS FILE2 t CPU F DFP psos Xansi Xstrings in text COPTS_FILE3 Xstrict ansi LIB dar LIBOPTS q SUR Mur dE M MM Mc t Primary targets all Build libsegmentfdm a default clean Clean object directory amp intermedate files new Same as clean with the addition all libsegmentfdm a clean rm f opt rm f obj o new rm f libsegmentfdm a rm f opt rm f obj

SEGMENT_FDM Version 1 Software user manual

Contents

Download Pdf Manuals

Related Search

Related Contents