1. Manuals
  2. Brands
  3. Aim Manuals
  4. Control Unit
  5. AFDX / ARINC 664
  6. Reference manual

Aim AFDX / ARINC 664 Reference Manual

Interface module
Hide thumbs
Table of Contents

Advertisement

Quick Links

reference manual
AFDX / ARINC 664
Interface Module
AIM GmbH
Sasbacher Str. 2
79111 Freiburg, Germany
Tel: +49-761-45229-0
Fax: +49-761-45229-33
sales@aim-online.com
www.aim-online.com
May 2011
V16.3x Rev. A

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the AFDX / ARINC 664 and is the answer not in the manual?

Questions and answers

Related Manuals for Aim AFDX / ARINC 664

Summary of Contents for Aim AFDX / ARINC 664

  • Page 1 AFDX / ARINC 664 Interface Module AIM GmbH Sasbacher Str. 2 79111 Freiburg, Germany Tel: +49-761-45229-0 Fax: +49-761-45229-33 sales@aim-online.com www.aim-online.com May 2011 V16.3x Rev. A...
  • Page 3 Reference Manual API-FDX-2 AyC-FDX-2 fdxTap APX-GNET-2/4 APU-FDX-2 Application Interface Library V16.3x Rev. A May 2011 AIM No. 60-15900-36-163X-A...
  • Page 4 Notice: The information that is provided in this document is believed to be accurate. No responsibility is assumed by AIM for its use. No license or rights are granted by implication in connection therewith. Specifications are subject to change without notice.
  • Page 5 The following table defines the history of this document. Section 6 provides a more comprehensive list of changes made with each version. Version Cover Date Created by Description 0.1 Preliminary 12.09.2001 R. Heitzmann See Section 6 for details 0.2 Preliminary 14.09.2001 J.
  • Page 6 14.0x A 03.21.2006 T. Troshynski See Section 6 for details 14.0x B 07.07.2006 T.Troshynski See Section 6 for details 14.1x A 07.21.2006 T.Troshynski See Section 6 for details 14.2x A 08.21.2006 T. Troshysnki See Section 6 for details 14.3x A 15.09.2006 R.

  • Page 7: Table Of Contents

    Table of Contents 1.1 General........................1 1.2 Applicable Documents..................2 2.1 AFDX Software Structure ..................3 2.2 Hardware Structure ....................4 2.3 Client-Server Structure in a Network Environment (Windows Environment)......................5 2.4 Host-to-Target Communication................6 3.1 General........................7 3.2 Platform VME ......................8 3.3 Error Reporting.....................
  • Page 8 4.1.2.2 AiFdxAviInitVmeInt ................... 31 4.1.2.3 AiFdxModuleCheck .................. 33 4.1.2.4 AviFdxVMEBoardIni ................. 34 4.2 System Functions (Board level functions)............35 4.2.1 FdxCmdBITETransfer ..................36 4.2.2 FdxCmdBoardControl..................37 4.2.3 FdxCmdIrigTimeControl ................. 42 4.2.4 FdxCmdStrobeTriggerLine ................44 4.2.5 FdxReadBSPVersion ..................45 4.3 Transmitter Functions ..................48 4.3.1 Global Transmitter Functions .................
  • Page 9 4.3.3.9 FdxCmdTxUDPCreatePort ..............101 4.3.3.10 FdxCmdTxUDPDestroyPort ..............104 4.3.3.11 FdxCmdTxUDPWrite ................105 4.3.3.12 FdxCmdTxUDPGetStatus ..............107 4.3.3.13 FdxCmdTxUDPWriteIndexed ............... 108 4.3.3.14 FdxCmdTxVLWrite ................110 4.3.3.15 FdxCmdTxVLWriteEx ................112 4.3.4 Data Buffer Functions................... 116 4.3.4.1 FdxCmdTxBufferQueueAlloc..............116 4.3.4.2 FdxCmdTxBufferQueueFree ..............119 4.3.4.3 FdxCmdTxBufferQueueRead ..............
  • Page 10 4.4.2.4 FdxCmdRxUDPBlockRead..............167 4.4.2.5 FdxCmdRxUDPControl ................169 4.4.2.6 FdxCmdRxUDPChgDestPort ..............171 4.4.2.7 FdxCmdRxUDPCreatePort..............172 4.4.2.8 FdxCmdRxUDPDestroyPort ..............174 4.4.2.9 FdxCmdRxUDPGetStatus ..............175 4.4.2.10 FdxCmdRxUDPRead ................176 4.4.3 Chronological Monitor .................. 179 4.4.3.1 FdxCmdMonCaptureControl..............179 4.4.3.2 FdxCmdMonGetStatus ................181 4.4.3.3 FdxCmdMonQueueControl..............183 4.4.3.4 FdxCmdMonQueueRead................
  • Page 11 4.5.10 FdxSkipRecFileHeader ................226 5.1 Abbreviations ....................227 5.2 Definition of Terms................... 229 6.1 Modification Function List compared with previous versions ..... 231 6.1.1 Library Administration Functions ..............231 6.1.2 VME Initialization Functions ................. 231 6.1.3 System Functions..................231 6.1.4 Transmitter Functions................... 232 6.1.5 Receiver Functions..................
  • Page 12 List of Tables Table 3.5.2-I: Necessary Application Interface Level Files ..............10 Table 3.5.3-I: Necessary System Level Driver Files ................10 Table 4.1-I: Library Administration Functions.................. 11 Table 4.2-I: System Functions......................35 Table 4.3-I: Transmitter Functions ....................49 Table 4.4-I: Receiver Functions ....................

  • Page 13: Introduction

    (XP and newer). All other systems, e.g. embedded VME with VxWorks, LINUX, LynxOS etc. currently support ‘local’ servers. The AIM AFDX High Level Application Interface for PCI and cPCI is available as Dynamic Link Libraries (DLLs) for the platforms mentioned above (Microsoft compatible). The AFDX High Level Application Interface DLL can be used by each programming tool having the capability of interfacing DLLs (32-Bit).

  • Page 14: Applicable Documents

    AFDX Switch Detailed Functional Specification AIRBUS Issue: 2.0, Date: 14/09/2001, REF.:515.0519/2001 AIM Reference Manual “VME Generic Interface Library” AFDX Programmer’s Guide AFDX Getting Started for Windows AFDX Getting Started for Linux Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 15: Software And Hardware Structure

    - monitor software AFDX ASP - LCA-Boot Driver Software software UART / HW init (running on MIPS ID T-R4640) AFDX BIU Firmware (running on BIP Strong ARM) Board Hardware / AFDX specific Hardware Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 16: Hardware Structure

    Shared between BIU, ASP and PCI bus Local ASP RAM Bank 0 used for ASP local programs (ASP Driver Software, Monitor) Bank 1 used as Shared RAM area for Host-to-Target communication Flash-PROM Board Configuration Memory Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 17: Client-Server Structure In A Network Environment (Windows Environment)

    To access the hardware from a client it is necessary to run the AIM Network Server (ANS) on the Server computer.  The computer which contains the application software acts as Client. A client does not require ACI-FDX hardware.

  • Page 18: Host-To-Target Communication

    Acknowledge Array (receive Message) from the FDX Target Software. Figure 2.4-1: Host-to-Target Communication Shared RAM Target Communication relative Byte Address 00001F00h Target Communication Control Register Area 00002000h Command Array Area 00042000h Acknowledge Array Area 00082000h Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 19: Application Interfacing

    This function performs a cleanup of the specified FDX device and must be called as the last function to shut-down communication for the specified resource. After calling this function, the handle is invalid and it is not possible to use it for further function calls. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 20: Platform Vme

    To map the memory of the module the following shall be used (Not contained in this document. Please refer to Applicable documents [4]): AiVMEMemoryMap() To initialize an AIM-FDX-VME module (initialize a shared memory area for host-to-target communication.) the following function shall be called: AviFdxVMEBoardIni(ul_VMEModuleId)

  • Page 21: Error Reporting

    Big Endian Systems. Additional define, for using cPCI under VxWorks. _AIM_CPCI_VXWORKS e.g. AmcFdx on ACC carrier. When using the Library in embedded VME environment, or LINUX the source code is provided. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 22: Files Of The Fdx High Level Interface

    Library, using “smem_create(..)” system function for getting User Level access to the VMEbus A16 and A32 areas. Future versions may use a LynxOS Device Driver, whereby this is transparent for the Library User. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 23: Function Reference

    Initializes the ACI-FDX cPCI or AMC-FDX PMC module. Returns the AviFdxVMEBoardIni module handle for future API function calls AiFdxModuleCheck Determines whether the AIM board is an ACI-FDX or AMC-FDX module Configures the board's interrupt level and vector # and defines the pointer to AiFdxAviInitVmeInt the Interrupt Routine...

  • Page 24: Platform Independent Functions

    Uninstalls an user interrupt handler function, which has been installed previously with the function "FdxInstIntHandler". Input: Interrupt Type Defines the type of interrupt which will be uninstalled for the given AIM board. Output: None Return Value Returns FDX_OK on success or a negative error code on error.

  • Page 25: Fdxinit

    This function initialises the entire application interface and must be called at first in an application program, before any other function is applied. This function returns a list of computer names of the network environment, where the ANS (AIM network server) is running and FDX boards are available to work with.
  • Page 26 Section 4 – Function Reference: Library Administration Functions Element, which identifies the type of this structure (see FdxCmdFreeMemory) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 27: Fdxinstinthandler

    TY_FDX_INTR_LOGLIST_ENTRY x_Info ); The interrupt function will receive the following parameters, which identify exactly the type of interrupt. Module Number of the AIM board that generated the interrupt. Port Number of the AIM board that generated the interrupt. Value Description...
  • Page 28 Section 4 – Function Reference: Library Administration Functions Interrupt type as defined in parameter "uc_Type" above. Contains the type of interrupt that the AIM board has generated. Contains detailed information about the cause of the interrupt. typedef struct TY_LOGLIST_1_ENTRY x_LWordA;...
  • Page 29 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 FDX_INT_RX Trigger Control Block Index FDX_INT_RX Admin Structure Pointer (shared RAM) for Continuous Capture FDX_INT_TX Reserved Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 30 Buffer Full event or the Half Buffer Full event. In Monitor Standard or selective Capture Mode only the Buffer Full event may assert an Interrupt (RX/MN) Monitor Start Interrupt Logical ‘1’: This interrupt is asserted due to Monitor Start Trigger Event (MN) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 31 Interrupt Loglist Event, Entry Word 5 TYPE Bit 31 Bit 0 FDX_INT_TX Time Tag High FDX_INT_RX FDX_INT_RX AiUInt32 Interrupt Loglist Event, Entry Word 6 TYPE Bit 31 Bit 0 FDX_INT_TX Time Tag Low FDX_INT_RX FDX_INT_RX Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 32 Word ul_LWordE and ul_LWordF are extensions to get timing information for transmitted frames. Both words together are equal to structure TY_FDX_FW_IRIG_TIME. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 33: Fdxlogin

    Description "local" Local use of the board <SrvName> Name of the PC, where the ANS Server (AIM Network Server) is running (e.g. “\\SW-PC-06” or “192.168.0.119”) const TY_FDX_CLIENT_INFO *px_ClientInfo Pointer to an information structure about the calling client, describing the client application and the client computer environment.
  • Page 34 Ethernet port for port functionality. This handle is necessary for all future calls to this resource. If login to a resource fails, this handle will be NULL. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 35: Fdxlogout

    Input None Output None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 36: Fdxqueryresource

    Value Constant Description "local" Local use of the board <SrvName> Name of the PC, where the ANS Server (AIM Network Server) is running (e.g. “\\SW-PC-06” or “192.168.0.119”) Resource ID for this resource, returned by FdxQueryServerConfig(...). Output void *px_ResourceInfo Pointer to a pointer of a resource information. Dependent on the input resource ID...
  • Page 37 Single Mode FDX_REDUNDANT Redundant Mode Element, which identifies the type of this structure (see FdxCmdFreeMemory) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 38: Fdxinstallserverconfigcallback

    Pointer of a list of resources as described for the function FdxQueryServerConfig. This list contains the resources of the added/removed device. In case of removing a device, the struct contains only the ResourceId of the related resources. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 39: Fdxqueryserverconfig

    Note: The callbackfunction of the Application may not free the memory of px_ResourceList recommended FdxQueryServerConfig function call. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 40 If a valid ANS Server is found on specified PC the function connects to that server and returns a list of available resources of that PC. Input: AiChar ac_SrvName Name of the PC, where the ANS (AIM Network Server) Server is running. Value Constant Description "local"...
  • Page 41 “FDX Port X”, where X represents the number of the port (1..4). Element, which identifies the type of this structure (see FdxCmdFreeMemory) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 42: Aifdxavidelvmeint

    AiInt16 AiFdxAviDelVmeInt (AiUInt32 ul_Handle, AiUInt8 type, AiUInt8 level, AiUInt8 vector, FDX_INTERRUPT_SET_FUNC *intSetFunction); none This function disconnects the interrupt system on the host system with the AIM board interrupt and the VME interrupt. This function must be called before close if an initialize interrupt function (AiFdxAviInitVmeInt) was applied.

  • Page 43: Aifdxaviinitvmeint

    The parameter ‘*intFuntion’ from the type FDX_VOID_FUNC is the function pointer which should be called in case of interrupt. This function is a driver internal interrupt function which handles the hardware interrupt on the AIM board and distributes control to the user interrupt function.
  • Page 44 FDX_INTERRUPT_FUNC(AiUInt8 uc_Module, AiUInt8 uc_Biu, AiUInt8 uc_Type, TY_FDX_INTR_LOGLIST_ENTRY x_Info ) further information regarding FdxInstIntHandler FDX_INTERRUPT_FUNC parameter requirements. Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 45: Aifdxmodulecheck

    Section 4 – Function Reference: Library Administration Functions AiReturn AiFdxModuleCheck(AiUInt32 ul_ModuleId); This Function checks the specified module to determine if it is an AIM ACI-FDX or AMC-FDX module. Module identifier returned in Module List (ppx_VMEModulenfoList) by function AiVMEModuleListBuild(). none Returns FDX_OK for an AIM ACI-FDX or AMC-FDX module.

  • Page 46: Avifdxvmeboardini

    For these functions refer to document VME Generic Interface Library [5]. Module identifier returned in Module List (ppx_VMEModulenfoList) by function AiVMEModuleListBuild(). none Returns 0 or higher on success or a negative error code on error. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 47: System Functions (Board Level Functions)

    Reads and writes the onboard IRIG Time FdxCmdStrobeTriggerLine Provides a trigger output strobe on system command. FdxReadBSPVersion Reads version numbers board software package components. FdxCmdBITETransfer Performs transfer tests using available port resources of one FDX board. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 48 For this version there is only “local” operation of the resources supported. This function will operate only with local available resources. Input AiChar ac_SrvName Name of the PC, where the ANS (AIM Network Server) Server is running. Value Constant Description "local"...

  • Page 49: Fdxcmdboardcontrol

    Driver Command: FDX_SYS_BOARD_CONTROL (0x00008030) Purpose: This function is used to control the global settings of the board. For the AIM-FDX board this means the organization of the physical ports to logical single or redundant ports. Input: AiUInt32 ul_Control Control the consequence of this function.
  • Page 50 Verification Register defined by customer The AIM AFDX board has the capability to check specified filds inside the MAC and IP header against constant values. By violation of this check a MAC or IP Error will be reported with this frame.

  • Page 51: Figure 4.2.2.1 Rx Verification Data And Mask

    Type Version / IHL Type of Service Total Length Fragment ID 0XXXXXXXb Control Flag / Frag Offset Time to live Protocol Header Checksum Constant Network ID Equipment ID Partition ID 000XXXXXb Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 52 Otherwise, it can be a combination of the following options: Value Description FDX_DISA_GHOST Disable Ghost Frames. Frames containing more than four physical errors or no valid SFD (start frame delimiter) are silently discarded while capturing. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 53 Size of Shared Memory (in Bytes) which is not already allocated. AiUInt32 ul_RxVeriMode Rx error verification mode which is used by the Board Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 54: Fdxcmdirigtimecontrol

    If the IRIG output of a board is used to synchronize several boards to the same IRIG Time, this signal shall be routed also to the own external IRIG input. This is necessary to eliminate the time shift between IRIG encoder and decoder. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 55 Runs with internal IRIG Time but got no synchronisation These modes can only be seen with APX-GNET. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 56: Fdxcmdstrobetriggerline

    Values from 0 to 3 are possible for this parameter to select the corresponding Trigger Output lines 1 to 4. Output None. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 57: Fdxreadbspversion

    TY_VER_NO x_TcpVer; TY_VER_NO x_Bootstrap; TY_VER_NO x_Monitor; TY_VER_NO x_TargetOS; AiUInt32 ul_BspCompatibility; } TY_FDX_BSP_VERSION; TY_VER_NO x_SysDrvVer Version Information of the Board System Level Driver TY_VER_NO x_DllVer Version Information of the Application Interface Library Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 58 TCP Revision Information Bootsrap Revision Information (Only relevant for APX-GNET) Onboard Monitor Software Revision Information (Only relevant for APX-GNET) Onboard Target Operating System Revision Information (At the moment only relevant for APX-GNET) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 59 Section 4 – Function Reference: System Functions AiUInt32 ul_BspCompatibility Compatibility Status of the current BSP (AIM Board Software Package) components relating to the Library Value Description FDX_BSP_COMPATIBLE BSP components are compatible. FDX_BSP_WRONG_SYS_W98_W2000_WXP_SWThe system driver for Windows 98 / 2000 / XP is not compatible with the DLL.

  • Page 60: Transmitter Functions

    The message size can be different for each data package up to a defined maximum. The data package will be sent one time without any repetition. The following sections of function descriptions are reflecting these modes. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 61: Global Transmitter Functions

    Write Data from Transmit Buffer Queue FdxCmdTxBufferQueueCtrl Controls a Transmit Buffer Queue Generic Transmitter Sub-Queue Functions FdxCmdTxSubQueueCreate Allocate Transmit Data Buffer Queue FdxCmdTxSubQueueDelete Free Transmit Buffer Queue FdxCmdTxSubQueueWrite Reads Data from Transmit Buffer Queue Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 62 In Individual Transmission Mode, this parameter is not used. Absolute IRIG time to start the transmitter. This structure is only applicable with the Start Mode FDX_START_TIME. The specified start time must be located in future. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 63 Transmission Time Duration for the extended Stop Mode FDX_ESTOP_TIME. The time duration must be defined in ms. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 64 Replay is not available if the port has been configured for redundant operation AiUInt32 ul_RerosPortDelay Reserved Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 65 This is a user definable byte for identification. Note: This function can only be done by a privileged user! Output: TY_FDX_PORT_INIT_OUT* px_PortInitOut typedef struct { AiUInt32 ul_PortConfig; AiUInt32 ul_PortUsed; AiUInt32 ul_GlobalMemFree; AiUInt32 ul_SharedMemFree; } TY_FDX_PORT_INIT_OUT; Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 66 Size of Global Memory (in Bytes) which is not already allocated. AiUInt32 ul_SharedMemFree Size of Shared Memory (in Bytes) which is not already allocated. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 67 // IP Control AiUInt16 uw_IPFrag; // IP Fragment ID AiUInt16 uw_IPTotalLength; // IP total Length AiUInt16 uw_IPFragOffs; // IP Fragment. Offset AiUInt16 uw_IPHeaderChkSum; // IP Header Checksum AiUInt32 ul_IPDest; // IP Destination Address Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 68 // UDP Length AiUInt8 uc_UDPPayload[22] // 22 Bytes of UDP Payload } TY_FDX_TX_STATIC_REGS_UDP; Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 69: Fdxcmdtxstatus

    The mode in which the transmitter is set up. (Refer also to function FdxCmdTxModeControl parameter ul_TransmitMode.) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 70: Fdxcmdtxtrglinecontrol

    Trigger Line 2 FDX_STROBE_LINE_3 Trigger Line 3 FDX_STROBE_LINE_4 Trigger Line 4 FDX_STROBE_LINE_KEEP Keep current setting Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 71: Fdxcmdtxvlcontrol

    FDX_DIS Virtual Link is disabled. All frames for the given VLs are discarded. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 72: Fdxcmdtxqueuecreate

    Defines the size of the Queue in Byte. This means the memory which is allocated in BIU associated memory. If this value is set to zero, a internal default queue size will be selected. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 73 This parameter returns the real size of the transmit queue. This parameter returns the Queue Base Address on Target Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 74: Fdxcmdtxqueuestatus

    AiUInt32 ul_FramesSent; AiUInt32 ul_FramesInCycQueue; } TY_FDX_TX_QUEUE_STATUS; An enumerated value, which describes the state of the generic transmit queue typedef enum fdx_que_status { FDX_QUE_EMPTY, FDX_QUE_FILLED, FDX_QUE_FULL, FDX_QUE_SENT, FDX_QUE_CYCL_RUN, FDX_QUE_CYCL_SENT, FDX_QUE_RP_UNDERRUN } TY_FDX_E_TX_QUE_STATUS; Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 75 If the queue is configured in cyclic mode, this value shows the number of frames written to the queue. Note: This value is only valid in Generic Transmission Mode Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 76: Fdxcmdtxqueueupdate

    AiUInt32 ul_ If ul_SubQueueHandle is unequal to 0 it indicates that the Transfer which shall be controlled is located in a Transmitter SubQueue. A value of 0 indicates the Main TransferQueue Handle Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 77 Section 4 – Function Reference: Transmitter Functions A pointer to byte buffer, where the new data is located. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 78 Not applicable FDX_TX_INDIVIDUAL At the moment only a count of 1 is suported FDX_TX_FIFO Number of Entries to write AiUInt32 ul_WriteBytes Number of bytes that shall be written to the queue. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 79 PHY, PRE, TRI, CRC, IFG, SFD. The following error types are tolerated and will be replayed: IPE, MAE, LNG (up to frame length of 2000 bytes), SHR (from frame length of 40 bytes), VLS, SNE, TNS. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 80 655us (14 Bits are used for encoding). If the Packet group Wait Time is used, this field shall be initialized with zero. This Gap is only used if uc_FrameStartMode is set to FDX_TX_START_FRAME_IFG. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 81 µs. PGWT = T1 IFG = 0 PGWT = 0 IFG = T2 PGWT = 0 IFG = T3 PGWT = T4 IFG = 0 PGWT = TN IFG = 0 Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 82 Note: This mode cannot be selected if a separate buffer queue. Payload Generation Mode different from FDX_TX_FRAME_PGM_USER ul_BufferQueueHandle must contain a valid Buffer Queue has been selected for this frame. handle, previously allocated via the function FdxCmdTxBufferQueueAlloc. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 83 Size of Queue Entry FDX_TX_FRAME_PGM_USER sizeof (TY_FDX_TX_FRAME_HEADER) + uw_FrameSize FDX_TX_FRAME_PGM_IP_PART sizeof (TY_FDX_TX_FRAME_HEADER) + FDX_TX_FRAME_PGM_IP_PART_TT MAC-Header (14 Bytes) + IP-Header (20 Bytes) + UDP-Header (8 Bytes) FDX_TX_FRAME_PGM_IP_FULL sizeof (TY_FDX_TX_FRAME_HEADER) + FDX_TX_FRAME_PGM_IP_FULL_TT MAC-Header (14 Bytes) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 84 FDX_TX_FRAME_PBM_MAC would allow the user to change data associated with this frame during run-time FdxCmdTxBufferQueueWrite FdxCmdTxBufferQueueCtrl functions. Control assertion of Trigger Strobe if this frame is transmitted. See the FdxCmdTxTrgLineCtrl for further information about the Trigger Lines. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 85 Packet transmitted on both Networks (Skew=0) FDX_TX_FRAME_ONLY_A Packet only transmitted on Network A FDX_TX_FRAME_ONLY_B Packet only transmitted on Network B Note: This function is only provided in redundant port operation mode. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 86 Set Sequence Number Offset for this frame (e.g. Error Injection Purposes if invalid values used !) FDX_TX_FRAME_SEQ_OFF Sequence Number handling for this transfer is switched off and used as normal data byte. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 87 Acyclic Instruction. If an Acyclic instruction is defined, it will be scheduled for transmission by reaching this instruction. This marker can be inserted several times in a transfer queue or SubQueue. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 88 Sub Queue. The reason for this limitation is the problem of Sequence numbering. Only the Sub Queue initialized before start of transmitter is taken in account for correct AFDX Sequence numbering. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 89 1 microsenconds. The port, where the delayed frame is transmitted is defined in the Frame Header Word 1.This value is only used, if the Interface is configured in redundant operation mode. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 90 60 bytes are programmed, no proper frame transmission can be guaranteed. Note: Byte Count values less than 40 bytes and more than 2000bytes are not allowed and may be cause unrecoverable transmit operation errors. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 91 AFDX- Frame, if the SND bit is not set. Reserved Reserved Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 92: Fdxcmdtxqueuewrite

    0. If there are commends inserted to the queue, the commands are also numbered. If ul_SubQueueHandle is unequal to 0, ul_Index 0 addresses the first transfer of the SubQueue Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 93 Bits are used for encoding). If the Packet group Wait Time is used, this field shall be initialized with zero. This only used uc_FrameStartMode FDX_TX_START_FRAME_IFG. See also the notes for ul_Skew parameter in redundant mode. This parameter must be initialized if FDX_TX_CTL_PGW is set to ul_ControlType. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 94 This parameter is only applicable for a call to SubQueue Instruction and can only combined with enabling or disabling a SubQueue call instruction The value specifies the index of the next defined SubQueue which shall be called from this instruction. None Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 95 Section 4 – Function Reference: Transmitter Functions Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 96: Fdxcmdtxqueueacyclic

    Layout dependent on ul_HeaderType and uc_FrameType parameter (see following description) AFDX- FRAME data to transmit (dependent on the Payload Buffer and Payload Generation mode, see description below) ( 802.3 defines: 64 to 1518 bytes) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 97 Acyclic inserted frames are not taken in account for correct AFDX Sequence numbering. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 98: Fdxcmdtxcreatevl

    0 to 7.(Source [5]) The bag limits the bandwidth of a VL. Refer also to ul_SamplingRate defined with FdxCmdTxUDPCreatePort. Specifies the maximum length of one MAC-Frames which can by this VL. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 99 FDX_TX_FRAME_DLY_A FDX_TX_FRAME_DLY_B. Note: This function is only provided in redundant port operation mode. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 100: Fdxcmdtxcreatehiresvl

    Possible Values for the BAG are 800usec to 128000usec. The bag limits the bandwidth of a VL. Refer also to ul_SamplingRate defined with FdxCmdTxUDPCreatePort. Specifies the maximum length of one MAC-Frames which can by this VL. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 101 The skew can be programmed with a resolution of 1µs. Range is 0...65535. This parameter only used uc_NetSelect FDX_TX_FRAME_DLY_A FDX_TX_FRAME_DLY_B. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 102: Fdxcmdtxsapblockwrite

    Number of bytes to write to this SAP port. The value must be equal or smaller than ul_MaxMessageSize defined with FdxCmdTxSAPCreatePort(). The UDP destination port for the message The IP destination of the message Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 103 The result of the individual write operation. FDX_OK on success or a negative error code if an error occurs. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 104: Fdxcmdtxsapcreateport

    Sub Virtual Link Identifier (Sub VLs are only relevant in Tx Mode). This value must be in a range from 1 to 4. If Sub VLs are not used, the Sub VL Id equals to 1. Note: Must be consistent with parameter ul_SubVls of function FdxCmdTxCreateVL or FdxCmdTxCreateHiResVL. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 105 Pointer to a structure, which describes the SAP port. typedef struct { AiUInt32 ul_UdpHandle; }TY_FDX_TX_SAP_CREATE_OUT; Handle to the SAP port. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 106: Fdxcmdtxsapwrite

    The IP destination of the message Number of bytes to write to this SAP port. The value must be equal or smaller than ul_MaxMessageSize defined with FdxCmdTxSAPCreatePort(). Pointer to a buffer containing the data to write. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 107 Number of bytes actually written. Might be smaller than ul_ByteCount if SAP buffer is full. (ul_NumBufMessages defined with FdxCmdTxSAPCreatePort) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 108: Fdxcmdtxudpblockwrite

    The handle of the UDP port to which the message shall be written. This may be a handle to either a Queuing or Sampling UDP port. Number of bytes to write to this UDP port. The value must be equal or smaller than ul_MaxMessageSize defined with FdxCmdTxUDPCreatePort(). Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 109 The result of the individual write operation. FDX_OK on success or a negative error code if an error occurs. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 110: Fdxcmdtxudpchgsrcport

    Queuing UDP port. AiUInt32 UdpSrc New source number for UDP port. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 111: Fdxcmdtxudpcontrol

    Packet only transmitted on Network A FDX_TX_FRAME_ONLY_B Packet only transmitted on Network B FDX_TX_FRAME_VL_DEFAULT Use Net preselected setting of the VL Note: This function is only provided in redundant port operation mode. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 112 Number of erroneous MAC Frames to be injected on selected UDP Port. 0xFFFF.FFFF Reserved Refer to parameter ul_PhysErrorInjection of function FdxCmdTxQueueWrite. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 113 Port is a queuing port: Each Message can be represented by one or more MAC Frame. Reassemble will be done in the IP layer. A Message can have a size up to 8kByte. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 114 Sampling Must be equal or smaller than ul_MaxFrameLength – (MAC, IP and UDP) defined in function FdxCmdTxCreateVL or FdxCmdTxCreateHiResVL. Queuing Must be equal or smaller than 8Kbytes (max. UDP message size) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 115 Queuing ports are additional load to the VL and are only transmitted if bandwidth is not fully exhausted by sampling ports. Output: AiUInt32 *pul_UdpHandle Handle to the UDP port. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 116 Input: See description of FdxCmdTxUDPCreatePort and FdxCmdTxSAPCreatePort. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 117 UDP buffer is updated. Queuing The value is equivalent to transmitted UDP message size. Pointer to a buffer containing the data to write. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 118: Fdxcmdtxudpcreateport

    Number of bytes actually written. Might be smaller than ul_ByteCount if UDP buffer full. (Queuing ports ul_NumBufMessages defined with FdxCmdTxUDPCreatePort) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 119: Fdxcmdtxudpgetstatus

    The parameter counts the cycles of processing for the input queue. Counting by switching the index back from last index to 0. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 120: Fdxcmdtxudpwriteindexed

    Index must be in a range of 0 to ul_UdpNumBufMessages -1 of the dedicated Udp Sampling port. Number of bytes which shall be written to the buffer of the UDP port Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 121 Result code for the Buffer described by ul_Index. All these values are accumulated in st_GlobalResultCode Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 122: Fdxcmdtxvlwrite

    1 to 4. If Sub VLs are not used, the Sub VL Id equals to 1. Number of bytes which shall be written to this VL. Pointer to a buffer containing the data to write. The size of this buffer should correspond to ul_ByteCount. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 123 BIU was full, not able to take this frame FDX_ERR Vl is not initialized, or does not exist FDX_ERR SubVl not initialized Data buffer size is defined with function FdxCmdTxCreateVL, parameter ul_FrameBufferSize. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 124: Fdxcmdtxvlwriteex

    { AiUInt32 ul_VlId; AiUInt32 ul_SubVlId; AiUInt32 ul_FrameSize; AiUInt32 ul_InterFrameGap; AiUInt32 ul_Skew; AiUInt32 ul_PhysErrorInjection; AiUInt32 ul_ExternalStrobe; AiUInt32 ul_PreambleCount; AiUInt32 ul_NetSelect; AiUInt32 ul_InterruptControl; AiUInt32 ul_SequenceNumberControl; AiUInt32 ul_Reserved; } TY_FDX_TX_VL_WRITE_FAME_INFO; AiUInt32 ul_VLId Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 125 Control assertion of Trigger Strobe if this frame is transmitted. See the FdxCmdTxTrgLineCtrl for further information about the Trigger Lines. Value: Description: FDX_DIS Disable Trigger Strobe FDX_ENA Assert external Trigger Strobe on transmission of this frame Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 126 MDSN. Sequence Number of frame for ul_SequenceNumberControl mode FDX_TX_FAME_SN_NO. Pointer to a buffer containing the data to write. The size of this buffer should correspond to ul_FrameSize. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 127 < ul_FrameCount Not all frames written to BIU FDX_ERR Vl is not initialized, or does not exist FDX_ERR SubVl not initialized Data buffer size defined with function FdxCmdTxCreateVL FdxCmdTxCreateHiResVL, parameter ul_FrameBufferSize. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 128: Fdxcmdtxbufferqueuealloc

    The maximum number of buffers in a queue is 128. A value of zero is invalid for this parameter. This number schould be given in power of 2 value. If not it will be aligned to the next possible value (1, 2, 4, 8 … … 128). Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 129 The full MAC-Frame is provided in the separate Buffer Queue. That means, the BIU- Processor fetches the Frame Header Words out from this entry and switches then to the separate buffer queue. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 130 Buffer Queues Reserved for internal use. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 131: Fdxcmdtxbufferqueuefree

    This may cause unpredictable results. (See description of FdxCmdTxBufferQueueAlloc). Output: None Return Value Returns FssDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 132: Fdxcmdtxbufferqueueread

    Buffer Queue allocates multiple buffers continuously, it is possible to read more than one buffer of the queue with one call, by setting this parameter to the corresponding number of bytes. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 133 Bytes. Number of bytes, definitely read form the BIU associated memory. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 134: Fdxcmdtxbufferqueuewrite

    Buffer Queue allocates multiple buffers continuously, it is possible to write more than one buffer of the queue with one call, by setting this parameter to the corresponding number of bytes. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 135 Bytes from. Number of bytes, definitely written to the BIU associated memory. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 136: Fdxcmdtxbufferqueuectrl

    0 (first buffer in queue) and the “ul_BuffersInQueue – 1” parameter , given at the FdxCmdTxBufferQueueAlloc function. A value of FDX_TX_BUF_QUEUE_KEEP will not modify the current internal Buffer Index. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 137 AiUInt32 ul_BufferIndex; } TY_FDX_TX_BUF_QUEUE_DESC; A detailed description of this structure is found at the FdxCmdTxBufferQueueAlloc function. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 138: Fdxcmdtxsubqueuecreate

    AiUInt32 ul_SubQueueHandle; } TY_FDX_TX_SUB_QUEUE_CREATE_OUT; A returned handle for all further access to this Sub Transmit queue. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 139: Fdxcmdtxsubqueuedelete

    By deleting this queue it should be guarantied that the Sub-Queue is not longer in use. Handle to a defined Transmit Sub Queue. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 140: Fdxcmdtxsubqueuewrite

    One Entry specifies one Frame + Header Information. This means one complete MAC frame plus a fixed sized Header. The Header contains information about the manner in which the frame should be sent on the network. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 141 Buffer Queue which is controlled by some entries in the Frame Header. Normally a Transmit Frame is stored in the Transmit Queue with its Frame Header and a reference Buffer Queue with size buffer. command Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 142 Sub Transmit Queue has the same properties as the main Transmit Queue. After execution of this Sub Transmit Queue processing will return to the next instruciotn or transmission after the call instruction. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 143 Frame Data ( Entry 3) Buffer Queue Ptr. Buffer Queue Ctrl. Frame Data ( Entry 4) Frame Header Type 0 Buffer Queue Ptr. Buffer Queue Ctrl. Frame Header Type 1 Instruction (Sync) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 144 Section 4 – Function Reference: Transmitter Functions THIS PAGE INTENTIONALLY LEFT BLANK Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 145: Fdxcmdrxcontrol

    Provide capture data to system driver resp. board mory FdxCmdMonContCapInvalidateM Invalidate provided capture data to system driver resp. emory board FdxCmdMonContCapForceData Force System to pass databuffer to Host and use next Transfer Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 146 Reset nothing FDX_RX_GS_RES_ALL_CNT Reset all counts FDX_RX_GS_RES_ERR_CNT Reset only the Error related Counters Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 147 { AiUInt32 ul_TotalByteCount; AiUInt32 ul_FrameGoodCount; AiUInt32 ul_FrameErrorCount; AiUInt32 ul_BytesPerSecond; AiUInt32 ul_FramesPerSecond; TY_FDX_RX_GLOB_STAT_ERR x_StatErr; TY_FDX_RX_GLOB_STAT_SIZE x_StatSize; }TY_FDX_RX_GLOB_STAT; AiUInt32 ul_TotalByteCount; Counter of total Bytes received, since start or the last counter reset. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 148 Number MAC static header fields errors detected Number Frames detected with no without Start Frame Delimiter Number of VL specific frame length error detected Number of frames detected with sequence number integrity error. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 149 *px_GlobalStat for the redundant Port. In case of single configuration it is possible to pass NULL for this parameter. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 150 Defines the Payload Mode, for data flow reduction. So you can specify up to which level the data shall be stored in the data buffer. In this mode you can see the traffic on the bus without monitoring and transferring the full data. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 151 This parameter is only relevant if the chronological monitoring mode is selected. parameter is not used for ul_ReceiveMode = FDX_RX_VL. If this value is set to 0, the onboard target software will be set to a default value. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 152 The adjusted global Monitor Memory buffer size is reported in this output parameter. For VL oriented mode, this value will be 0. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 153 This is a user definable byte for identification. This identification will occur later in the received data (respective Frames) to identify the port. Note: This function can only be performed by a privileged user! Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 154 Size of Global Memory (in Bytes) which is not already allocated. AiUInt32 ul_SharedMemFree Size of Shared Memory (in Bytes) which is not already allocated. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 155 Additional Receiver Status Information Value Description FDX_RX_INFO_OVERLOAD Receiver Overload! Firmware was not able to capture all data. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 156 Trigger Line 2 FDX_STROBE_LINE_3 Trigger Line 3 FDX_STROBE_LINE_4 Trigger Line 4 FDX_STROBE_LINE_KEEP Keep current setting Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 157 . This is not allowed together with ul_EnableMode = FDX_RX_VL_ENA_EXT of the TY_FDX_RX_VL_CTRL settings ! AiUInt32 ul_VLRange Number of VLs which are affected by the TY_FDX_RX_VL_CTRL settings, beginning with the VL set in the ul_VLId parameter. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 158 Note: If port oriented functions used only ul_EnableMode = FDX_RX_VL_ENA_EXT is possible. VL Mode versus Receiver Mode Overview VL Mode Chronological Rx VL oriented Mode Rx Mode FDX_RX_VL_DIS FDX_RX_VL_ENA_STAT FDX_RX_VL_ENA_CNT FDX_RX_VL_ENA_MON FDX_RX_VL_ENA_MON_GOOD Yes (if non- redundant) FDX_RX_VL_ENA_EXT Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 159 AiUInt32 ul_Jitter; AiUInt32 ul_MaxFrameLength; AiUInt32 ul_MaxSkew; AiUInt32 ul_VLBufSize; TY_FDX_RX_VL_EXT_FLT x_VLExtendedFilter; AiUInt32 ul_MinFrameLength; } TY_FDX_RX_VL_DESCRIPTION; Note: Structure TY_FDX_RX_VL_DESCRIPTION is used only if parameter ul_EnableMode is FDX_RX_VL_ENA_EXT, pointer can be set to NULL otherwise. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 160 Possible Range for the Jitter 1 to 65535 µs. Maximum Frame Length of a MAC Frame specified for this Virtual Link. Minimum Frame Length of a MAC Frame specified for this Virtual Link. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 161: Figure 4.4.1.6-1: Mechanism Of Second Level Filter

    Filter Mask to mask the bits of four consecutive bytes for comparing with the filter data. If bit is set (1) the according bit in filter data is relevant. If bit is not set (0) the according bit in filter data is don’t care. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 162 = 36 (Udp-Destination) ul_FilterMask = FFFF0000hex (mask out UDP-length) ul_FilterData = 000A0000hex (check for UDP-destination 10decimal)) None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 163 Following functional groups can be controlled. The modes within one group are exclusive. But all group modes can be combined. Frame related interrupt control Mode Description FDX_RX_VL_NOINT No interrupt on frame reception FDX_RX_VL_INT Interrupt if frame received FDX_RX_VL_INT_ERR Interrupt if error on received frame Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 164 Interrupt on Buffer Full FDX_RX_VL_HFI Interrupt on Half Buffer Full FDX_RX_VL_QFI Interrupt on Quarter Buffer Full None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 165 Virtual Link Identifier. A value in a range from 0 to 65535. This value is part of the MAC destination address. The parameter is only applicable in case of FDX_RX_VL_ACT_VL mode (see above). Maximum number of bytes which can be written to the provided data buffer. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 166 AiUInt32 ul_ErrorCountB; AiUInt32 ul_FramesPerSecondB; AiUInt32 ul_FramesRmDiscardedA; AiUInt32 ul_FramesRmDiscardedB; } TY_FDX_RX_VL_ACTIVITY; Virtual Link Identifier Verification Mode which is selected for the specified Virtual Link. For description see the specification of the command FdxCmdRxFLControl(...). Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 167 Then the VL-specific counter and error information for both ports is provided. : This counter is only applicable, if the Handle used for this function references a redundant configured port. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 168 VLs this number might be smaller than number of active VLs (ul_NumOfActivVL). Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 169 AiUInt32 ul_VLRangeMax; AiUInt32 ul_VLCompareLogic; AiUInt32 ul_AcceptErrors; AiUInt32 ul_HwTriggerEna; } TY_FDX_RX_HW_VL_FILTER; Specifies if this Hardware Filter shall ba active or not. Value Description FDX_ENA Enables this Hardware Filter FDX_DIS Disables this Hardware Filter Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 170 Frame will be only passed to the receive buffer if accepted by the filter. FDX_ON Frame will be passed to the related Hardware Trigger Control Blockfilter to evaluate the trigger condition. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 171 Gives a feedback if this Vl Hardware Filter is enabled or not. Returns the number of Filters which ara possible to set up for this port. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 172 Number of Messages to read. This means the newest ul_MsgCount Entries. In case of a sampling port there is maximum one message to read. Have also a look to the output parameter section for variables used there as input! Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 173 Fix sized Header is preceded. For layout of such an entry refer to definition in function FdxCmdRxSAPRead. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 174 This is the maximum size of the variable length message which can be received by this port. (0..ize  8kBytes ) Note: If received message exceeds maximum size this message will be cut off and only ul_UdpMaxMessageSize bytes will be saved. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 175 Pointer to a structure, which describes the SAP port. typedef struct { AiUInt32 ul_UdpHandle; }TY_FDX_RX_SAP_CREATE_OUT; Handle to the SAP port. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 176 Number of Messages actually read. Pointer to the data buffer the Entries should be stored. Required size of buffer can be calculated: ul_UdpMaxMessageSize * ul_MsgCount. The ul_UdpMaxMessageSize is defined with function FdxCmdRxSAPCreatePort. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 177: Figure 4.4.2.3-1: Rx Sap Message Buffer Layout

    Microseconds of second, seconds of minutes and minutes of hour. To get a ‘C’ structured information of the Time Tag you can use the functions FdxFwIrig2StructIrig (). SAP payload size in bytes of received Frame. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 178 The IP source address of the received message The UDP source port of the received message Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 179: Fdxcmdrxudpblockread

    For all port types the number of messages to read shall be always 1. To read more messages of one port (queuing type only) add another entry to input array px_UdpBlockReadInPortArray with same ul_UdpHandle. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 180 For special system information and administration a Fix sized Header is preceded. For layout of such an entry refer to definition in function FdxCmdRxUDPRead. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 181: Fdxcmdrxudpcontrol

    The port will receive messages from only network B AiUInt32 ul_InterruptControl This parameter allows to get a user interrupt on reception of each message on a UDP-Port. Value Description FDX_RX_UDP_NOINT No interrupt FDX_RX_UDP_INT Interrupt FDX_RX_UDP_UDF Not implemented Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 182 Section 4 – Function Reference: Receiver Functions Output: None Return Value Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 183: Fdxcmdrxudpchgdestport

    The handle of the associated UDP port. This must be a handle to a Queuing port. AiUInt32 ul_UdpDst Destination UDP port. Part of the UDP quintuplet. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 184: Fdxcmdrxudpcreateport

    Reassembling will be done in the IP layer. A Message can have a size up to 8kByte. This structure provides a full identification of the communication. UDP port-number of the source UDP port. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 185 Not relevant in Rx Mode. Output: AiUInt32 *pul_UdpHandle Handle to the UDP port. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 186: Fdxcmdrxudpdestroyport

    Input: See description of FdxCmdRxUDPCreatePort. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 187: Fdxcmdrxudpgetstatus

    Total number of erroneous Messages written to the UDP port buffer since last start of receiver. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 188: Fdxcmdrxudpread

    One Entry specifies one Message, which means one complete sampling or queuing message. For special system information and administration a Fixed sized Header is preceded. The following figure shows the schematic of such an entry. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 189: Figure 4.4.2.8-1: Rx Udp Message Buffer Layout

    Microseconds of second, seconds of minutes and minutes of hour. To get a ‘C’ structured information of the Time Tag you can use the functions FdxFwIrig2StructIrig (). UDP payload size in bytes of received Frame. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 190 Error information as available in Queuing ports additional error information: FdxCmdMonQueueRead variable uw_ErrorField IP_REASS_ERROR_SYNC IP_REASS_ERROR_ORDER IP_REASS_ERROR_FRAQ IP_REASS_ERROR_SIZE IP_REASS_ERROR_BUF Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 191: Fdxcmdmoncapturecontrol

    ….) Selective FDX_MON_CONT_SELECTIVE Same mode as described for Selectiv but in Continuous Continuous Capture Mode. Selective FDX_MON_CONT_SE_SELECTIV Same mode as described for Selectiv but in Continuous_2 Continuous Capture Second Edition Mode. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 192 In Selective Capture Mode, the Strobe is asserted if the Capturing is restarted. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 193: Chronological Monitor

    Figure 4.4.3.2-1 shows the chronological monitor states and the junction between the states. The state Off can be reached from each other state by intervention of the user. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 194: Figure 4.4.3.2-1: States Of The Chronological Monitor

    { AiUInt32 ul_FramesCaptured; Ai_UInt64_Union u64_BytesRecorded; } TY_FDX_MON_REC_STATUS; Total number of frames captured since start. Reserved. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 195: Fdxcmdmonqueuecontrol

    } TY_FDX_MON_QUEUE_CTRL_IN; Queue Control Code Value: Description: FDX_MON_QUEUE_CREATE Create queue, associated chronological buffer FDX_MON_QUEUE_DELETE Delete Queue Queue Identifier to delete (only needed if the Queue Control Code is set to FDX_MON_QUEUE_CREATE Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 196 Pointer to structure of output data typedef struct { AiUInt32 ul_QueueId; } TY_FDX_MON_QUEUE_CTRL_OUT; Queue Identifier. Valid Queue Identifier Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 197: Fdxcmdmonqueueread

    This is a qualifier, indicating which part of the Entry should be read. Value: Description: FDX_MON_READ_FULL Read the full entry FDX_MON_READ_HEADER Read only the fixed header FDX_MON_READ_DATA Read only the data, starting with the MAC Frame Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 198 One Entry specifies one Message, which means one complete MAC frame transferred on the network. For special system information and administration a Fixed sized Header is preceded. Figure 4.4.3.4-1 shows the schematic of such an entry. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 199: Figure 4.4.3.4-1: Monitor Queue Entry Structure Of A Standard Afdx Frame

    Time Tag High Word (TTHW) Time Tag Low Word (TTLW) Received AFDX- FRAME ( 802.3 defines: 64 to 1518 bytes but it may be less or more at Frame size violation case ) Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 200 { // Frame Header Word 0: AiUInt16 uw_VlId; AiUInt16 uw_ErrorField; // Frame Header Word 1: AiUInt32 ul_FrameHeaderWord_1; // Frame Header Word 2: AiUInt8 uc_SequenceNr; AiUInt8 uc_Reserved1; AiUInt16 uw_BufferSize; } TY_FDX_FRAME_HEADER_INFO; Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 201 Size of the frame entry (Header + Data) in Bytes (Note: CRC Bytes are not stored) The Firmware IRIG time tagged to this frame. The reference point for the Time Tag is the start of the preamble, transferred in front of this frame. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 202: Figure 4.4.3.4-2: Afdx Frame Layout

    Frame size violation case ) Frame Check Sequence Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 203: Fdxcmdmonqueueseek

    Seek from the end of the queue to the offset position. FDX_SEEK_CUR Seek from the current internal read pointer of the queue to the offset position. FDX_SEEK_TRG Seek from the Trigger of the queue to the offset position Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 204 Byte offset to the seek target position calculated from start of the queue. This value can be used to calculate memory buffer sizes for reading buffer entries. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 205: Fdxcmdmonqueuetell

    Byte offset to the seek target position calculated from start of the queue. This value can be used to calculate memory buffer sizes for reading buffer entries. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 206: Fdxcmdmonqueuestatus

    FDX_MON_STAT_ ERROR Any kind of Capture queue Error. Returns number of Frames actually in Queue to read out. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 207 64 Byte. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 208: Fdxcmdmontcbsetup

    TY_FDX_MON_TCB_SET_GEN x_GenTrg; TY_FDX_MON_TCB_SET_ERR x_ErrTrg; AiUInt32 ul_NextTrueIndex; AiUInt32 ul_NextFalseIndex; AiUInt32 ul_TriggerBits; AiUint32 ul_TCBEx; TY_FDX_IRIG_TIME x_TriggerTime; AiUInt32 ul_TimeDuration; /* Time duration in ms */ AiUInt32 ul_TriggerVl; /* VL for specified Trigger */ } TY_FDX_MON_TCB_SET; Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 209 Defines the generic trigger type byte position. See also description and figure of parameter x_VLExtendedFilter of function FdxCmdRxVLControl. Defines the generic trigger type mask. See also description and figure of parameter x_VLExtendedFilter of function FdxCmdRxVLControl. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 210 Trigger Bits, which are cleared if TCB evaluation becomes true 8-15 Trigger Bits, which are set if TCB evaluation becomes true 16-31 Reserved Specify the identifier of the VL for trigger type FDX_TRG_VL_DEFINED. This is only valid for APX-GNET, Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 211: Figure 4.4.3.7-1: Trigger Engine Dependencies

    2 Initialize Trigger Index Word with the TCB Start Index FdxCmdMonTrgIndexIni(...) 3 Initialize VL related Trigger Index with a TCB Index if neccessary FdxCmdMonTrgIndexIniVL(...) 4 Initialize Trigger Word FdxCmdMonTrgWordIni(...) Figure 4.4.3.7-1: Trigger Engine Dependencies Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 212: Fdxcmdmontrgindexwordini

    See also the FdxCmdMonTCBSetup command ul_NextTrueIndex/ul_NextFalseIndex parameter of the TY_FDX_MON_TCB_SET structure. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 213: Fdxcmdmontrgindexwordinivl

    VL. Valid range is 0...FDh and FFh (FEh reserved for internal use, ASP). Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 214: Fdxcmdmontrgwordini

    TY_FDX_MON_TCB_SET structure. typedef { AiUInt32 ul_StartTriggerMask; AiUInt32 ul_StartTriggerComp; AiUInt32 ul_StopTriggerMask; AiUInt32 ul_StopTriggerComp; } TY_FDX_MON_TRG_WORD_INI; Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 215 The following functions for Continuous Capture Second Edition (CCSE) are designed for a more performant way of continuously capturing data from an AIM AFDX board. The intention and gloabal different design difference to other continous capture mode is, that memory can provided at the user interface to the onboard Target software.

  • Page 216: Fdxcmdmonqueuecontcapcontrol

    Pointer to a Continuous Capture Setup structure with following members. typedef AiReturn (*TY_FUNC_PTR_FDX_CONT_CAP_CALLBACK)( AiUInt32 ul_Handle, TY_FDX_MON_CONTCAP_PROVIDE_MEM x_ContCapBufferInfo AiUInt32 ul_Info); typedef struct { AiUInt32 ul_QueueCtrl; AiUInt32 ul_QueueId; AiUInt32 ul_QueueMemorySize; AiUInt32 ul_Timeout; AiUInt32 ul_TriggerTCBIndex; TY_FUNC_PTR_FDX_CONT_CAP_CALLBACK pf_CaptureCallback; } TY_FDX_MON_QUEUE_CONTCAP_CTRL_IN; Queue Control Code Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 217 FDX_MON_CC_QUEUE_INF_CONTRUN This is a combination of the values FDX_MON_CC_QUEUE_INF_TRUNC and FDX_MON_CC_QUEUE_INF_CONTINU which means this is a fragment of a buffer preceded with a buffer before and followed by the next buffer. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 218 Size of the global Monitor Buffer for the BIU firmware in Global RAM. This value should be taken in account for providing receive memory buffers. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 219: Fdxcmdmoncontcapprovidememory

    A User Identifier which can be set by user for easy buffer identification. Pointer to the start of the memory buffer in host environment. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 220 Monitor Buffer for the BIU firmware in Global RAM. The size of this global Monitor Buffer is returned by function FdxCmdMonQueueContCapControl. None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 221: Fdxcmdmoncontcapinvalidatememory

    Not needed for this call. A User Identifier which can be set by user for easy buffer identification. Pointer to the start of the memory buffer in host environment Not needed for this call. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 222 Section 4 – Function Reference: Receiver Functions None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 223: Fdxcmdmoncontcapforcedatetransfer

    AiUInt32 ul_QueueId; } TY_FDX_MON_CONTCAP_FORCE_TRANSFER; Queue Identifier which you got on creation of the queue to identify the Queue. None Return Value Returns FDX_OK on success or a negative error code on error. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 224: Table 4.5-I: Target Independent Administration Functions

    Translates a FW encoded Error Word for Error Information on Receiver Side FdxInitTxFrameHeader Supports a default initialization of a Transmit Header Structure, needed in Generic Transmit Mode FdxProcessMonQueue Processes data read via FdxCmdMonQueueRead. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 225 Absolute Relative FdxAddIrigStructIrig Absolute Relative Absolute FdxAddIrigStructIrig Relative Absolute Absolute FdxAddIrigStructIrig Relative Relative Relative FdxAddIrigStructIrig Absolute Absolute Relative FdxSubIrigStructIrig Absolute Relative Absolute FdxSubIrigStructIrig Relative Absolute Absolute FdxSubIrigStructIrig Relative Relative Relative FdxSubIrigStructIrig Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 226: Fdxcmdfreememory

    Application Interface Library function is freed prior to termination of the application. AiUInt32 ul_StructId Identification of the type of memory to be freed. Output: None Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 227: Fdxfwirig2Structirig

    0 to 59 0 to 59 0 to 999.999 Timetag word in firmware format. The lower part of the time tag, containing the Microseconds of second, seconds of minutes and minutes of hour. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 228 // 0..999 AiUInt32 ul_NanoSec; /* 0..900 in steps of 100 */ AiUInt32 ul_Info; } TY_FDX_IRIG_TIME; Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 229: Fdxinittxframeheader

    = FDX_TX_FRAME_PRE_DEF; x_FrameAttrib.ul_BufferQueueHandle = 0; x_FrameAttrib.ul_InterFrameGap = 25; // (1us) x_FrameAttrib.ul_PacketGroupWaitTime = 1000; // (1ms) x_FrameAttrib.ul_PhysErrorInjection = FDX_TX_FRAME_ERR_OFF; x_FrameAttrib.ul_Skew = 0; x_FrameAttrib.uw_FrameSize = 0; x_FrameAttrib.uw_SequenceNumberInit = FDX_TX_FRAME_SEQ_INIT_AUTO; x_FrameAttrib.uw_SequenceNumberOffset = FDX_TX_FRAME_SEQ_OFFS_AUTO; Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 230 Section 4 – Function Reference: Target Independent Administration Functions TY_FDX_TX_FRAME_HEADER *px_TxFrameHeader Initialized structure (see above) Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 231: Fdxprocessmonqueue

    Entries (Header + Data or Header only) are passed via pv_MonQueueData parameter. void *pv_MonQueueData Processed Monitor Queue Data Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 232: Fdxstructirig2Fwirig

    IRIG Timecode Firmware format structure typedef struct { AiUInt32 ul_TtHigh; AiUInt32 ul_TtLow; } TY_FDX_FW_IRIG_TIME; Format see FdxFwIrig2StructIrig function above. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 233: Fdxtranslateerrorword

    Pointer to Array of characters, which will hold the error string after successful translation. The Error String will contain the error abbreviations for the occurred errors, separated by a forward slash ‘/’ . Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 234 Size in bytes of the array of characters, which will hold the error string after successful translation. AiChar* puc_ErrStr Error String, written to the puc_ErrStr Pointer. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 235: Gnettranslateerrorword

    This function translates a Firmware specific Error Report Word into a string, containing 3- character wide abbreviations for the corresponding errors. This function is special to use with APX-GNET. For detailed description see function FdxTranslateErrorWord Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 236: Fdxcreaterecindex

    The recording and index filename will be passed over to the callback function. These informations can be used to identify the caller in multithreaded applications. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 237 Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR FDX_ERROR_REC_FILE_CORRUPT The recording file is corrupt. An illegal frame size has been encountered. FDX_ERROR_CREATE_REC_INDEX_USER_ABORT The user has aborted the index creation. Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 238: Fdxskiprecfileheader

    0, the recording file does not contain an index table. The address of a variable, that receives the length of the recording file header. Return Value Returns FDX_OK on success or a negative error code on error. Error Codes: FDX_ERR Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 239: Abbreviations

    Random Access Memory RISC Reduced Instruction Set Computer. Redundancy Management Redundancy Management Algorithm RP(M) Replay Mode Sampling & Queuing Service Access Point System Control Block Start Frame Delimiter Sequence Number Simulator Transmit Mode Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 240 Section 5 – Notes Test Access Point To be defined Monitor Trigger Control Block TFTP Trivial File Transfer Protocol Traffic Shaping User Datagram Protocol Virtual Link Versatile Bus Modular European (computer bus) Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 241: Definition Of Terms

    8 bits at the lowest address. Channel Two physical AFDX ports Driver Command command used by the AIM target s/w to control the AIM device FLASH page oriented electrical erasable and programmable memory function a self-contained block of code with a specific purpose that returns a single value.
  • Page 242 Section 5 – Notes THIS PAGE INTENTIONALLY LEFT BLANK Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 243: Table 6.1.1-I: Library Admin. Function Changes Between Several Versions

    FdxReadBSPVersion                   FdxCmdBITETransfer FdxCmdStrobeTriggerLine         D  Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 244: Table 6.1.4-I: Transmitter Functions Changes Between Several Versions

     !!NEW!! FdxCmdTxBufferQueueCtrl     !!NEW!! FdxCmdTxSubQueueCreate     !!NEW!! FdxCmdTxSubQueueDelete     !!NEW!!     FdxCmdTxSubQueueWrite !!NEW!! FdxCmdTxUDPWriteIndexed    !!NEW!! Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 245: Table 6.1.5-I: Receiver Functions Changes Between Several Versions

               GNetTranslateErrorWord !!NEW!! FdxInitTxFrameHeader            FdxCreateRecIndex !!NEW!! FdxSkipRecFileHeader   !!NEW!! Reference Manual AFDX / ARINC 664 Application Interface Library...

  • Page 246: Table 6.2-I: Document History Details

    Description of unimplemented functions removed: – FdxQueryLoginInfo() removed – FdxCmdBite() removed – FdxReadBSPVersion() removed – FdxCmdTxCreateVL() removed – FdxCmdTxUDPCreatePort() removed – FdxCmdTxUDPDestroyPort() removed – FdxCmdTxUDPGetStatus() removed – FdxCmdTxUDPWrite() removed – FdxCmdRxVLGetStatus() removed – FdxCmdRxVLReadData() removed Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 247 Chapter 6.4.1 “FdxCmdBoardControl”: Note removed about port configuration. Chapter 6.5 “Transmitter Functions”: Description of Individual Mode added. Chapter 6.5.1.2 “FdxCmdTxModeControl”: Description of ul_TransmitMode option FDX_TX_INDIVIDUAL added. Chapter 6.6.1.2 “FdxCmdRxModeControl”: Description of ul_ReceiveMode option FDX_RX_VL added. Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 248 FdxCmdMonTCBSetup)  Processed SCR#673: FdxLogin, use const pointer to ClientInfo- Struct (Incompatibility)  Processed SCR#692: 100/10 MBit affects IFG and other bit rate based parameters  Processed SCR#701: FdxCmdRxVLControlEx not accessible Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 249  FdxCmdRxVLGetActivity; TY_FDX_RX_VL_ACTIVITY extended, Verification modes have changed.  FdxCmdRxGlobalStatistic; additionally output structure for Port B in redundant mode, TY_FDX_RX_GLOB_STAT_ERR changed.  FdxCmdMonTCBSetup New Error Type  Additionally Error constant FDX_NO_VALID_SFD defined, used in Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 250  FdxDelIntHandler: NEW function described.  FdxCmdTxStatus: Status parameter changed to enum. New status indication added.  FdxCmdRxVLGetActivity: Memory management changed. Used global variable (8 MBytes) removed. Memory to be provided by Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 251  Version in “Modification Function List” corrected from 11.1x to 12.0x  FdxCmdTxQueueWrite and FdxCmdTxVLWriteEx: Second note to parameter ul_Skew added. 13.0x A 10.11.2005 M. Kammerer  FdxCmdBoardControl: Described changes in struct TY_FDX_BOARD_CTRL_IN and TY_FDX_BOARD_CTRL_OUT Reference Manual AFDX / ARINC 664 Application Interface Library...
  • Page 252  Modified FdxCmdRxVlControl to handle APX-GNET Hardware Trigger  New Function FdxCmdRxVLSetHwFilter  Describe changes for FdxCmdRxUDPBlockRead and FdxCmdRxSAPBlockRead 16.3x A 17.05.2011 T. Jahn  Transmit FIFO Mode added in function FdxCmdTxModeControl and FdxCmdTxQueueWrite Reference Manual AFDX / ARINC 664 Application Interface Library...

Table of Contents

Save PDF