ARINC 825 Library. Software Manual. ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 1 of 106

Transcription

1 ARINC 825 Library Software Manual ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 1 of 106 esd electronic system design gmbh Vahrenwalder Str Hannover Germany Phone: +49 (0) Fax: +49 (0)

2 N O T E The information in this document has been carefully checked and is believed to be entirely reliable. esd makes no warranty of any kind with regard to the material in this document, and assumes no responsibility for any errors that may appear in this document. esd reserves the right to make changes without notice to this, or any of its products, to improve reliability, performance or design. esd assumes no responsibility for the use of any circuitry other than circuitry which is part of a product of esd gmbh. esd does not convey to the purchaser of the product described herein any license under the patent rights of esd gmbh nor the rights of others. esd electronic system design gmbh Vahrenwalder Str Hannover Germany Phone: Fax: Internet: info@esd.eu USA / Canada: esd electronics Inc. 525 Bernardston Road Suite 1 Greenfield, MA USA Phone: Fax: Internet: us-sales@esd-electronics.com Page 2 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

3 Document file: Date of print: I:\Texte\Doku\MANUALS\PROGRAM\CAN\C _ARINC825\ARINC825_Library_Manual_en_11.odt Documentation valid for software versions: ARINC 825 Library (object code) for... Windows XP, Windows 2000 Linux RTX QNX VxWorks Order no. C (Windows/Linux CD) C C C Documented Software Rev. ARINC Library: Document History Document history see page 7. Technical details are subject to change without further notice. ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 3 of 106

4 Table of contents 1. Overview Overview ARINC-Time CAN-errors Defines CAN-IDs CAN-Length CAN-Baudrate Handle-Modeflags Handle-Queuesize IOCTLs IOCTL-TxSchedule Status-Features Status-IRIG-B Status-Busstates Bitrate-Controller Bitrate-Flags IRIG-B-Modeflags Errorcodes Errorformats Thread-Priority Error-Injection Datatypes ARINC_RESULT ARINC_HANDLE ARINC_ERROR_HANDLER ARINC_GROUP NTCAN_CMSG_T NTCAN_EVMSG_CAN_ERROR NTCAN_EVMSG_CAN_BAUD_CHANGE NTCAN_EVMSG_CAN_ERROR_EXT ARINC_CMSG_T ARINC_STATUS ARINC_ERROR NTCAN_CSCHED NTCAN_FRAMECOUNT NTCAN_BUSSTATISTIC NTCAN_CTRLSTATE NTCAN_BITRATE_INFO NTCAN_FORMAT_EVENT_PARAMS CAN_BIT_STREAM CAN_EEI_UNIT CAN_EEI_STATUS Macros Boardstatus Timeconstants Timemasks Timemacros Functions General-Functions...69 Page 4 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

5 7.1.1 arincopen arincclose arincbaudrateset arincbaudrateget arincioctl arincstatus arincstatusreset arinccanerrorcounterreset arincformaterror arincformatevent arincfiledescriptorget ARINC-Functions arincerrorhandler arincirigbconfigset arincirigbconfigget arinctimeset arinctimeget arincintervalset arincintervalget arincschedulestart arincschedulestop arincpoll arinctxobjupdate arinctxobjdisable arincwaitfortimeslot arincobjadd arincobjdelete CAN-Functions arincrxidadd arincrxiddelete arincread arinctake arincwrite arincsend ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 5 of 106

6 Overview Overview 1. Overview Overview [ Top ] [ Generics ] ARINC825 Library FILE arinc.h BRIEF MODULE DESCRIPTION Header for ARINC825 support library AUTHOR Andreas Block (BL) CREATION DATE 25-May-2009 PORTABILITY ANSI-C vxworks, Linux, Win32 Depends on ntcan- and psys-library COPYRIGHT Copyright (c) by electronic system design gmbh This software is copyrighted by and is the sole property of esd gmbh. All rights, title, ownership, or other interests in the software remain the property of esd gmbh. This software may only be used in accordance with the corresponding license agreement. Any unauthorized use, duplication, transmission, distribution, or disclosure of this software is expressly forbidden. This Copyright notice may not be removed or modified without prior written consent of esd gmbh. esd gmbh, reserves the right to modify this software without notice. electronic system design gmbh Tel Vahrenwalder Str 207 Fax Hannover Germany sales@esd.eu MODIFICATION HISTORY Edit Date/Ver Edit Description ================= ======================================================= Fixed: Race condition, if multiple arincopen() are called simultaneously (collision of multiple starting error deamons) Syncronization release for Windows, VxWorks and Linux Change: Windows NTCAN Library version was increased to represent addition of error injection Added: Defines, structures and IOCTLs for error injection (CAN_BIT_STREAM, CAN_EEI_UNIT, CAN_EEI_STATUS, Error-Injection, arincioctl(arinc_ioctl_eei_create, Page 6 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

7 Overview Overview ARINC_IOCTL_EEI_DESTROY, ARINC_IOCTL_EEI_STATUS, ARINC_IOCTL_EEI_CONFIGURE, ARINC_IOCTL_EEI_START, ARINC_IOCTL_EEI_STOP, ARINC_IOCTL_EEI_TRIGGER_NOW)) Fixed: If IRIG-B status got queried directly after reconfiguration, false status bits (from prior reconfiguration) were delivered. Change: arincobjadd() and arincobjdelete() don't check for 29-Bit IDs anymore. It's possible to use 11-Bit IDs (even in combination with 29-Bit IDs), now. Nevertheless you should know, what you are doing, as ARINC825 is defined for 29-Bit IDs, only. Change: Documentation: - New error injection stuff added - Corrected description of member "m" in ARINC_CMSG_T Fixed: Disabled TX objects get reenabled, if received from bus Syncronization release for Windows, VxWorks and Linux Fixed: IRIG-B not synchronizing with certain IRIG-B sources (IRIG-B firmware update to 1.AD5 needed) Special VxWorks release Added: VxWorks: Driver configuration options, see VxWorks README Fixed: Severe bug in ioctl mechanism completely broke autobaud (bug introduced with (synchronisation of arincioctl())) Fixed: Synchronisation of arincioctl() when arincclose() is called in parallel on same handle Fixed: Error frames were not counted correctly for NTCAN_BUSSTATISTIC (arincioctl(arinc_ioctl_get_bus_statistic)) Added: In NTCAN_BUSSTATISTIC aborted_frames was introduced Change: arincclose() optimized Change: Overall minor optimizations Fixed: Windows only: Crash in conjunction with timers Fixed: Windows: Updated device manager dialog Fixed: Missing feature flag ARINC_FEATURE_DIAGNOSTIC (AMC825 had this feature all the time, but flag was not set) Fixed: In NTCAN_BITRATE_INFO members ctrl_type and clock weren't set correctly, if no baudrate was set Fixed: VxWorks only: Recompiled with -msoft-float Fixed: VxWorks: Symbols for driver configuration got stripped. Change: VxWorks: Symbols for driver configuration have amc825_ prefix, now Fixed: Possible memory leak, if user did not delete all objects before calling arincclose() Fixed: Wrongly accounted RX Timeout errors after stopping and restarting a schedule Fixed: Another problem with RTR objects. Reception of normal ID on a node with same ID as RTR deleted the RTR bit in object Fixed: RTR objects and arincobjadd() Added: Function arinccanerrorcounterreset() to reset CAN error counter (before using, pay attention to notes!) Fixed: It's now possible, to add RTR objects with arincobjadd() Fixed Windows Driver+Library, only. Fixed: arincwrite(), arincschedulestop() blocking under certain conditions, if CAN controller got error passive ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 7 of 106

