====================================================
Example Software for the XS_CAN IP Module V1.1.0
====================================================

Purpose of the Software
  Show how to operate the XS CAN.

Hints
  This software is just an example and gives no guarantee for completeness or correctness.

----------------------------------------------------
Description of the files’ contents
----------------------------------------------------
_info_.txt                            this file
application.c                         contains main(); contains basic system setup
global_macros.h                       collection of defines that are used all accross this software
global_settings.h                     setups to select Target System (Altera or Xilinx), Endianess of CPU and type of application to be excuted
types.h                               type definitions
xs_can_integration_test_output.txt    example report of the integration test xs_can_integration_test()

----------------------------------------------------
XS_CAN software
----------------------------------------------------
xs_can/app_notes/                     Application Notes
xs_can/integration_test               Integration Test with software
xs_can/irc/                           Interrupt Controller Drivers
xs_can/mh/                            MH Drivers (Message Handler)
xs_can/prt/                           PRT Drivers (Protocol Controller)
xs_can/common_function.c+h            Functions commonly used by PRT and MH
xs_can/test_help_function.c+h         Functions that are used accross several testcases/demos/app_notes
xs_can/xs_can.c+h                     XS_CAN related defines, initialization functions, help functions

----------------------------------------------------
XS_CAN IRC driver
----------------------------------------------------
xs_can/irc/xs_can_irc.c+h                     IRC drivers and definitions
xs_can/irc/xcans_top_irc_IRC_MAP_memoryMap.h  IRC register definitions

----------------------------------------------------
XS_CAN MH driver
----------------------------------------------------
xs_can/mh/xs_can_mh.c+h                       MH drivers and definitions
xs_can/mh/xs_can_mh_lmem.h                    MH local memory data structure definitions
xs_can/mh/xcans_mh_creg_MH_MAP_memoryMap.h    MH register definitions

----------------------------------------------------
XS_CAN PRT driver
----------------------------------------------------
xs_can/prt/xs_can_prt.c+h                     PRT drivers and definitions
xs_can/prt/xcan_prt_reg_PRT_MAP_memoryMap.h   PRT register definitions

----------------------------------------------------
XS_CAN Integration Test with software
----------------------------------------------------
xs_can/integration_test/integration_test.c+h     Integration Test cases with software

----------------------------------------------------
XS_CAN Application Notes
----------------------------------------------------
xs_can/app_notes/app_note_fdlc.c+h               Application Note: shows how to use XS_CAN as CAN FD light Commander
xs_can/app_notes/app_note_fim.c+h                Application Note: shows how to use the Fault Injection Module of the XS_CAN
xs_can/app_notes/app_note_loopback_mode.c+h      Application Note: shows how to use XS_CAN with loop-back test mode
xs_can/app_notes/app_note_manual_irq_test.c+h    Application Note: shows how to manually trigger the interrupt for testing in XS_CAN
xs_can/app_notes/app_note_menu.c+h               File to call the Application Notes 
xs_can/app_notes/app_note_rx_filtering.c+h       Application Note: shows how to use rx filtering in XS_CAN 
xs_can/app_notes/app_note_tefq.c+h               Application Note: shows how to use tx event fifo queue in XS_CAN
xs_can/app_notes/app_note_txpq.c+h               Application Note: shows how to send messages with tx priority queue in XS_CAN
xs_can/app_notes/app_note_tx_rx.c+h              Application Note: shows how to send/receive with fifo queue in XS_CAN

----------------------------------------------------
Transceiver Sharing (= on-chip CAN Bus emulation)
----------------------------------------------------
tss/tss.c+h                      functions to control transceiver sharing connection, and an onchip CAN bus emulation 

----------------------------------------------------
drivers for board peripherals
----------------------------------------------------
altera/peripherals.c+h           drivers for bard peripherals - Altera
xilinx/io.c+h                    drivers for bard peripherals - Xilinx 


 