8 Overview Overview Fixed Windows Library, only. Added: New feature flag ARINC_FEATURE_SMART_ID_FILTER Bugfix: Flag ARINC_FEATURE_ID_RANGES is deprecated, now Bugfix: Windows: Fixed calltype of arincformatevent() Added: Documentation: CAN-errors Change: CAN traffic is bus mastered in RX direction Lot's of performance optimizations Change: CAN traffic LED blink code slightly changed Fixed: TX Job could hang, if baudrate was reset by another handle Fixed: TX channel unusable after CAN bus off Fixed: Problem with 29-Bit filter (introduced in last release) Added: Asynchronous error handler get's triggered on errors Added: Function arincformatevent() to decode CAN event messages to strings Added: Structure NTCAN_FORMAT_EVENT_PARAMS Added: Structures NTCAN_EVMSG_CAN_ERROR, NTCAN_EVMSG_CAN_BAUD_CHANGE and NTCAN_EVMSG_CAN_ERROR_EXT for easier CAN event message evaluation Added: Two new error codes ARINC_CAN_STATE_CHANGE and ARINC_CAN_ERROR, see Errorcodes Added: errorlostframes member in ARINC_STATUS structure Added: ARINC_ERROR_INTERVAL_LOW error code to arincintervalset() in order to prevent user from setting insanely low timeslice durations (1ms and below), see Errorcodes Change: Structure ARINC_ERROR extended to provide more information to error handler Change: API change arincerrorhandler(): Added a parameter to select a single error code. Change: If there're no ARINC TX objects added to a handle, there's only one thread started on arincschedulestart() Change: Documentation: - New structures and arincformatevent() were added to documentation - ARINC_ERROR description reworked - Removed note on restriction of context of error handler. Error handlers have dedicated context, now. - Added information for concurrent applications in arincschedulestart() Bugfix: Renamed and corrected definition of ARINC_FEATURE_CAN_20B (former ARINC_FEATURE_BASIC_20B) Bugfix: CAN state transition to "Bus Ok" was erroneously counted as an error in "ARINC_STATUS" information Bugfix: Display of serial number on big endian hardware Removed: In version the functionality of arincformatevent() was implemented in arincformaterror(). Therefore a define and structure (ARINC_ERROR_FORMAT_ERROR_EVENT and NTCAN_ERROR_FORMAT_ERROR_EVENT_BUFFER) were introduced. These have now been removed again Fixed: FPGA contains change for latest change in hardware revision (Fixes crash on boards with GB0000xx serial number) Added: Possibility to use "select()" and "poll()" (currently VxWorks and Linux, only. Use WaitForMultipleObjects() on Windows for similar feature), see arincfiledescriptorget() Added: New function arincfiledescriptorget() to retrieve a filedescriptor needed for "select()" Page 8 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

9 Overview Overview Added: Variable "numcannodes" (type: int) contains number of successfully initialized CAN nodes under VxWorks (after driver was started by canstart()) Added: arincformaterror() can be used to decode extended error events Define ARINC_ERROR_FORMAT_ERROR_EVENT Datatype NTCAN_ERROR_FORMAT_ERROREVENT_BUFFER Added: Boardstatus macros Change: All uses of timers have been changed to make Use of hardware timers on AMC825. Solving the problem of inaccurate error detection with timeslice durations around or below system tick. Change: Reenabled error detection again Change: Documentation: - description of new functionality added Bugfix: Fixed typo in AIM_AIM2TDIFF Bugfix: Exception on interrupt level Bugfix: Problem with arinctake() on VxWorks Bugfix: Problem with heavily disturbed CAN busses Bugfix: CAN Controller type was not correct in ARINC_STATUS.boardstatus Bugfix: Define ARINC_CANCTL_ESDACC not usable under VxWorks Change: Temporarily disabled parts of error detection (e.g. timeslot overload) as workaround for "exception on interrupt" issue Added: arinctxobjdisable() to disable ARINC objects (prevent them from being scheduled/transmitted) Change: Timeslice duration is 64-Bit wide, now (arincintervalset() and arincintervalget()) Change: Added three parameters to arincschedulestart() to set the priority of the ARINC deamon threads Change: Documentation: - Thread-Priority defines - arincintervalset() description of interval parameter - arincschedulestart() new parameters - arinctxobjdisable() Bugfix: Uninitialized return value of arincirigbconfigset(), if no changes were made to configuration Bugfix: Fixed scheduling behaviour for interval times near system tick duration Bugfix: arincirigbconfigset() threw an error message, if new config is equal to previous config Change: arincirigbconfigset() reinitializes IRIG-B module only if new configuration differs from previous Change: When using ARINC_MODE_TIMEFORMAT_FORCE flag with arincopen(), IRIG-B module will be reinitialized only, when timeformat differs from the one previously configured Change: ARINC_GROUP changed to INT32. Using arincobjadd() objects can be scheduled on arbitrary multiples of timeslice interval. Change: Documentation: - arincirigbconfigset() notes on resynchronization of IRIG-B module - More description on Status-IRIG-B flags Special Debug Version Bugfix: arincwrite() and arincsend() for VxWorks and Win Change: More information to ARINC_STATUS structure: - CAN bus status - CAN error counters Change: ARINC_ERROR structure (parameter of asynchronous error handler) reworked ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 9 of 106

10 Overview Overview Change: Documentation: - Additions to ARINC_STATUS - Rendered some ARINC_STATUS descriptions more precisely Bugfix: Removed a "lost" debug output (suggested an error about unexpectedly received CAN frames, if ARINC and FIFO modes were combined) Bugfix: If arincintervalset() was used with a starttime = 0, after it was used with starttime!= 0 on the same handle, an old value was used Bugfix: Under certain circumstances arincintervalget() did not return the interval correctly (bug introduced with 1.0.6) Bugfix: Definition of ARINC_FEATURE_LOCAL_ECHO Bugfix: Definition of ARINC_FEATURE_CAN_20B Added: ARINC_MODE_TIMEFORMAT_FORCE in Handle-Modeflags Added: arincformaterror() Change: Documentation: - Possible deviance of RX and TX counter within ARINC objects explained (ARINC_CMSG_T) - ARINC_MODE_TIMEFORMAT_FORCE in Handle-Modeflags added - Uncleardescription of timeout parameter of arincopen() - Some more info to fifosize parameters of arincopen() - New function: arincformaterror() - New defines: Errorformats Bugfix: Memory allocation failure in arincobjadd(), if a TX object was created with n outside of range of group. ARINC_INVALID_PARAMETER is returned, now. Bugfix: With certain CAN error conditions there was a possibility for Win32 systems to lock up Bugfix: On certain errors the time of occurrence was not stored correctly in status structure (arincstatus()) Bugfix: Starttime was incorrectly configured, if AIM timeformat was used (fraction of a second was set too small by a factor of ten) Bugfix: If an application, which had called arincschedulestart() was unexpectedly aborted/ shutdown/crashed, a newly started scheduling from a following application did not correctly use the new starttime. Bugfix: arinctimeget() and arincstatus() work without configured baudrate Bugfix: A possible system crash (BSOD) under Win32. Bugfix: Documentation: - Status-IRIG-B defines - arincstatus() and arincstatusreset() was not up to date Added: If AIM time format is chosen, it's used for basic CAN functions as well. Added: Finally arincstatus() function delivers usable data. arinctest.c example code changed accordingly. Added: arinctimeget() and arincstatus() deliver IRIG-B status Added: Status-IRIG-B defines to evaluate IRIG-B status Added: Documentation: - Note on system Errorcodes - More links, better navigation - Missing baudrate indeces added (CAN-Baudrate) - Status-IRIG-B defines Change: It is no longer needed to have a baudrate configured, when calling arincirigbconfigset() or arinctimeset() Change: ARINC_STATUS structure extended: - dllarinc (version info of ARINC library) Page 10 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

11 Overview Overview - irigbstatus (status of IRIG-B module) - time (current time, when status is retrieved) Change: Timeformat can be chosen _once_ per system, only!!! The first handle opened, determines the timeformat in use. All other handles/applications will have to use the same timeformat (ARINC-Time, arincopen()). It is no longer possible to chose any IRIG-B mode in combination with any timeformat arincirigbconfigset()). Bugfix: arincintervalset(): Starttime = 0 got fixed Bugfix: arinctimeset(): works again (got deactivated with last release) Bugfix: A race condition got fixed, this could lead to corrupted RX-/TX-objects Bugfix: arincbaudrateset(), CAN-Baudrate: ARINC_USER_BAUDRATE_NUM works with AMC825, now Bugfix: arincioctl(): Handle related ioctls (e.g. ARINC_IOCTL_SET_RX_TIMEOUT) did not work correctly Bugfix: Issue: "arinctake() loses messages" Basic CAN functions worked on wrong handle and thus with wrong queuesizes Bugfix: arincobjdelete() Bugfix: arincpoll(): number of polled objects wasn't correctly returned in case of an error Bugfix: Library version code was wrong in last release (still instead of 1.0.4), now up to date and correct again Added: Flag ARINC_IRIGB_TIMEFORMAT_YEAR_MAN (IRIG-B-Modeflags) Added: Functions arincirigbconfigset() and arincirigbconfigget() Added: Some more Macros to work with AIM timeformat (Timemacros) Added: Timeout unit for arincwaitfortimeslot() defined as ms Change: ARINC_MODE_TIMEFORMAT_YEAR was renamed to ARINC_IRIGB_TIMEFORMAT_YEAR and is used with arincirigbconfigset() and arincirigbconfigget() instead of arincopen() (IRIG-B-Modeflags) Added: Support for AIM timeformat (ARINC-Time) Added: Time conversion macros (Macros/Timemacros) Added: Mode flags for time conversion (Handle-Modeflags) Added: Lots of documentation Added: Support for ARINC_OLD_DATA and ARINC_NO_DATA Added: Support for scheduling start time Change: arincintervalget() parameters Bugfix: TX counters count non sent frames, now Added: Lots of defines for use with basic CAN functions and their documentation Bugfix: Changed error codes once more, in order to achieve independence of operating system Second test release Added: Robodoc documentation Bugfix: Handle for FIFO functions wasn't returned correctly Change: There's no FIFO mode for handles anymore. Every handle can use all library functions. Added: Parameter error handling improved Bugfix: Relocated base of ARINC-specific error codes from 0x80 to 0xA First test release Initial version ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 11 of 106

12 ARINC-Time 2. ARINC-Time [ Top ] [ Generics ] DESCRIPTION Within this library time is handled/presented in one of two formats. The format to be used, is set via the mode parameter of arincopen().!!! BEWARE: This decision is done once per system, the first handle determines the timeformat, all other applications/handles will have to choose.!!! Time format #1 (default): Time is represented as a 64-Bit unsigned integer value, as follows: Upper (most significant) 32 Bit: Seconds since timebase (see below) Lower (least significant) 32 Bit: Splitseconds (see below) Splitseconds: Most significant bit: 2^-1 seconds Least significant bit: 2^-32 seconds Example, given the following 64-Bit value: 0x Upper 32-Bit: 0x => five seconds since timebase Lower 32-Bit: 0x => 2^-1 + 2^ ^-32 = 0, parts of a second Resulting in seconds Time format #2 (AIM format): This archive is closely related to time representation on IRIG-B, it contains no year information: Upper 32-Bit: Bits 5-0(LSB): Seconds within current minute Bits 11-6 : Minutes within current hour Bits : Hour of current day Bits : Day of current year Lower 32-bit: Bits 19-0(LSB): Microseconds of current second Bits : Seconds within current minute Bits : Minutes within current hour There're two timebases to choose from: A) 1st of January of the current year, 00:00 (default) B) 1970/01/01, 00:00 (begin of UNIX time) If there's no valid IRIG-B signal, current time can be set by use of arinctimeset(). As soon as a valid IRIG-B is detected, the time will be set to IRIG-B time, regardless of any formerly set time. Use of timebase B makes sense only, if at first the IRIG-B signal contains information about year and secondly time format #1 is chosen. NOTES Since time format #2 is generated from format #1 in software, it has a slight impact on CPU usage. There're some macros, to make work with time format #2 a little easier. Handle-Modeflags Macros Timemacros arincopen() arinctimeset() arinctimeget() Page 12 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

13 3. CAN-errors [ Top ] [ Generics ] DESCRIPTION CAN-errors Basics: On CAN bus there are pretty sophisticated error handling techniques, which not only allow to detect errors, but also help to remove defective hardware from a CAN bus in order to keep the remaining parts working. This is called CAN error confinement. This is accomplished via two error counters (RX + TX, called RX Error Counter (REC) and TX Error Counter (TEC)) and a ruleset related to these, defining when these counters need to be in- or decremented. This won't be discussed in all details here, as there's lots of literature written and web ressources published on this topic. Depending on these error counters every CAN node is in one of four states: BUS OK (REC < 96 and TEC < 96) Normal state of a CAN node, when everything is ok. This does NOT necessarily mean the absence of errors on CAN bus though. The node is also said to be "error active", as it will actively propagate (or globalize) any detected error. BUS WARN (96 >= REC < 128 or 96 >= TEC < 128) At least on error counter has reached error warning limit, there's a significant amount of errors on CAN bus, yet overall function doesn't seem to be affected. The node remains "error active" in this state. ERROR PASSIVE (128 >= REC <= 255 or 128 >= TEC <= 255) Contary to the first two states a CAN node goes "error passive" (opposed to "error active") by exceeding the next threshold with any of its error counters. The node is still able to transmit and receive CAN frames, but it will not any longer propagate detected errors over the CAN bus. BUS OFF (TEC > 255) Lastly a node enters bus off state, where it will no longer take part in CAN communication. In general the error counters will be incremented, whenever a error is detected on CAN bus. Most CAN controllers provide special means to further investigate the circumstances of such error amongst other information the type of error and position of the error condition with a CAN frame are stored in a error code capture register (ECC). Means of error detection: ARINC 825 library provides several different means to detect CAN errors or be notified about them. (A) Polling: At any given time the CAN status can be polled using arincstatus() or arincioctl(arinc_ioctl_get_ctrl_status). The ARINC_STATUS structure returned from arincstatus() also contains ECC information of the last CAN bus error. (B) Asynchronous notification with error handler: By means of arincerrorhandler() an asynchronous error handler function can be registered. On occurrence of certain errors (such as CAN bus errors amongst others) the registered handler will be called and is also passed an ARINC_STATUS structure with ECC information. ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 13 of 106

14 CAN-errors (C) Asynchronous notification by virtual CAN events: There're two CAN events related to errors on CAN bus. These events are received as virtual CAN frames via arincread()/arinctake(), if the respective CAN IDs have been enabled with arincrxidadd(). The first one is the CAN error event, which is generated on every state change in a node's CAN state machine. The second one, called extended error event, is generated on every CAN error frame on CAN bus. There's no guarantee to receive one event per error frame, as the driver analyzes the ECC information and tries to prevent IRQ floods by disabling the interrupt for certain time periods if heavy load is detected. There are data structures defined to ease evaluation of these events (NTCAN_EVMSG_CAN_ERROR and NTCAN_EVMSG_CAN_ERROR_EXT), these can be simply mapped to the data section of the respective CAN event frames. Additionaly arincformatevent() can be used to convert the contained information into human readable strings. ECC Byte In order to further analyze a CAN bus error the ECC (error code capture) is of special importance. So far this feature is limited to two CAN controller types (SJA1000 and esdacc). Both controllers use the same bit encoding, so decoding of the ECC byte works exactly the same: Bit Symbol Name Value Function ECC Bit 7 (MSB) ERRC1 Error Code ECC Bit 6 ERRC0 Error Code ECC Bit 5 DIR Direction 1 RX; error occurred during reception 0 TX; error occurred during transmission ECC Bit 4 SEG4 Segment ECC Bit 3 SEG3 Segment ECC Bit 2 SEG2 Segment ECC Bit 1 SEG1 Segment ECC Bit 0 (LSB) SEG0 Segment Error type ERRC1 ERRC0 Function bit error 0 1 form error 1 0 stuff error 1 1 other type of error Page 14 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

15 CAN-errors Error position SEG4 SEG3 SEG2 SEG1 SEG0 Function start of frame ID.28 to ID ID.20 to ID bit SRTR bit IDE ID.17 to ID ID.12 to ID ID.4 to ID bit RTR reserved bit reserved bit data length code data field CRC sequence CRC delimiter acknowledge slot acknowledge delimiter end of frame intermission active error flag passive error flag tolerate dominant bits error delimiter overload flag Status-Busstates ARINC_EV_CAN_ERROR (CAN-IDs) ARINC_EV_CAN_ERROR_EXT (CAN-IDs) NTCAN_EVMSG_CAN_ERROR NTCAN_EVMSG_CAN_ERROR_EXT ARINC_STATUS IOCTLs arincstatus() arincioctl(arinc_ioctl_get_ctrl_status) arincformatevent() arincerrorhandler() ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 15 of 106

16 Defines 4. Defines [ Top ] [ Generics ] DESCRIPTION Documentation of symbol definitions: o CAN-IDs o CAN-Length o CAN-Baudrate o Handle-Modeflags o Handle-Queuesize o IOCTLs o IOCTL-TxSchedule o Status-Features o Status-IRIG-B o Status-Busstates o Bitrate-Controller o Bitrate-Flags o IRIG-B-Modeflags o Errorcodes o Errorformats o Thread-Priority Page 16 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

17 Defines 4.1 CAN-IDs [ Top ] [ Defines ] [ Definitions ] Following defines can be used in combination with CAN ID parameters, e.g. in ARINC_CMSG_T structure or with arincrxidadd(), arincrxiddelete() DESCRIPTION ARINC_20B_BASE ARINC_EV_BASE -- Marks 29-Bit CAN IDs (CAN-20b) -- Marks CAN events ("virtual special purpose CAN frames", see event IDs below) ARINC_EV_CAN_ERROR ARINC_EV_BAUD_CHANGE -- CAN bus state has changed. Event contains: Byte 1: Bus state Byte 3: Lost messages Event can be received, only. -- Baudrate of CAN node was reconfigured: Bytes 0-3: New baudrate as configured by user If length of event is eight: Bytes 4-7: New baudrate in numerical form Event can be received, only. ARINC_EV_CAN_ERROR_EXT -- An error occurred on CAN bus: Byte 0: Status information from CAN controller Byte 1: Detailed error information (Error Code Capture register) Byte 2: CAN RX error counter Byte 3: CAN TX error counter Event can be received, only. ARINC_EV_BUSLOAD NOTES -- Cyclic event with statistical data, a 64-Bit counter of bits transferred on CAN bus Event can be received, only. CAN event IDs (ARINC_EV_xxx): The events will be mainly used by the basic CAN functions. Higher level ARINC functions provide this information in different ways (see arincstatus() and arincerrorhandler()). CAN-errors ARINC_CMSG_T NTCAN_CMSG_T arincrxidadd() arincrxiddelete() ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 17 of 106

18 Defines 4.2 CAN-Length [ Top ] [ Defines ] [ Definitions ] Flags used in length field of CAN message structures (NTCAN_CMSG_T, ARINC_CMSG_T) in order to mark certain types of CAN frames. DESCRIPTION ARINC_RTR ARINC_NO_DATA -- Marks RTR frames -- The requested object does not contain data, yet. This flag has meaning only, if the handle was opened in object mode or is used on ARINC_CMSG_T objects returned from arincpoll(). ARINC_INTERACTION -- Marks interaction frames (Frames that are transmitted by another handle on the same physical CAN node). This has no meaning if the handle was opened in object mode. ARINC_OLD_DATA NOTES -- Marks old data When using arincpoll() this flag can be used to quickly identify data objects, which haven't changed since last call of arincpoll(). ARINC_INTERACTION is of use for basic CAN-Functions, only. ARINC_CMSG_T NTCAN_CMSG_T Page 18 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

19 Defines 4.3 CAN-Baudrate [ Top ] [ Defines ] [ Definitions ] Flags to be used with arincbaudrateset() and arincbaudrateget() DESCRIPTION ARINC_NO_BAUDRATE ARINC_AUTOBAUD -- The CAN node is taken off bus. It won't be able receive or send frames anymore, nor will it perform any kind of error detection. -- Activates automatic baudrate detection Following defines set CiA recommended baudrates: ARINC_BAUD_ MBit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s Flags to be used in combination with the above defines: ARINC_LISTEN_ONLY_MODE -- CAN node is set in listening only mode. Within this mode, the CAN node can receive CAN frames and even detect errors, but it won't interfere with the CAN bus. No transmission is possible, nor will the node communicate any detected errors on CAN bus. This can also be combined with ARINC_AUTOBAUD (useful e.g. to have an analyzer application adapt to any given CAN bus. If a baudrate was detected, the baudrate will be locked. If the baudrate changes on CAN bus, autobaud needs to be reenabled, in order to adapt to the new baudrate. Additional flags, which allow to configure baudrates in different ways: ARINC_USER_BAUDRATE -- By means of this mask, user can program the BTRs of the CAN controller directly. ARINC_USER_BAUDRATE_NUM -- User can specify a numerical value in Bits/s as baudrate parameter. E.g.: ARINC_USER_BAUDRATE_NUM will lead to a baudrate of 500 kbit/s. NOTES The described defines cover CiA defined baudrates, only. In addition to these a number of other predefined baudrates exist. Following table shows all predefined baudrates, use index as parameter for arincbaudrateset(): ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 19 of 106

20 Defines Baudrate Index MBit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s 0x kbit/s ARINC_BAUD_ kbit/s 0x kbit/s ARINC_BAUD_ kbit/s 0x kbit/s ARINC_BAUD_ kbit/s ARINC_BAUD_ kbit/s 0x kbit/s 0x08 50 kbit/s ARINC_BAUD_ kbit/s 0x0A 20 kbit/s ARINC_BAUD_ kbit/s 0x0C 10 kbit/s ARINC_BAUD_10 Furthermore it is possible to set the BTR registers of the CAN controller directly using ARINC_USER_BAUDRATE define. The BTR of the CAN controller used on AMC825 is structured as follows: 32-Bit word with bits MSB (31) downto LSB(0) Bits 7-0: Bitrate Prescaler (BRP) Bits 15-12: TSEG1 Bits 22-20: TSEG2 Bits 26-25: Synchronization Jump Width (SJW) So looking at a 32-Bit word like this 0x0UV0W0XY: SJW = second and third bit of U TSEG2 = lower three bits of V TSEG1 = W BRP = XY arincbaudrateset() arincbaudrateget() Page 20 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

21 Defines 4.4 Handle-Modeflags [ Top ] [ Defines ] [ Definitions ] Mode flags for the mode parameter of arincopen() DESCRIPTION ARINC_MODE_NO_RTR ARINC_MODE_NO_DATA ARINC_MODE_NO_INTERACTION ARINC_MODE_MARK_INTERACTION ARINC_MODE_OBJECT ARINC_MODE_TIMEFORMAT_AIM ARINC_MODE_TIMEFORMAT_FORCE -- The handle will receive no RTR frames -- The handle will receive RTR frames, only -- No interaction frames will be received on this handle -- Interaction frames will be marked in length field -- The handle will be opened in object mode, instead of FIFO mode -- Set the timeformat for ARINC-Functions on this handle to AIM format, otherwise time is represented in seconds (upper 32 bit) and splitseconds (lower 32 bit) since 0:00, January 1st 1970 (UTC). -- Use with care! By means of this flag, you can force the timeformat chosen by the current call of arincopen(), regardless of the timeformat formerly chosen by any other application. If such an application is still running, the effects on its ability to display and calculate times correctly are undefined. In any case, this flag will cause loss of synchronisation and following resynchronisation of the IRIG-B module (supposing the forced time format differs from the one formerly in use). NOTES By default no flag is set. ARINC-Time arincopen() ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 21 of 106

22 Defines 4.5 Handle-Queuesize [ Top ] [ Defines ] [ Definitions ] Special values to be used with the queuesize parameters of arincopen() DESCRIPTION ARINC_MAX_TX_QUEUESIZE -- Maximum TX queuesize per handle ARINC_MAX_RX_QUEUESIZE -- Maximum RX queuesize per handle arincopen() Page 22 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

23 Defines 4.6 IOCTLs [ Top ] [ Defines ] [ Definitions ] IOCTL commands DESCRIPTION ARINC_IOCTL_FLUSH_RX_FIFO ARINC_IOCTL_GET_RX_MSG_COUNT ARINC_IOCTL_GET_RX_TIMEOUT ARINC_IOCTL_GET_TX_TIMEOUT ARINC_IOCTL_SET_20B_HND_FILTER ARINC_IOCTL_GET_SERIAL ARINC_IOCTL_GET_TIMESTAMP_FREQ ARINC_IOCTL_GET_TIMESTAMP ARINC_IOCTL_ABORT_RX ARINC_IOCTL_ABORT_TX ARINC_IOCTL_SET_RX_TIMEOUT ARINC_IOCTL_SET_TX_TIMEOUT ARINC_IOCTL_TX_OBJ_CREATE - Flush RX FIFO (no arg) - Return number of messages in RX FIFO (arg->int32) - Return configured RX timeout (arg->int32) - Return configured TX timeout (arg->int32) - Configure 20b ID filter (arg=int32) - Get hardware serial number (arg->int32) - Return frequency of timestamp counter (arg->uint64) - Return current timestamp (arg->uint64) - Abort a pending arincread() (no arg) - Abort a pending arincwrite() (no arg) - Change RX timeout (arg=int32) - Change TX timeout (arg=int32) - Create a TX object (arg->ntcan_cmsg_t) These objects can be used for TX scheduling or Auto Answer (also in parallel). Per physical CAN node (NOT per handle) there may be exactly one object created per CAN ID. Maximum number of objects depends on system ressources. ARINC_IOCTL_TX_OBJ_AUTOANSWER_ON - Activates Auto Answer for a given TX object (arg->ntcan_cmsg_t). The object will be immediately send after a RTR frame with same CAN ID has been received. ARINC_IOCTL_TX_OBJ_AUTOANSWER_OFF - Deactivates Auto Answer (arg->ntcan_cmsg_t) ARINC_IOCTL_TX_OBJ_UPDATE - Changes the data contained in a formerly created TX object (arg->ntcan_cmsg_t) ARINC_IOCTL_TX_OBJ_DESTROY - Destroys a formerly created TX object (arg->ntcan_cmsg_t) ARINC_IOCTL_TX_OBJ_SCHEDULE_START - Start the actual TX scheduling (no arg) ARINC_IOCTL_TX_OBJ_SCHEDULE_STOP - Stop TX scheduling (no arg) ARINC_IOCTL_TX_OBJ_SCHEDULE - Schedule a TX object for transmission (arg->ntcan_csched) ARINC_IOCTL_SET_BUSLOAD_INTERVAL - Configures the time between two ARINC_EV_BUSLOAD events (arg=int32) ARINC_IOCTL_GET_BUSLOAD_INTERVAL - Return the time between two ARINC_EV_BUSLOAD events (arg->int32) ARINC_IOCTL_GET_BUS_STATISTIC ARINC_IOCTL_GET_CTRL_STATUS ARINC_IOCTL_GET_BITRATE_DETAILS ARINC_IOCTL_EEI_CREATE ARINC_IOCTL_EEI_DESTROY ARINC_IOCTL_EEI_STATUS ARINC_IOCTL_EEI_CONFIGURE ARINC_IOCTL_EEI_START - Returns statistical data from CAN bus (arg->ntcan_busstatistic) - Returns information about the error status of the CAN controller (arg->ntcan_ctrlstate) - Returns information about the currently configured baudrate (arg->ntcan_bitrate_info) - Allocate error injection (EEI) unit (arg-> ) - Release EEI unit - Get status of EEI unit - Configure EEI unit - Activate EEI unit ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 23 of 106

24 Defines ARINC_IOCTL_EEI_STOP ARINC_IOCTL_EEI_TRIGGER_NOW - Deactivate EEI unit - Manually trigger an activated EEI unit arincioctl() Page 24 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

25 Defines 4.7 IOCTL-TxSchedule [ Top ] [ Defines ] [ Definitions ] Defines to be used flags field of NTCAN_CSCHED structure in combination with arincioctl(arinc_ioctl_tx_obj_schedule). DESCRIPTION ARINC_TXSCHED_FLAG_EN - ID is enabled ARINC_TXSCHED_FLAG_DIS - ID is disabled ARINC_TXSCHED_FLAG_REL - Start time is relative ARINC_TXSCHED_FLAG_ABS - Start time is absolute ARINC_TXSCHED_FLAG_INC8-8 Bit incrementer ARINC_TXSCHED_FLAG_INC16-16 Bit incrementer ARINC_TXSCHED_FLAG_INC32-32 Bit incrementer ARINC_TXSCHED_FLAG_DEC8-8 Bit decrementer ARINC_TXSCHED_FLAG_DEC16-16 Bit decrementer ARINC_TXSCHED_FLAG_DEC32-32 Bit decrementer ARINC_TXSCHED_FLAG_OFS0 - Counter at offset 0 ARINC_TXSCHED_FLAG_OFS1 - Counter at offset 1 ARINC_TXSCHED_FLAG_OFS2 - Counter at offset 2 ARINC_TXSCHED_FLAG_OFS3 - Counter at offset 3 ARINC_TXSCHED_FLAG_OFS4 - Counter at offset 4 ARINC_TXSCHED_FLAG_OFS5 - Counter at offset 5 ARINC_TXSCHED_FLAG_OFS6 - Counter at offset 6 ARINC_TXSCHED_FLAG_OFS7 - Counter at offset 7 arincioctl(arinc_ioctl_tx_obj_schedule) ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 25 of 106

26 Defines 4.8 Status-Features [ Top ] [ Defines ] [ Definitions ] Use these defines to evaluate features field in ARINC_STATUS DESCRIPTION ARINC_FEATURE_FULL_CAN - CAN controller is a so called "Full CAN controller" Compared to "basic CAN controllers" this name does _not_ implicate an improvement, but rather a different purpose. Full CAN controllers are used for embedded applications, whereas basic CAN controllers are better suited for multi-purpose applications ARINC_FEATURE_CAN_20B - 29-Bit CAN IDs can be received and transmitted ARINC_FEATURE_CYCLIC_TX - Customer specific feature flag ARINC_FEATURE_DEVICE_NET - Hardware supports DeviceNet ARINC_FEATURE_RX_OBJECT_MODE - Driver supports RX object mode (sometimes also called flat mode) ARINC_FEATURE_TIMESTAMP - Hardware supports timestamping ARINC_FEATURE_LISTEN_ONLY_MODE - Hardware supports "Listen only mode" ARINC_FEATURE_SMART_DISCONNECT - Driver supports "Leave bus after last close" ARINC_FEATURE_LOCAL_ECHO - Hardware/Driver supports self reception ARINC_FEATURE_ID_RANGES - Featureflag is deprecated, Don't use ARINC_FEATURE_SMART_ID_FILTER - Driver supports granular filtering of 29-Bit CAN IDs ARINC_FEATURE_SCHEDULING ARINC_FEATURE_DIAGNOSTIC - Driver supports TX scheduling mode - Driver/Hardware supports extended bus diagnostic features ARINC_FEATURE_ERROR_INJECTION - Hardware supports error injection ARINC_FEATURE_ID_RANGES - Featureflag is deprecated, Don't use arincstatus() Page 26 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

27 Defines 4.9 Status-IRIG-B [ Top ] [ Defines ] [ Definitions ] Use these defines to evaluate irigbstatus field in ARINC_STATUS or with status parameter of arinctimeget() DESCRIPTION ARINC_IRIGB_STATUS_PHASE_LOCK ARINC_IRIGB_STATUS_BIT_LOCK ARINC_IRIGB_STATUS_POSITION_LOCK ARINC_IRIGB_STATUS_TIME_VALID ARINC_IRIGB_STATUS_NO_DATA ARINC_IRIGB_STATUS_NO_INPUT ARINC_IRIGB_STATUS_FREE_WHEELING - Locked phase of IRIG-B signal Bit is set, when phase error of 1kHz signal is below 100us Bit is reset, when phase error of 1kHz signal is above 1ms - Locked bit state of IRIG-B signal Bit is set, when valid modulation is detected Bit is reset, when no valid modulation is detected - Locked position of IRIG-B signal Bit is set, when two consecutive P-Bits (Position identifier in IRIG-B stream) were detected Bit is reset, when there was an error in P-Bits or Index-Bits detected Note: When this bit is set for the first time, the "time counter" will be set within the following second - The delivered time is valid. Bit is set, when the difference between IRIG-B signal and "time counter" is ten times below 1ms, while ARINC_IRIGB_STATUS_POSITION_LOCK is set Bit is reset, if ARINC_IRIGB_STATUS_TIME_ERROR is set for longer than 60s Note: This bit will stay asserted for a "while", even if IRIG-B signal is lost. In this case ARINC_IRIGB_STATUS_NO_DATA and ARINC_IRIGB_STATUS_NO_INPUT bits will show the loss of IRIG-B signal and ARINC_IRIGB_STATUS_FREE_WHEELING marks the "valid time" as internally generated on basis of the last known IRIG-B signal. Note 2: If IRIG-B signal get's disconnected, ARINC_IRIGB_STATUS_TIME_ERROR won't change and thus ARINC_IRIGB_STATUS_TIME_VALID stays set. - If set, there's no signal or valid modulation detected - If set, there's no valid input signal detected (amplitude of IRIG-B signal is too low) - If set, the IRIG-B controller is not active, there's no IRIG-B signal detected ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 27 of 106

28 Defines ARINC_IRIGB_STATUS_TIME_ERROR If not set, the IRIG-B controller is active, there's a valif IRIG-B signal - If set, current time deviates from "time counter" (expected time) by more than 256ms. Note: This bit will change only, if there's a valid IRIG-B signal. Loss of IRIG-B signal won't change this bit. NOTES In order to judge the quality of current time you need to take at least ARINC_IRIGB_STATUS_TIME_VALID and ARINC_IRIGB_STATUS_FREE_WHEELING into account (in certain cases ARINC_IRIGB_STATUS_TIME_ERROR as well): A) ARINC_IRIGB_STATUS_TIME_VALID == 1 ARINC_IRIGB_STATUS_FREE_WHEELING == 0 ARINC_IRIGB_STATUS_TIME_ERROR == 0 or 1 The current time is based on connected IRIG-B signal. As described for ARINC_IRIGB_STATUS_TIME_ERROR, the current time correlates good (ARINC_IRIGB_STATUS_TIME_ERROR == 0) or rather badly (ARINC_IRIGB_STATUS_TIME_ERROR == 1) with IRIG-B signal. B) ARINC_IRIGB_STATUS_TIME_VALID == 1 ARINC_IRIGB_STATUS_FREE_WHEELING == 1 The current time is based on a previously connected IRIG-B signal. C) ARINC_IRIGB_STATUS_TIME_VALID == 0 The current time is free wheeling, based on a manually set time. The time does _not_ correlate to an IRIG-B signal. There has never been a valid IRIG-B signal connected to the system. arincstatus() arinctimeget() Page 28 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

29 Defines 4.10 Status-Busstates [ Top ] [ Defines ] [ Definitions ] CAN bus status as delivered by ARINC_EV_CAN_ERROR, arincerrorhandler(), arincioctl(arinc_ioctl_get_ctrl_status) or arincstatus() DESCRIPTION ARINC_BUSSTATE_OK ARINC_BUSSTATE_WARN - CAN bus is ok - One of the CAN error counters (RX or TX) has reached its warning limit ARINC_BUSSTATE_ERRPASSIVE - One of the CAN error counters (RX or TX) has went over 127. The CAN node is "error passive". It is still possible to send and receive CAN frames, but the CAN node won't generate error frames anymore. ARINC_BUSSTATE_BUSOFF CAN-errors ARINC_EV_CAN_ERROR arincerrorhandler() arincioctl(arinc_ioctl_get_ctrl_status) arincstatus() - TX error counter has passed 255. The CAN node can't receive or transmit anymore, it won't interfere with the CAN bus. ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 29 of 106

30 Defines 4.11 Bitrate-Controller [ Top ] [ Defines ] [ Definitions ] Type of CAN controller as returned from arincioctl(arinc_ioctl_get_ctrl_status) or arincioctl(arinc_ioctl_get_bitrate_details) DESCRIPTION ARINC_CANCTL_SJA NXP SJA1000 / 82C200 ARINC_CANCTL_I Intel I82527 ARINC_CANCTL_FUJI - Fujitsu MBxxxxx MCU ARINC_CANCTL_LPC - NXP LPC2xxx MCU ARINC_CANCTL_MSCAN - Freescale MCU ARINC_CANCTL_ATSAM - Atmel ARM CPU ARINC_CANCTL_ESDACC - esd ESDACC ARINC_CANCTL_CC770 - Bosch CC770 IOCTLs NTCAN_CTRLSTATE NTCAN_BITRATE_INFO arincioctl(arinc_ioctl_get_ctrl_status) arincioctl(arinc_ioctl_get_bitrate_details) Page 30 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

31 Defines 4.12 Bitrate-Flags [ Top ] [ Defines ] [ Definitions ] Special (probably controller specific) attributes of a CAN baudrate, as delivered by arincioctl(arinc_ioctl_get_bitrate_details) DESCRIPTION ARINC_BITRATE_FLAG_SAM - Triple sampling activated IOCTLs NTCAN_BITRATE_INFO arincioctl(arinc_ioctl_get_bitrate_details) ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 31 of 106

32 Defines 4.13 IRIG-B-Modeflags [ Top ] [ Defines ] [ Definitions ] Mode flags for the mode parameter of arincirigbconfigset() and arincirigbconfigget() DESCRIPTION ARINC_IRIGB_SOURCE_ANALOG_1 ARINC_IRIGB_SOURCE_DIGITAL_1 ARINC_IRIGB_TIMEFORMAT_YEAR -- Select IRIG-B Analog input as source for IRIG-B time. This is the default input, if no or multiple inputs are selected -- Select IRIG-B Digital input as source for IRIG-B time -- If this flag is set, the year information (which is an optional IRIG-B extension) will be used. If both ARINC_IRIGB_TIMEFORMAT_YEAR and ARINC_IRIGB_TIMEFORMAT_YEAR_MAN are set, this flag has priority. ARINC_IRIGB_TIMEFORMAT_YEAR_MAN -- If this flag is set, the year may/has to be set manually by using arinctimeset(). This flag is ignored, if both ARINC_IRIGB_TIMEFORMAT_YEAR or ARINC_IRIGB_TIMEFORMAT_YEAR_MAN are set. NOTES ARINC_IRIGB_TIMEFORMAT_YEAR and ARINC_IRIGB_TIMEFORMAT_YEAR_MAN might influence other handles and/or applications as well, if not used with care, since they change the configuration of the IRIG-B hardware. On the other hand, there's no need to call arincirigbconfigset() for every handle, once per device is sufficient (if it's needed at all and the default values do not fit your needs). It is recommended to use arincirigbconfigget() prior to calling arincirigbconfigset(). This way it is possible to write applications, which won't interfere with each other. ARINC-Time arincirigbconfigset() arincirigbconfigget() Page 32 of 106 Software Manual Doc. No.: C / Rev. 1.1 ARINC 825 Library

33 Defines 4.14 Errorcodes [ Top ] [ Defines ] [ Definitions ] Error codes generated by ARINC library functions ERRORS ARINC_ERRNO_BASE ARINC_SUCCESS ARINC_RX_TIMEOUT ARINC_TX_TIMEOUT ARINC_TX_ERROR ARINC_CONTR_OFF_BUS ARINC_CONTR_BUSY ARINC_CONTR_WARN ARINC_NO_ID_ENABLED ARINC_ID_ALREADY_ENABLED ARINC_ID_NOT_ENABLED ARINC_INVALID_FIRMWARE ARINC_MESSAGE_LOST ARINC_INVALID_HARDWARE ARINC_PENDING_WRITE ARINC_PENDING_READ ARINC_INVALID_DRIVER ARINC_INVALID_PARAMETER ARINC_INVALID_HANDLE ARINC_NET_NOT_FOUND ARINC_INSUFFICIENT_RESOURCES ARINC_OPERATION_ABORTED ARINC_WRONG_DEVICE_STATE ARINC_HANDLE_FORCED_CLOSE ARINC_NOT_IMPLEMENTED ARINC_NOT_SUPPORTED ARINC_CONTR_ERR_PASSIVE ARINC_ERROR_NO_BAUDRATE ARINC_ERROR_LOM ARINC_SOCK_CONN_TIMEOUT ARINC_SOCK_CMD_TIMEOUT ARINC_SOCK_HOST_NOT_FOUND -- Whenever possible, ARINC library uses system error codes (e.g. under Linux the errno values will be used). For errors which can't be mapped to these system codes, ARINC_ERRNO_BASE is used as offset to avoid ambiguities. -- No error -- A blocking receive function reached its timeout without any reception -- A blocking transmit function reached its timeout without any transmission -- An error occurred, while trying to send -- The CAN controller went in CAN state: Bus Off -- The CAN controller is busy and can't process the given command -- The CAN controller went in CAN state: Bus Warn -- Deprecated error code -- Deprecated error code -- Deprecated error code -- Wrong firmware version -- Messages have been lost by CAN driver -- Wrong hardware version -- Another arincwrite() is pending on the same handle -- Another arincread() is pending on the same handle -- Driver doesn't fit library version -- One of the parameters was invalid -- No valid ARINC_HANDLE -- Attempt to open a handle on a nonexistent CAN bus -- Not enough system ressources for requested operation -- A blocking operation was aborted -- CAN hardware is in wrong power state -- Error currently not supported -- The requested function is not implemented, yet -- The requested function is not supported by the CAN hardware -- The CAN controller went in CAN state: Error Passive -- Attempt to transmit on a CAN node, which has no configured baudrate, yet -- Attempt to transmit on a CAN node in listen only mode -- Special EtherCAN error code -- Special EtherCAN error code -- Special EtherCAN error code ARINC 825 Library Software Manual Doc. No.: C / Rev. 1.1 Page 33 of 106